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

Структура

Очень важно для начала понимать, из чего состоит Шиори.

  • Директорияbot_data Данные бота в процессе работы
    • image.png
    • users.json
  • Директорияconfig Настройки плагинов
    • hello.toml
    • music.toml
  • chioricord Ядро бота и встроенный APi
  • Директорияextensions Ваши расширения
    • hello.py
    • Директорияmusic
      • player.py
      • events.py
  • Директорияlibs Библиотеки для расширений
    • active.py
    • coins.py
    • profile.py
    • timers.py

Здесь расширения могут хранить свои пользовательские данные. Каждые расширение может создавать и читать здесь файлы по своему усмотрению. К примеру хранить пользовательские данные в json файлах или прочее.

Вам не придётся контактировать с этой директорией, только если этого не потребует расширение.

Здесь расширения подгружают свои настройки. Для расширений данная директория доступна только для чтения. Настройки подгружаются после загрузки расширений. Если каких-то настроек будет не хватать или возникнет ошибка - бот не запустится.

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

Ядро Chiori, где расположены самые важные компоненты. Предоставляет общий API как для расширений, так и для библиотек. Ядро включает в себя:

  • Директорияapi
    • config.py API настройки Шиори и расширений
    • db.py API базы данных
  • bot.py Главный файл для запуска
  • client.py Класс бота Шиори
  • errors.py Общий обработчик ошибок
  • events.py Базовые события Шиори
  • plugin.py ChioPlugin и AdminPlugin
  • tags.py Таблица тегов пользователей

Вы можете самостоятельно изучить эти компоненты.

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

Расширения, которые начинаются с _ не будут загружены.

Здесь располагаются коллекция библиотек, а также пользовательские библиотеки.