Update README.md

This commit is contained in:
Vlad Rud 2022-02-02 13:09:07 +03:00 committed by GitHub
parent 762131db61
commit 4cdc2a3ef5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions

View File

@ -2,6 +2,18 @@
Бот, генерирующий капчу в виде картинки с набором логотипов игровых движков. Проверяемому необходимо выбрать правильный и написать ответ цифрой. Если ответ неверный: бот банит пользователя.
## Модули
### Kicker
Сам бот, взаимодействующий с Telegram и базой. Обработчики событий находятся в `handlers.go`
### DB
Обработчик базы данных, взаимодействует с MongoDB
### Captchagen
Автономный генератор капчи. При запуске принимает список картинок, которые потом использует для генерации капчи. По умолчанию логотип с именем `godot.png` всегда является правильным.
## Как запустить:
Создать два файла: `bot.env` и `mongo.env` для настройки базы и самого бота.