Сайт сообщества: https://igc.su.
Приватный бот, который можно развернуть на любом сообществе.
# Create work dirs
mkdir /var/bot/
mkdir /var/logs/bot/IGCb/
# Clone rep
cd /var/bot
git clone [email protected]:IGCsu/IGCb.git
# ... configure DB ...
# Set environment
cp IGCb/.env.example IGCb/.env
# Run start bot
cd /var/bot/IGCb
bash bot.sh # Absolute path not working/index.js- индексный файл: подключаетсяdiscord.jsи устанавливается соединение, после которого запускается/init.js./init.js- основной файл инициализации: запускает файлы инициализации./init/- директория с файлами инициализации бота./commands/- директория с модулями бота./functions/- директория с функциями бота./locales/- директория с локализацией бота./helpTexts/- директория с локализацией бота./.env- конфигурация бота.
/init/constants.js- определение базовых констант./init/commands.js- инициализация всех модулей из/commands/./init/locales.js- подгрузка всех файлов локализации из/locales/./init/functions.js- определение всех функций из/functions/./init/guild.js- определение основной гильдии./init/globalErrorHandler.js- инициализация отлова ошибок./init/interactionCreate.js- инициализация прослушки взаимодействий./init/sessionId.js- определение ID сессии бота./init/setActivity.js- установка статуса бота./init/startMessage.js- отправка стартового сообщения./init/protection.js- требует подтверждение при попытке запуска на защищённом клиенте.
/commands/ в качестве отдельных папок.
Папка модуля обязательно должна содержать индексный файл ./index.js, который будет вызываться из /commands.js.
Модуль должен экспортировать объект модуля:
module.exports = {
/**
* Содержит значение активности модуля. Используется для проверки другими модулями.
* Вне зависимости от значения, будет подключен и инициализирован.
*/
active: (Boolean), // required
/**
* Категория модуля. Допускается любое значение.
*/
category: (String), // not required (default: "Остальные")
/**
* Название модуля. Должно быть идентично названию файла.
*/
name: (String), // required, lower case only (!)
/**
* Короткое обозначение модуля. Содержит объект локализации.
* Обязательная локализация - русская.
* Для обозначений языков используется формат ISO 639-1
*/
title: (Object) { // required
[Language code ISO 639-1]: (String)
},
/**
* Подсказка для слеш-команды. Содержит объект локализации.
* Обязательная локализация - русская.
* Для обозначений языков используется формат ISO 639-1.
*/
description: (Object) { // not required (default: this.title)
[Language code ISO 639-1]: (String)
},
/**
* Опции для слеш-команды. Нужно использовать только если слеш-команде нужны какие то опции.
*/
slashOptions: (Object) { // not required
/**
* Структура опций основана на требуемой в документации API discord, однако содержит небольшие изменения:
* * Объект не должен содержать "name" - оно содержится в ключе объекта.
* * Объект не должен содержать "name_localizations" - локализация названий недопустима.
* * Изменён "description". Он содержит стандартный объект локализации.
* Заменяет стандартный "description" и "description_localizations".
* * Изменён "choices". Он содержит объект вариантов.
* В качестве ключа - значение варианта.
* В качестве значение объект локализации с названиями значения.
* * Изменён "options". Вместо него необходимо использовать "slashOptions".
* Работает точно так же, как и родительский "slashOptions".
* https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure
*/
[Options name]: (Object) {
/**
* Тип опции.
* https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type
*/
type: (Number), // required
required: (Boolean), // not required (default: false)
/**
* Подсказка для опции. Содержит объект локализации.
* Обязательная локализация - русская.
* Для обозначений языков используется формат ISO 639-1.
*/
description: (Object) { // required
[Language code ISO 639-1]: (String)
},
/**
* Опции для опции. Используется для более сложных опций.
*/
slashOptions: (Object) { // not required
[Options name] (Object) { ... }
},
/**
* Варианты выбора.
*/
choices: { // not required
[Value choices] : (Object) {
[Language code ISO 639-1]: (String)
}
}
}
},
/**
* Функция инициализации. Используется при инициализации модуля.
* Принимает путь к текущему файлу. Может быть использовано для логирования.
* Всегда должен возвращать объект модуля (this).
* @param {String} path Путь к файлу
* @return {Object} this
*/
init: async function(path){ // required
// Пример ошибки: в лог инициализации добавляется ошибка, а модуль перестаёт быть активным.
if(error){
log.initText += log.error(path + ': Произошла ошибка');
this.active = false;
return this;
}
return this;
},
/**
* Индексная функция модуля. Используется для базовой логики и вызовов из входных функций
*/
call: (Function), // required
/**
* Функция обработки slash-команды.
* Если функция существует - то при инициализации будет добавлена слеш-команда с данными модуля и slashOptions, если тот имеется.
* @param {CommandInteraction} int
*/
slash: async function(int){ // not required
await this.call(int);
},
/**
* Функция обработки контекстной команды на сообщении.
* Если функция существует - то при инициализации будет добавлена контекстная-команда на сообщение.
* @param {ContextMenuInteraction} int
*/
contextMessage: async function(int){ // not required
await this.call(int);
},
/**
* Функция обработки контекстной команды на пользователе.
* Если функция существует - то при инициализации будет добавлена контекстная-команда на пользователей.
* @param {UserContextMenuInteraction} int
*/
contextUser: async function(int){ // not required
await this.call(int);
},
/**
* Функция обработки сообщения пользователя.
* Если функция существует - то при инициализации модуль будет сохранён в модуле handler.
* @param {Message} msg
*/
message: async function(msg){ // not required
...
},
/**
* Функция обработки автозаполнения.
* https://discord.js.org/#/docs/discord.js/stable/class/AutocompleteInteraction
* @param {AutocompleteInteraction} int
*/
autocomplete: (Function), // not required
/**
* Функция обработки модального окна.
* https://discord.js.org/#/docs/discord.js/stable/class/ModalSubmitInteraction
* @param {ModalSubmitInteraction} int
*/
modal: (Function), // not required
/**
* Функция обработки кнопок.
* https://discord.js.org/#/docs/discord.js/stable/class/MessageComponentInteraction
* @param {MessageComponentInteraction} int
*/
button: (Function), // not required
/**
* Функция обработки селектора.
* https://discord.js.org/#/docs/discord.js/stable/class/SelectMenuInteraction
* @param {SelectMenuInteraction} int
*/
selectMenu: (Function) // not required
};При разработке рекомендуется максимально разбивать код по файлам. Например, во всех модулях вынесены параметры "slashOptions", "title" и "description" в отдельные файлы ./slashOptions.json и ./about.json.
Рекомендуется помещать в директорию модуля README файл, с подробностями работы модуля и используемыми ими глобальными функциями и переменными.
Модули добавляются в глобальную переменную commands, и её можно использовать для доступа к другим модулям.
У модулей не обязательно должны быть входные функции типа "slash" или "contextUser".
Бот имеет вспомогательные функции. Они расположены в/functions/ в виде отдельных файлов.
Файл функции должен добавлять в global функцию или объект функций и констант.
Функции отличаются от модулей своей примитивностью. Это простые функции с функциональным подходом: должны что то принимать, что то делать и что то возвращать.
Цель таких функций - выполнение базовых задач, которые не относятся к какому либо модулю. Рекомендуется создавать функции только если предполагается их применение в разных модулях. В функциях допустима инкапсуляция.
Файлы локализации расположены в двух директориях:/helpTexts/ и /locales/.
В /locales/ содержатся файлы в формате .json, стандартная локализация.
В /helpTexts/ содержатся файлы в формате .md. Эти файлы содержат подробную информацию о модуле. Используется в модуле help.
Если файл существует, при help-запросе с указанным модулем, то текст будет выведен в эмбед.
# Конфигурация для подключения к MySQL базе данных
DB_DATABASE=<database>
DB_PASSWORD=<password>
DB_HOST=<host>
DB_USER=<user>
# ID разработчика. Отображается в стартовом сообщении и пингуется в случае ошибки
DEVELOPER=<UserID>
# Токен бота
TOKEN=<TOKEN>