mau_mau_bot/README.md
codetriage-readme-bot f4d5c2d230 Add CodeTriage badge to jh0ker/mau_mau_bot
Adds a badge showing the number of people helping this repo on CodeTriage.

[![Open Source Helpers](https://www.codetriage.com/jh0ker/mau_mau_bot/badges/users.svg)](https://www.codetriage.com/jh0ker/mau_mau_bot)

## What is CodeTriage?

CodeTriage is an Open Source app that is designed to make contributing to Open Source projects easier. It works by sending subscribers a few open issues in their inbox. If subscribers get busy, there is an algorithm that backs off issue load so they do not get overwhelmed

[Read more about the CodeTriage project](https://www.codetriage.com/what).

## Why am I getting this PR?

Your project was picked by the human, @schneems. They selected it from the projects submitted to https://www.codetriage.com and hand edited the PR. How did your project get added to [CodeTriage](https://www.codetriage.com/what)? Roughly 5 months ago, [@TiagoDanin](https://github.com/TiagoDanin) added this project to CodeTriage in order to start contributing.

## What does adding a badge accomplish?

Adding a badge invites people to help contribute to your project. It also lets developers know that others are invested in the longterm success and maintainability of the project.

You can see an example of a CodeTriage badge on these popular OSS READMEs:

- [![](https://www.codetriage.com/rails/rails/badges/users.svg)](https://www.codetriage.com/rails/rails) https://github.com/rails/rails
- [![](https://www.codetriage.com/crystal-lang/crystal/badges/users.svg)](https://www.codetriage.com/crystal-lang/crystal) https://github.com/crystal-lang/crystal

## Have a question or comment?

While I am a bot, this PR was manually reviewed and monitored by a human - @schneems. My job is writing commit messages and handling PR logistics.

If you have any questions, you can reply back to this PR and they will be answered by @schneems. If you do not want a badge right now, no worries, close the PR, you will not hear from me again.

Thanks for making your project Open Source! Any feedback is greatly appreciated.
2018-02-05 21:39:50 -06:00

1.4 KiB

UNO Bot

License: AGPL v3 Open Source Helpers

Telegram Bot that allows you to play the popular card game UNO via inline queries. The bot currently runs as @unobot.

To run the bot yourself, you will need:

Setup

  • Get a bot token from @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.