Reworked README
This commit is contained in:
parent
768c4bc3f3
commit
0dbd80c24e
1 changed files with 30 additions and 25 deletions
55
README.md
55
README.md
|
|
@ -29,31 +29,36 @@ aiohttp>=3.8.0
|
||||||
Create the following structure on your QNAP:
|
Create the following structure on your QNAP:
|
||||||
|
|
||||||
```
|
```
|
||||||
/share/Container/discord-bot/
|
C:.
|
||||||
├── bot.py # Script principal minimal
|
| bot.py # Main bot script
|
||||||
├── config.py # Variables centrales (token, channel ID)
|
| config.py # Configuration (token, channel ID, etc.)
|
||||||
├── requirements.txt # Dépendances Python
|
| requirements.txt
|
||||||
├── .env # Tokens, IDs de channel
|
| .env # Tokens and IDs
|
||||||
├── docker-compose.yml
|
| docker-compose.yml
|
||||||
├── bot_data.db # SQLite DB
|
| Dockerfile
|
||||||
├── cogs/ # Toutes les commandes du bot
|
| README.md
|
||||||
│ ├── guide.py # Commande !guide
|
|
|
||||||
│ ├── pbhydra.py # Commandes PB Hydra
|
+---cogs
|
||||||
│ ├── pbchimera.py # Commandes PB Chimera
|
| ├── guide.py # Commande !guide
|
||||||
│ ├── pbcvc.py # Commandes PB CvC
|
| ├── pbhydra.py # Commands for Hydra PB
|
||||||
│ ├── top10.py # Classements globaux
|
| ├── pbchimera.py # Commands for Chimera PB
|
||||||
│ └── mystats.py # Commande !mystats
|
| ├── pbcvc.py # Commands for CvC PB
|
||||||
├── utils/ # Fonctions utilitaires partagées
|
| ├── top10.py # Global and clan leaderboards
|
||||||
│ ├── DatabaseManager_class.py # Gestion DB SQLite
|
| └── mystats.py # Command !mystats
|
||||||
│ ├── ScreenshotManager_class.py # Gestion des screenshots
|
|
|
||||||
│ ├── leaderboard_handler.py # Gestion tableau de score
|
+---utils
|
||||||
│ ├── pbhandler.py # Gestion des pbs
|
| ├── DatabaseManager_class.py # SQLite DB manager
|
||||||
│ └── helpers.py # Fonctions génériques (ex: channel autorisé)
|
| ├── ScreenshotManager_class.py # Screenshot manager
|
||||||
├── logs/ # Logs du bot (optionnel)
|
| ├── leaderboard_handler.py # Leaderboard logic
|
||||||
└── screenshots/ # Screenshots organisés par boss/difficulté
|
| ├── pb_handler.py # PB submission logic
|
||||||
├── hydra/
|
| └── helpers.py # Helper functions
|
||||||
├── chimera/
|
|
|
||||||
└── cvc/
|
+---screenshots
|
||||||
|
| ├── hydra/
|
||||||
|
| ├── chimera/
|
||||||
|
| └── cvc/
|
||||||
|
|
|
||||||
|
└── logs/ # Optional logs folder
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🐳 Docker Installation (Recommended)
|
## 🐳 Docker Installation (Recommended)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue