Skip to content

Commit

Permalink
Merge pull request #4 from Crazy-Marvin/development
Browse files Browse the repository at this point in the history
Release 0.1
  • Loading branch information
CrazyMarvin authored Apr 26, 2020
2 parents 24c6d66 + c5ce517 commit 24a743e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ This [Telegram](https://telegram.org/) game/bot lets you play the 2048 game with

[Play here](https://t.me/twothousandfortyeightbot?game=twothousandfortyeight)

## Screenshots
## Screenshot

_TODO_
![2048TelegramBot_Screenshot](https://user-images.githubusercontent.com/15004217/80318026-840fd480-8807-11ea-89e3-487170376a14.jpg)

## Setup

The setup consists of two parts. One webserver that hosts the game, and one normal server that hosts the bot.
- The game itself is located in the ```game``` folder and needs to be put on any webserver
- The game itself is located in the ```game``` folder and needs to be put on any webserver, preferrably [GitHub Pages](https://pages.github.com/)
- The bot can be found in `bot` and has installation instructions in its [```README```](https://github.com/Crazy-Marvin/2048TelegramBot/blob/master/bot/README.md)

## Contributing
Expand All @@ -34,6 +34,7 @@ Please read [```CONTRIBUTING.md```](https://github.com/Crazy-Marvin/2048Telegram

- [2048](https://play2048.co/) by [Gabriele Cirulli](https://gabrielecirulli.com/)
- [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot)
- [Python Configlib](https://github.com/romangraef/configlib)

## License

Expand Down
6 changes: 5 additions & 1 deletion bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,15 @@ pip install -r requirements.txt
{
"token": "the token provided by the botfather",
"game_name": "the short name of the game as given in the botfather",
"game_url": "the http adress of the game html",
"game_url": "the http(s) adress of the game html without trailing slash",
"bot_url": "the ip/hostname of this bot. this is not a webadress, so don't prefix it with http://. it should be in the form of 127.0.0.1 or google.com"
}
```

Here you can see the ```game_name```:

![game_name](https://user-images.githubusercontent.com/15004217/80318150-45c6e500-8808-11ea-966d-162a3f549287.PNG)

# Running
Run the following command
```bash
Expand Down

0 comments on commit 24a743e

Please sign in to comment.