XPMan

XPMan

Point-based multiplayer hangman game for Telegram Messenger.
Explore the docs »

Bot Profile On Telegram · Report Bug · Request Feature

XPMan is a hangman like game for Telegram Messenger where players have to guess a word. Players will be rewarded with points whenever they guess right and punished when they do not, the points earned in-game can be used to gain advantaged. The game is round based and by the end of it the player with the most points wins.

Built With

• telebot
• todo

Getting Started

To self-host this bot you will need to have the Go compiler and MariaDB installed on your system.

Installation

1. Get your Telegram API Key at BotFather
2. Clone the repo

   git clone https://github.com/RaphGL/XPMan
   

3. Compile the bot running:

   go build
   

4. Enter your API in config.json or use the $TGBOT_API_KEY env variable (the variable takes precedence over the json file). Create the XPMan database and provide it's setup on database_setup.

   {
       "api_key": "your_api_key",
       "database_setup": "root:password@tcp(ip_address:3306)/database_name"
   }
   

5. Setup MariaDB and create the database:

   create database <database_name>;
   

After the first run the bot will do the remaining setting up requirements on its own, you're good to go!

Usage

TODO

License

Distributed under GPLv3 License. See LICENSE for more information.

Acknowledgements

• TODO