Chiori; Cord

Замечательный многофункциональный модульный бот для нашего лампового сервера. Для поддержания веселья и хорошего настроения участников.

Основные возможности:

• Множество мини-игр: Сапёр, крестики-нолики, найди пару и ещё 6 игр.
• Модульная система расширений: Выбирайте только те функции, которые вам нужны.
• Поощрение активности участников: Уровни за активность, статистика участника. Сколько сообщений/слов/времени в голосовом канале.
• Общение с ИИ: OpenAI API и все совместимые модели. (в доработке)
• Музыкальный плеер: на основе Lavalink v4.
• РП команды: Обнимашки и целовашки.
• Экономика: С возможностью покупки ролей на сервере.
• Журнал: Не пропустите ни одного события.
• Прочие весёлые команды: Статус майнкрафт сервера, коробка с весёлостями.
• Коллекция библиотек: Экономика, инвентарь, активность пользователя и другие. Для расширения функционала.
• Тут могут быть ваши функции...

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

Возрождение проекта Chiori lab На этот раз для Discord серверов.

Установка и запуск

Если вы заинтересовались, то давайте перейдём к запуску Шиори. Для этого выполните следующие простые шаги:

1. Загрузите репозиторий со всеми компонентами.

git clone https://git.miroq.ru/chio/cord

2. Установите зависимости через uv:

uv sync -U --with extensions

--with extensions означает что мы хотим установить все дополнительные зависимости. используемые в расширениях.

3. Настройки бота для первого запуска. Для этого скопируем файл env.dist в .env. После подставляем токен вашего Discord бота.

BOT_TOKEN = "ODY4MDk..."

Все прочие настройки детально описаны в созданном вами .env файле.

4. Создайте таблицу и пользователя в базе данных Postgres. После этого укажите данные для подключения в .env файле.

Теперь всё готово чтобы запустить Шиори через uv:

uv run -m chiori

Архитектура проекта

Бот разработан с использованием модульной структуры. Для того чтобы вам регулировать функционал бота, достаточно перемещать файлы в extensions/.

Если какое-то расширение вам не нужно - удалите его файл.

Обратите внимание что для работы некоторый расширений требуются другие расширения и библиотеки.

Так например, для работы экономики (coinengine) требуется расширение coins.

Ну а теперь к структуре каталогов:

├── bot_data/    - Данные бота: Сюда могут писать и читать файлы плагины.
├── chiori/      - Ядро бота: загрузчик расширений, API плагинов.
├── config/      - Настройки плагинов, загружаемые во время запуска ботаю.
├── extensions/  - Расширение функционала бота..
└── libs/        - Общие модули, предоставляющие API для всех расширений.

Поддержка бота

Если вам понравился бот и вы хотите поддержать развитие проекта. Есть несколько вариантов, как вы можете это сделать:

• Оставить звёздочку в репозитории проекта.
• Предлагать свои идеи на форуме или issue.
• Участвовать в бета-тестировании новых функций на нашем сервере.
• Писать свои собственные расширения.

На нашем сервере также есть раздел форума, где вы можете задавать свои вопросы и принимать активное участие в развитии проекта.

А ещё в Discord сервере вы можете принять участие в бета-тестировании новых функций бота. И не стесняйтесь сообщать о всех найденных багах, так вы сделаете Шиори лучше.

Благодарности

При разработке ядра использовались следующие библиотеки:

• hikari: Discord API обработчик.
• arc: Фреймворк для разработки командных ботов.
• miru: Удобная работа с кнопочками и меню.

Также расширения могут использовать сторонние модули.

Огромная благодарность разработчикам за чудесные библиотеки. 🧡 Благодаря всем вам мы становится лучше.