battle_royale_sim/README.md

# Battle Royale Simulator (Hunger Games)

Hunger Games Simulator for telegram.

You can find the Official Bot here:
@Brsimgen_Bot - https://t.me/Brsimgen_Bot

Feel free to fork the project and make your own Bot

This game is inspired to this Hunger Games Simulator: https://brantsteele.net/hungergames/reaping.php

# Bot Instructions (Telegram)

1. start a chat with the bot: https://t.me/Brsimgen_Bot
2. open the bot keyboard
3. Press button "Init/Restart" to initialize the world
4. now is time to add players (max players is 70):
  - you can manually add new players with button "Add Player" then you'll need to insert the player name (or multiple names comma separated)
  - test 
5. Now you can start with the game simulation
  - press "Simulate Day" to make time elapse till the end of the day, and watch what's happend during the day
  - press "Run Periodically" to make the bot do everything, you only need to insert the periodicity of the scheduler: for example 30
    now every day will automatically end in 30 seconds
6. you can always check the game status with the buttons:
  - Get Players: (see all the players)
  - Get Alive Players: (list of alive players)
  - Get Death Players: (list of death players)
  - Get Ranking Players: (this is the leaderboard, based on number of kills)
  - Show Map UTF8 or Show Map Image (show Players/Items position on the map)

# Bot Instructions (CLI)

1. open a python shell
2. `import debug`
3. `debug.init_debug_simulation()`

# Fork Instructions

if you want to fork this project
remember to create a file

`local_settings.py`

on the same folder of

`bot.py`

file

containing

```
TOKEN = 'your-bot-token'

BOT_PATH= '/the/path/of/the/project'

LOG_PATH= '/the/path/where/you/want/put/game/daily/logs'

BOT_EXEC_CMD= 'python3 bot.py' # or any other way you start the bot

SUPER_USERS= [ your_chat_id ]
```