Skip to content

Commit 8729110

Browse files
authored
feat: add project context for claude
Document project details, folder structure, coding standards, and useful commands.
1 parent 2d64f84 commit 8729110

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# LuaBot - Instruções para o Claude
2+
3+
## Sobre o Projeto
4+
A LuaBot é uma bot do Discord que utiliza **discord.py**, ela foi feita por diversão, mas ela tem diversos comandos para moderar e automoderar o servidor(Caramelo System).
5+
6+
Além disso, a LuaBot tem uma personalidade de uma Shihtzu brincalhona.
7+
8+
## Stack
9+
10+
- Python **3.11+**
11+
- Discord.py
12+
- Banco de Dados usando MongoDB
13+
14+
## Estrutura de Pastas
15+
16+
```
17+
caramelo/
18+
blacklist/
19+
blacklist.py Sistema de Blacklist da LuaBot
20+
caramelo.py Comandos de AutoMod/Mod da LuaBot
21+
README.md
22+
23+
command/
24+
dev/
25+
shutdown.py Comando de desligar a LuaBot
26+
performance Comando de ver a Performance da LuaBot
27+
restart.py Comando de reiniciar a LuaBot
28+
infos/
29+
botinfo.py Comando de ver a info da LuaBot
30+
perfil.py Comando de ver o perfil do Usuário
31+
userinfo.py Comando de ver a info do usuário
32+
33+
roleplay/
34+
abraco.py Comando de roleplay: abraço
35+
beijar.py Comando de roleplay: beijar
36+
37+
commands_assets/
38+
Imagens dos comando que usam imagem
39+
40+
database/
41+
database.py Lógica da DB da LuaBot
42+
43+
shih/
44+
shih_manager.py Lógica de proteger o ".env".
45+
46+
utils/
47+
isGestor.py Verifica se é gestor da Loja da LuaBot
48+
49+
blacklisted_users.json Usuários banidos da LuaBot
50+
docker-compose.yml Docker Compose da LuaBot
51+
Dockerfile Docker da LuaBot
52+
(O Docker é utilizado apenas no GitHub)
53+
54+
main.py Arquivo principal da LuaBot
55+
requirements.txt libs da LuaBot
56+
```
57+
## Padrões de código
58+
- Sempre usar async/await (nunca código síncrono em eventos)
59+
- Não usar cogs.
60+
- Prefixo de comandos: `/` (slash command)
61+
- Tratar erros com `on_command_error`
62+
- Variáveis de ambiente via `python-dotenv` (nunca hardcodar tokens)
63+
64+
## Comandos úteis
65+
- Rodar o bot: `python main.py`
66+
- Instalar dependências: `pip install -r requirements.txt`

0 commit comments

Comments
 (0)