К содержимому

Настройка

Давайте более подробно поговорим про настройки бота. Все настройки делятся на 2 группы:

  • Внутренние.
  • Настройки плагинов.

Располагаются в файле .env. Загружаются один раз во время запуска бота.

Пример настроек:

BOT_TOKEN = "BOT TOKEN HERE"
BOT_OWNER = 1234
DB_DSN = "postgres://user:password@/run/postgresql/chio"
DEBUG = false
# Настройка серверов
ADMIN_GUILD = 1234
MAIN_GUILD = 1234
# Определение путей
EXTENSIONS_PATH = "extensions/"
DATA_PATH = "bot_data/"
CONFIG_PATH = "config/"

В репозитории приводится краткая сводка за что отвечает каждый параметр чтобы вы не запутались,

  • bot_token: Токен от дискорд бота. Именно по нему дискорд понимает, какой бот с ним общается. Получить его можно на Discord dev portal.

  • bot_owner: ID владельца бота. На него не будут распространяться различные ограничения. Он может выполнять все команды и переназначать права других пользователей.

  • db_dsn: Адрес подключение к базе данных Postgres. Содержит имя пользователя, пароль, название базы данных. Можно использовать как локальную так и удалённую базу. В случае локальной базы можно использовать UNIX сокеты.

  • debug: Режим отладки. Влияет на количество логов. Параметр зарезервирован на будущее.111111111111

  • admin_guild: ID сервера администраторов. Здесь по умолчанию будут работать плагины для администрирования бота. Может совпадает с main_guild.

  • main_guild: ID Основного сервера. Сервер, который привязан к боту и считается его домом.

    Пока никак не используется, зарезервировано на будущее.

Пути определяют откуда следует загружать те или иные данные. В некоторых случаях может быть полезно переопределить стандартные пути. К примеру во время отладки.

  • extensions_path: Путь для расширения. Во время загрузки расширений отсюда будут выбираться все файлы расширений. К примеру вы можете использовать разные наборы расширения для тестирования и использования бота.

  • data_path: Путь к данным бота. В этой директории плагины могут спокойно читать и записывать свои данные. К примеру чтобы брать изображения или наоборот, сохранять временные файлы.

    Обратите внимание что устаревшие плагины могут использовать жёстко привязанный путь к данным бота. Если нашлись такие, то напишите о них в issue.

  • config_path: Путь к настройкам. После загрузки расширения происходит загрузка настроек плагинов. Все настройки будут читать из указанной директории.

В отличие от настроек бота, настройки плагинов определяют сами плагины. По умолчанию читаются из директории config/. Можно переопределить путь настроек параметром config_path. Файлы представлены в TOML формате. Загрузка происходит после загрузки всех плагинов.

Более подробно об использовании настроек можно почитать здесь.