Refactor project structure and update README; remove unused dependencies from requirements.txt and enhance database management in sql_commands.py.

This commit is contained in:
2026-05-31 12:56:55 +00:00
parent 5fdb37f7f8
commit 3e6410d112
4 changed files with 107 additions and 106 deletions
+30 -18
View File
@@ -56,25 +56,37 @@ Heres an outline of the directory and file structure for this project:
```
discord-bot/
├── bot.py # Main bot file for initializing the bot and loading cogs
├── requirements.txt # List of required Python packages
├── .env # Environment file containing sensitive data (e.g., bot token)
├── bot.py
├── bot_development.py
├── main.py
├── dockerfile
├── requirements.txt
├── README.md
├── Fixes.md
├── cogs/ # Folder containing individual cogs for separate functionalities
│ ├── admin.py # Admin commands such as ban, kick, etc.
│ ├── economy.py # Economy-related commands
│ ├── fun.py # Fun commands for user engagement
── roles.py # Commands for managing server roles
├── cogs/
│ ├── admin.py
│ ├── customCommands.py
│ ├── economy.py
── gamble.py
│ ├── informational.py
│ ├── listeners.py
│ ├── mail.py
│ ├── npc.py
│ ├── xp.py
├── utils/ # Folder containing utility files for common functionality
│ ├── bank_functions.py # Economy and balance management functions
── sql_Commands.py # Database helper functions for handling SQL commands
├── utils/
│ ├── bank_functions.py
── npc_data.py
│ ├── npc_handler.py
│ ├── npc_memory.py
│ ├── sql_commands.py
├── extras/ # Experimental or additional features (optional)
── example.py
└── docs/ # Documentation files
── CheckList.txt # Planning and improvement list (optional)
├── web/
── __init__.py
├── app.py
│ ├── static/
── templates/
```
---
@@ -117,7 +129,7 @@ Make sure your bot has the appropriate permissions for each command. You can man
Store sensitive information like your bot token in the `.env` file. Avoid committing this file to version control.
### Database
The bot currently uses SQLite for user and balance data. You can update `sql_Commands.py` and `bank_functions.py` in the `utils` folder to manage other data or switch to another database if necessary.
The bot currently uses MySQL for user and balance data through `utils/sql_commands.py` and `utils/bank_functions.py`. You can update these modules if you want to change the database engine or schema.
---
@@ -136,7 +148,7 @@ Make sure to include docstrings for any new functions and comments for complex l
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
No license file is included in this repository. Add a `LICENSE` file if you want to make the license explicit.
---