39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
# AGENTS.md
|
||
|
||
## Проект
|
||
Discord-бот на Python (discord.py). Команды: `!msg` (повтор текста), `!pogoda` (прогноз погоды для Магнитогорска).
|
||
|
||
## Запуск
|
||
```
|
||
pip install -r requirements.txt
|
||
python bot.py
|
||
```
|
||
|
||
Введите `stop` в терминал для остановки.
|
||
|
||
## Токен
|
||
Токен бота хранится в `.env` (переменная `DISCORD_TOKEN`). Получи токен на [Discord Developer Portal](https://discord.com/developers/applications). Шаблон в `.env.example`.
|
||
|
||
## Конвенции
|
||
Используй TODO-списки для каждого запроса с несколькими шагами.
|
||
|
||
## Архитектура
|
||
```
|
||
commands/ # Discord команды (cogs)
|
||
__init__.py # ALL_COMMANDS — явные импорты
|
||
pogoda.py # !pogoda
|
||
console_commands/ # Консольные команды
|
||
__init__.py # ALL_CONSOLE_COMMANDS — явные импорты
|
||
stop.py # stop
|
||
```
|
||
|
||
**Добавление Discord команды:**
|
||
1. Создать файл `commands/имя.py` с классом, наследующим `commands.Cog`
|
||
2. Добавить импорт в `commands/__init__.py`
|
||
3. Добавить класс в `ALL_COMMANDS`
|
||
|
||
**Добавление консольной команды:**
|
||
1. Создать файл `console_commands/имя.py` с функцией
|
||
2. Добавить импорт в `console_commands/__init__.py`
|
||
3. Добавить функцию в `ALL_CONSOLE_COMMANDS`
|