2
0
mirror of https://github.com/thedevs-network/the-guard-bot synced 2025-08-22 09:57:50 +00:00
the-guard-bot/example.config.js

72 lines
1.6 KiB
JavaScript
Raw Normal View History

'use strict';
/*
* Create `config.js` by running `cp example.config.js config.js`
* in the project folder, then edit it.
*
* Config file in JSON format (`config.json`) is also supported.
* For backwards compatibility, and because why not, it needs no extra code.
*/
module.exports = {
/**
* @type {!( number | string )}
* ID (number) or username (string) of master,
* the person who can promote and demote admins,
* and add the bot to groups.
*/
master: 123456789,
/**
* @type {!string}
* Telegram Bot token obtained from https://t.me/BotFather.
*/
token: '',
/**
* @type {( 'all' | 'own' | 'none' )}
* Which messages with commands should be deleted?
* Defaults to 'own' -- don't delete commands meant for other bots.
*/
deleteCommands: 'own', // eslint-disable-line sort-keys
/**
* @type {( number | string | false )}
* Timeout before removing join and leave messages.
* String to be parsed by https://npmjs.com/millisecond,
* or number of milliseconds.
* Pass 0 to remove immediately.
* Pass false to never remove.
*/
deleteJoinsAfter: '2 minutes',
excludeLinks: [],
/**
* @type {InlineKeyboardMarkup}
* Inline keyboard to be added to reply to /groups.
* We use it to display button opening our webpage.
*/
groupsInlineKeyboard: [],
numberOfWarnsToBan: 3,
/**
* @type {string[]}
* List of plugin names to be loaded.
* See Readme in plugins directory for more details.
*/
plugins: [],
/**
* @type {InlineKeyboardMarkup}
* Inline keyboard to be added to warn message.
* We use it to display button showing our rules.
*/
warnInlineKeyboard: [],
};
Object.freeze(module.exports);