hexa-bot

Core bot of the Telegram groups @yugiohitatcgocg, @yugiohmarketingita and affiliates.

Description

hexa-bot was created out of the need to manage thousands of users in a Telegram community I own, where we previously handled all requests by hand.
The main topic of the community, as you may have guessed by the name, is the trading card game known as "Yu-Gi-Oh", which I have been interested in since 2010.
The name of the bot comes from the card "Hexa Spirit of the Ice Barrier", a nice little fellow from the "Ice Barrier" archetype, which is the main theme across the groups.
If you are interested in the game you are more than welcome to join, at the moment we are focused mostly on the Italian-speaking groups, but we also have an English-speaking one that you can find at @yugiohgroup

Usage

hexa-bot is currently focused on admin-side utilities, but there are also some nice things you can do as a normal user:

• Gain access to the marketplace group via the /seller command
• Leave feedbacks to other users marking your feedback messages with #feedback
• Get all the feedbacks related to a user via the /feedback @username command
• Obtain the description of any card using the /search command
• Play the "Guess the card game" in our public group, directly on Telegram, with /guessthecard

Contributing

If you have experience with Python and the python-telegram-bot library, you are free to clone the repo and submit a pull request. The only things you need are a bot token obtained via @botfather, a debug_config.json file in the app/static folder, which should contain various informations about the testing environment (bot username, groups, etc..) and a Postgres database.

Please note that for linting and formatting I'm using trunk, you can find the configuration files in this repo. Also please keep in mind that this bot works to serve a specific community on Telegram, if you are unsure of what needs to be done you can join the group or read the todo section.

Todo

The bot has been deployed and is currently running at @yugiohmainbot, but I'm still working on improving existing code and adding new features.
Here is a list of various things that I'm planning on doing:

• Create an API to retrieve community analytics (and display them on this repo)
• Add support for auctions, claims and other important group features
• Add features for the judge role which is currently not used
• Use a better way to check if a post is a sell post or buy post, or neither
• Add more roles and different permissions to roles, check the permissions instead of the roles
• Add more games and events for the community
• Build a userbot with another library to test the handlers
• A plethora of other minor tweaks and fixes that I've written down in my personal todo list