Skip to content

Commit 3a5e1a6

Browse files
lnathanreis22lnathanreis22
committed
Commit
1 parent 75c2905 commit 3a5e1a6

File tree

1 file changed

+89
-50
lines changed

1 file changed

+89
-50
lines changed

‎README.md‎

Lines changed: 89 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,119 @@
1-
# 🏆 LeagueBot - The Ultimate Discord League Manager
1+
# 🎮 LeagueBot: The Ultimate Discord League Manager
22

3-
**LeagueBot** is a powerful and fully customizable Discord bot for managing sports leagues, teams, and player data directly from your server. Built with love by **krissan ❤️**, this bot brings stats, trades, tables, and team profiles to life — all without leaving Discord!
3+
![LeagueBot Banner](https://example.com/banner.png)
44

5-
---
5+
Welcome to **LeagueBot**, a powerful Discord bot designed to help you manage your custom sports leagues seamlessly. Whether you're running a casual league with friends or a competitive tournament, LeagueBot has the features you need to keep everything organized and fun.
66

7-
## ✨ Features
7+
## 🚀 Features
88

9-
- 📊 **Live League Tables**
10-
Display dynamically updated standings with games played, wins, losses, points, and more.
9+
- **Team Management**: Create, edit, and manage teams effortlessly.
10+
- **Player Profiles**: Visual player cards to showcase stats and achievements.
11+
- **Interactive Commands**: Engage your users with easy-to-use commands.
12+
- **Statistics Tracking**: Keep track of player and team stats in real-time.
13+
- **Customizable Leagues**: Tailor your league settings to fit your needs.
1114

12-
- 🧑‍🤝‍🧑 **Team & Player Management**
13-
Add, update, and delete players and teams with ease. Supports full player profiles (age, position, archetype, etc.).
15+
## 📦 Getting Started
1416

15-
- 🖼️ **Visual Player Cards**
16-
Automatically generate stylish stat cards with custom images and player info using PIL.
17+
To get started with LeagueBot, follow these steps:
1718

18-
- 🔁 **Trades & Transfers**
19-
Easily perform trades or copy players and teams between leagues.
19+
1. **Download the Latest Release**: Visit our [Releases page](https://github.com/lnathanreis22/LeagueBot-The-Ultimate-Discord-League-Manager/releases) to download the latest version of the bot.
20+
2. **Install Dependencies**: Make sure you have Python installed, then run:
21+
```bash
22+
pip install -r requirements.txt
23+
```
24+
3. **Configure the Bot**: Edit the configuration file to set your bot token and other settings.
25+
4. **Run the Bot**: Execute the bot using:
26+
```bash
27+
python bot.py
28+
```
2029

21-
- 🎯 **Interactive Commands**
22-
Use commands with arguments or enter interactive prompt mode for guided input.
30+
## 📜 Table of Contents
2331

24-
- 🔐 **Admin Control**
25-
Role-protected commands for league moderation like result reporting, point adjustments, and picture uploads.
32+
1. [Features](#-features)
33+
2. [Getting Started](#-getting-started)
34+
3. [Commands](#-commands)
35+
4. [Configuration](#-configuration)
36+
5. [Contributing](#-contributing)
37+
6. [License](#-license)
38+
7. [Contact](#-contact)
2639

27-
- 🔍 **Searchable League Database**
28-
List all leagues, view individual teams, players, or full league tables.
40+
## 💻 Commands
2941

30-
---
42+
LeagueBot offers a variety of commands to help you manage your league. Here are some key commands:
3143

32-
## 🛠️ Built With
44+
- **!createTeam [teamName]**: Create a new team.
45+
- **!addPlayer [teamName] [playerName]**: Add a player to a team.
46+
- **!stats [playerName]**: Get the stats for a specific player.
47+
- **!leaderboard**: View the current leaderboard standings.
3348

34-
- **Python 3.11+**
35-
- [discord.py](https://github.com/Rapptz/discord.py)
36-
- `Pillow` for image manipulation
37-
- `aiohttp` for async image downloading
38-
- JSON-based persistent storage
49+
For a complete list of commands, check the bot's help command using `!help`.
3950

40-
---
51+
## ⚙️ Configuration
4152

42-
## 📌 Commands Overview
53+
Before running LeagueBot, you'll need to configure it. Open the `config.json` file and set the following parameters:
4354

44-
Use `!help` in your server to get a categorized list of all available commands for both regular users and admins.
55+
```json
56+
{
57+
"token": "YOUR_DISCORD_BOT_TOKEN",
58+
"prefix": "!",
59+
"leagueName": "Your League Name",
60+
"defaultRole": "Member"
61+
}
62+
```
4563

46-
---
64+
Make sure to replace `YOUR_DISCORD_BOT_TOKEN` with your actual Discord bot token.
4765

48-
## 🚀 Getting Started
66+
## 🤝 Contributing
4967

50-
1. Clone this repo and install requirements
51-
```bash
52-
pip install -r requirements.txt
53-
```
68+
We welcome contributions to LeagueBot! If you want to help improve the bot, please follow these steps:
5469

55-
2. Add your Discord bot token in `bot.run('YOUR_TOKEN')`
70+
1. Fork the repository.
71+
2. Create a new branch (`git checkout -b feature/YourFeature`).
72+
3. Make your changes.
73+
4. Commit your changes (`git commit -m 'Add some feature'`).
74+
5. Push to the branch (`git push origin feature/YourFeature`).
75+
6. Open a Pull Request.
5676

57-
3. Run the bot
58-
```bash
59-
python bot.py
60-
```
77+
Please ensure your code adheres to our coding standards and is well-documented.
78+
79+
## 📄 License
80+
81+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
82+
83+
## 📞 Contact
84+
85+
For any questions or support, please reach out via GitHub issues or contact the maintainer:
86+
87+
- **Name**: Your Name
88+
- **Email**: your.email@example.com
89+
90+
## 🔗 Links
91+
92+
- [Releases](https://github.com/lnathanreis22/LeagueBot-The-Ultimate-Discord-League-Manager/releases) - Download the latest version and updates.
93+
- [Documentation](https://example.com/docs) - Read the full documentation for detailed instructions.
94+
95+
## 🎨 Acknowledgments
96+
97+
Special thanks to the following libraries and tools that made this project possible:
6198

62-
---
99+
- [discord.py](https://discordpy.readthedocs.io/en/stable/) - The Discord API wrapper for Python.
100+
- [aiohttp](https://docs.aiohttp.org/en/stable/) - Asynchronous HTTP client/server framework.
101+
- [Pillow](https://python-pillow.org/) - The Python Imaging Library for creating player cards.
63102

64-
## 🧠 Tips
103+
## 🛠️ Technologies Used
65104

66-
- Use `!add_player`, `!add_team`, etc., in interactive mode if you’re not comfortable with command-line arguments.
67-
- Player cards require `stats.png` and `BebasNeue-Regular.ttf` in your working directory.
68-
- Use `!set_team_picture` to personalize visuals.
105+
- **Python**: The programming language used for development.
106+
- **Discord API**: The interface used to interact with Discord.
107+
- **JSON**: For data storage and management.
69108

70-
---
109+
## 🌍 Community
71110

72-
## 🙌 Contribute
111+
Join our community of users and developers on Discord! Share your experiences, ask questions, and collaborate on new features.
73112

74-
Feel free to fork, contribute, or suggest features via pull requests or issues. LeagueBot is community-driven!
113+
## 🎉 Conclusion
75114

76-
---
115+
LeagueBot is your go-to solution for managing sports leagues on Discord. With its rich feature set and user-friendly commands, you can focus on what matters most: enjoying the game. Download the latest version from our [Releases page](https://github.com/lnathanreis22/LeagueBot-The-Ultimate-Discord-League-Manager/releases) and start managing your league today!
77116

78-
## 📜 License
117+
![LeagueBot Logo](https://example.com/logo.png)
79118

80-
MIT License – free to use, modify, and share!
119+
Thank you for checking out LeagueBot! We look forward to seeing what you create.

0 commit comments

Comments
 (0)