Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 2.19 KB

CONFIG_DOCUMENTATION.md

File metadata and controls

71 lines (43 loc) · 2.19 KB

config.json documentation

Essential settings

botToken: Your bot token that you can get from @BotFather

botStaff: Array of userId(String) considered bot staff

Privacy settings

deleteChatDataAfterBotRemove: If enabled all chat data (configurations included) will be deleted from bot database when you kick the bot from a group

overwriteChatDataIfReAddedToGroup: If enabled chat data and configurations will be regenerated if bot has been re-added to the group (similiar to deleteChatDataAfterBotRemove,)

allowExternalApi: Allow to gather additional data by varous online api's, that's may reveal the ip of your server, default to false

Other settings

reserveLang: Principal language for the bot, this will be used to overwrite other languages with incompleted translations, we advise to keep it unchanged or use a full implemented language

saveDatabaseSeconds: Number of seconds of how often loaded chats should be written on disk, useful to prevent data loss on crash

saveTagResolverSeconds: Number of seconds of how often tagResolver data should be saved on disk

maxCallbackAge: Maximum number of seconds a callback button should be old to be accepted by the bot, you can reduce this in case of incompatible callbacks after an update that cause crash

preventSetUselessRoles: Disallow from setting roles if it does not change the user status in the group

chatWhitelist: Array, if there are at least one element the bot will work only on this chat ids

privateWhitelist: Boolean, true if chat whitelist includes private chats, useless if chatWhitelist has no elements

chatBlacklist: Bot wont more handle requests of chat ids in this array

Plugin settings

ANTIFLOOD_msgMin: minimum allowed number of messages to triggher the antiflood

ANTIFLOOD_msgMax: maximum allowed number of messages to triggher the antiflood

ANTIFLOOD_timeMin: minimum allowed time in which N messages should be sent to triggher the antiflood

ANTIFLOOD_timeMax: maximum allowed time in which N messages should be sent to triggher the antiflood

minWarns: minimum allowed warns in settings

maxWarns: maximum allowed warns in settings