https://github.com/jacklul/inlinegamesbot

A Telegram bot providing games that can be played in any chat via inline keyboards.
https://github.com/jacklul/inlinegamesbot

bot games php-telegram-bot telegram telegram-bot

Last synced: 10 days ago
JSON representation

A Telegram bot providing games that can be played in any chat via inline keyboards.

• Host: GitHub
• URL: https://github.com/jacklul/inlinegamesbot
• Owner: jacklul
• License: agpl-3.0
• Created: 2016-12-24T14:29:44.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-10-29T20:28:42.000Z (about 1 year ago)
• Last Synced: 2024-08-01T18:26:23.745Z (3 months ago)
• Topics: bot, games, php-telegram-bot, telegram, telegram-bot
• Language: PHP
• Homepage: https://telegram.me/inlinegamesbot
• Size: 1.13 MB
• Stars: 116
• Watchers: 9
• Forks: 113
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Inline Games [![License](https://img.shields.io/github/license/jacklul/inlinegamesbot.svg)](https://github.com/jacklul/inlinegamesbot/blob/master/LICENSE) [![Telegram](https://img.shields.io/badge/Telegram-%40inlinegamesbot-blue.svg)](https://telegram.me/inlinegamesbot)

A Telegram bot that provides real-time multiplayer games that can be played in any chat.

You can see the bot in action by messaging [@inlinegamesbot](https://telegram.me/inlinegamesbot).

#### Currently available games:

- Tic-Tac-Toe

- Tic-Tac-Four ([@DO97](https://github.com/DO97))

- Elephant XO ([@DO97](https://github.com/DO97))

- Connect Four

- Rock-Paper-Scissors

- Rock-Paper-Scissors-Lizard-Spock ([@DO97](https://github.com/DO97))

- Russian Roulette

- Checkers

- Pool Checkers

## Deploying

### Heroku

  Instructions

Use this button to begin deployment:  

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/jacklul/inlinegamesbot)

Assuming everything was entered correctly your bot should be instantly working - if it's not you should try running `php bin/console post-install` inside the app.

You will also want to add **Heroku Scheduler** addon and set up a hourly task to run the following command to clean up expired games from the database:

- `php bin/console cron`

_If this command times out too fast try using something like this instead: `php -d max_execution_time=2700 bin/console cron`_

### Google Cloud Platform

  Instructions

- Install dependencies with `composer install`

- Copy `env_variables.example.yaml` into `env_variables.yaml` and fill out the details

- Run the deployment command: `gcloud app deploy --project YOUR-PROJECT-NAME-HERE app.yaml cron.yaml`

- Visit `https://YOUR-PROJECT-NAME-HERE.appspot.com/admin?a=post-install` to perform post-install tasks

### Fly.io

  Instructions

- `flyctl apps create`

- `flyctl volumes create data --size=1`

- `flyctl secrets set BOT_TOKEN=`

- `flyctl secrets set BOT_USERNAME=`

- `flyctl secrets set BOT_WEBHOOK=YOUR-APP-NAME.fly.dev`

- `flyctl secrets set BOT_SECRET=`

- If you want to use web+worker setup you have to replace `web:` line in `Procfile`

- `flyctl deploy`

## Note on translations

Translations support is implemented but it is not used mainly because translated text would be displayed to both players - this could be problematic in "gaming" groups - people setting language that other player can't understand!

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for more information.

## License

See [LICENSE](LICENSE).