Bring a One-Piece Bounty System to your Telegram Group
- Bounty for each user
- Bounty Poster
- Leaderboard
- Crews
- Devil Fruits
Non-Exhaustive List of Features
Requirements
Ensure you have the following dependencies installed on your system:
- Python:
3.11 or higher
- MySQL:
8.0 or higher
- Create a Telegram Bot using the BotFather and obtain the bot token
- Create a Telegram Group in which the Bot will be used
- Clone the one-piece-group-bot repository:
git clone https://github.com/Nickelza/one-piece-group-bot
- Change to the project directory:
cd one-piece-group-bot
- Install the dependencies:
pip install -r requirements.txt
- Create a
.env
file under the project root folder and set the required environment variables as described in theenvironment/env.example
file.
-
BOT_TOKEN
- Telegram Bot Token obtained from BotFather -
BOT_ID
- Created Bot ID -
BOT_USERNAME
- Created Bot Username -
DB_NAME
- MySQL Database Name -
DB_HOST
- MySQL Database Host -
DB_PORT
- MySQL Database Port -
DB_USER
- MySQL Database User -
DB_PASSWORD
- MySQL Database Password -
UPDATES_CHAT_ID
- Telegram Chat ID for Updates, used for global leaderboard
For a full list of environment variables and their descriptions, refer to
the resources/Environment.py
file.
Use the following command to run one-piece-group-bot:
python main.py [optional path to .env file]
Some features, such as Devil Fruit or Warlord management, require setting up the dashboard. To do so, follow the instructions in the dashboard repository.
Contributions are welcome! Here are several ways you can contribute:
*Submit Pull Requests **: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
- Report Issues: Submit bugs found or log feature requests for One-piece-group-bot.
This project is protected under the GNU GPLv3 License. For more details, refer to the LICENSE file.