https://github.com/raphgl/xpman
Point-based multiplayer hangman game for Telegram Messenger.
https://github.com/raphgl/xpman
game hangman telegram-bot telegram-bots
Last synced: 3 months ago
JSON representation
Point-based multiplayer hangman game for Telegram Messenger.
- Host: GitHub
- URL: https://github.com/raphgl/xpman
- Owner: RaphGL
- License: gpl-3.0
- Created: 2021-09-03T14:55:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-30T13:28:56.000Z (about 3 years ago)
- Last Synced: 2025-06-25T00:12:20.480Z (4 months ago)
- Topics: game, hangman, telegram-bot, telegram-bots
- Language: Go
- Homepage:
- Size: 43 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
XPMan
Point-based multiplayer hangman game for Telegram Messenger.
Explore the docs »
Bot Profile On Telegram
·
Report Bug
·
Request Feature
Table of Contents
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](https://github.com/tucnak/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](https://t.me/Botfather)
2. Clone the repo
```sh
git clone https://github.com/RaphGL/XPMan
```
3. Compile the bot running:
```sh
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.
```js
{
"api_key": "your_api_key",
"database_setup": "root:password@tcp(ip_address:3306)/database_name"
}
```
5. Setup MariaDB and create the database:
```sql
create database ;
```
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]()
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png