Skip to content

Nickelza/one-piece-group-bot

Repository files navigation

one-piece-group-bot

LOC License Project Status

Official Links

Quick Links


Overview

Bring a One-Piece Bounty System to your Telegram Group


Features

  • Bounty for each user
  • Bounty Poster
  • Leaderboard
  • Crews
  • Devil Fruits

Non-Exhaustive List of Features

Getting Started

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

Installation

  1. Clone the one-piece-group-bot repository:
git clone https://github.com/Nickelza/one-piece-group-bot
  1. Change to the project directory:
cd one-piece-group-bot
  1. Install the dependencies:
pip install -r requirements.txt
  1. Create a .env file under the project root folder and set the required environment variables as described in the environment/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.

Running one-piece-group-bot

Use the following command to run one-piece-group-bot:

python main.py [optional path to .env file]

Dashboard

Some features, such as Devil Fruit or Warlord management, require setting up the dashboard. To do so, follow the instructions in the dashboard repository.


Project Roadmap


Contributing

Contributions are welcome! Here are several ways you can contribute:

*Submit Pull Requests **: Review open PRs, and submit your own PRs.


License

This project is protected under the GNU GPLv3 License. For more details, refer to the LICENSE file.


Return


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages