Jerry
1c713de46d
* kick handler test * Add authentication and fix bugs * Add help text * minor fix * Remove useless comments * Get user object from reply first. * Update bot.py * minor fix * update help text * Update AUTHORS.md * Remove old /kick implementation * minor fix * Manually merge upstream changes * No need to accept args * remove unused chat_setting.py * botan * import botan from submodule for compatibility with python-telegram-bot 8.1+ * fix typo * Update requirements.txt * delete submodule * Drop botan support completely * Refine the way of getting config * Bug fix
24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
# UNO Bot
|
|
|
|
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](./LICENSE)
|
|
|
|
Telegram Bot that allows you to play the popular card game UNO via inline queries. The bot currently runs as [@unobot](http://telegram.me/unobot).
|
|
|
|
To run the bot yourself, you will need:
|
|
- Python (tested with 3.4+)
|
|
- The [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) module
|
|
- [Pony ORM](https://ponyorm.com/)
|
|
|
|
## Setup
|
|
- Get a bot token from [@BotFather](http://telegram.me/BotFather) and change configurations in `config.json`.
|
|
- Convert all language files from `.po` files to `.mo` by executing the bash script `compile.sh` located in the `locales` folder.
|
|
Another option is: `find . -maxdepth 2 -type d -name 'LC_MESSAGES' -exec bash -c 'msgfmt {}/unobot.po -o {}/unobot.mo' \;`.
|
|
- Use `/setinline` and `/setinlinefeedback` with BotFather for your bot.
|
|
- Install requirements (using a `virtualenv` is recommended): `pip install -r requirements.txt`
|
|
|
|
You can change some gameplay parameters like turn times, minimum amount of players and default gamemode in `config.json`.
|
|
Current gamemodes available: classic, fast and wild. Check the details with the `/modes` command.
|
|
|
|
Then run the bot with `python3 bot.py`.
|
|
|
|
Code documentation is minimal but there.
|