Skip to content

Miroqru/chiori

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

286 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chiori; Cord

Ruff Version LICENSE Discord Docs Python Gitea Last Commit

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

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

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

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

Установка и первый запуск

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

  1. Клонируйте репозиторий со всеми компонентами.
git clone https://git.miroq.ru/chio/cord
  1. Установите зависимости через uv:
uv sync -U --all-groups

Если же вы хотите использовать все возможности Шиори, то выполните:

uv sync --with extensions

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

  1. Настройки бота для первого запуска. Для этого скопируем файл env.dist в .env. После подставляем токен вашего Discord бота.
BOT_TOKEN = "ODY4MDk..."
  1. Создайте таблицу и пользователя в базе данных Postgres. После этого укажите данные для подключения в .env файле.

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

uv run -m chioricord

Структура проекта

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

Если вам не нужен какой-то плагин - удалить его.

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

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

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

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

Есть несколько вариантов, как вы можете помочь развитию бота:

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

Предлагать свои собственные идеи вы можете как в issue, так и в соответствующем разделе форуме в Discord сервера (ссылка выше).

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

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

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

  • hikari: Discord API обработчик.
  • arc: Командный фреймворк для hikari.
  • miru: Удобная работа с View.

Спасибо авторам за чудесные библиотеки. 🧡

About

Cute multi-functiona extensible bot for your discord server.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages