MadBot

Исходный код MadBot. Вы можете помогать созданию бота, используя Pull Requests.

Настройка

• Скачиваем/клонируем репозиторий в отдельную папку.
• Копируем .env_example как .env и меняем значения ключей.
• Рекомендуется создать виртуальное окружение Python. Используйте python -m venv venv, находясь в корневой папке бота. Если необходимые компоненты для создания окружения отсутствуют - установите их согласно инструкции Вашей операционной системы.
• Войдите в только что созданное окружение:
  • Linux: source ./venv/bin/activate.
• Устанавливаем зависимости из requirements.txt: pip install -r requirements.txt
• Запускаем main.py: python main.py.
  • Если Вы запускаете бота впервые, необходимо прописать флаг --migrate-db для создания базовых записей в базе данных.
  • Для запуска бота с целью отладки, рекомендуется использовать флаг --debug-mode.
  • Подробнее с флагами можно ознакомиться, прописав флаг --help.
  • Пример: python main.py --debug-mode --migrate-db.

Требования

См. requirements.txt. Минимальная версия Python: 3.10 (это связано с использованием | вместо typing.Union и match). Необходима настройка MongoDB. Укажите ссылку на сервер MongoDB в .env.

Рекомендуется использовать ОС на основе GNU/Linux. Работа на остальных операционных системах не протестирована и не гарантирована! Работа на Windows протестирована: код не работает должным образом. Со временем это не будет исправлено.

Помощь в разработке

См. CONTRIBUTING.md. Лучше не лезьте. Мы сами не знаем, что будем делать с ботом, а Ваш труд может оказаться напрасным. Зацените лучше ветку v2 и посоветуйте, как ее улучшить.

Changelog

См. changelog.md.