Using the bot

1. Talk to the BotFather (https://telegram.me/botfather)
2. Create a bot following his steps and receive your token
3. Put this token into the example_properties.ini file at the token field
4. You can fill in the current_raid_bosses and raid_duration fields
5. Rename example_properties.ini to properties.ini
6. Run the bot
7. Add the bot to your Telegram App
8. Use the /userid command to get your user id and put it into the properties file at the admins field
9. If you have a group or channel where you want to place the bot, use the /chatid command and put it at the group_chat_id field. The bot will send all the raid messages to this chat.
10. Restart the bot
11. The bot is now ready

Commands

• /chatid : gives the id of the current chat
• /userid : gives the id of the user issuing this command
• /hallo : introduces yourself to bot (needed for the makeAdmin and removeAdmin commands)
• /addRaid : starts the sequence to add a raid, follow the instructions given. Only for admins
• /testRaid : adds a completely randomized raid to the current chat (for testing purposes). Only for admins
• /recover : loads the data from the backup files (raids and users). THIS WILL REMOVE ANY RAIDS ALREADY PRESENT! Only for admins
• /makeAdmin X : makes the user with username X an admin for the bot. Only for admins
• /removeAdmin X : removes the user with username X as admin for the bot. Only for admins

Running the bot

If you have the source code, just execute the main.py script. The bot is built using Python 3, older version are not guaranteed to work correctly!!!
Otherwise run the executable (eg main.exe for Windows), this executable is created using PyInstaller. You can create your own executable from the source code using pyinstaller -F main.py, for more information check their site.

It is necessary that the following files are in the same folder as the code or executable:

• parsed_moves.json
• parsed_pokemon.json
• properties.ini

The parsed_XXX.json files are created from another file that contains all of the information about moves and pokemon. For this program however, we need far less information than they provide. So I wrote a script, parse_raw_data.py, that takes only the necessary information from these sources and saves them in the parsed files. So normally you will never use this script and just keep the parsed files.

The properties.ini file is something you have to create from the example_properties.ini file using the instructions in the file and the "Using the bot" section of this document.

Python Telegram Bot

This program was made using the Python Telegram bot, see GitHub for the source code. This framework is needed in order to run the bot. To install it, we refer to the link above. In short, it comes down to the following command:
pip install python-telegram-bot --upgrade
This framework is licensed with LGPLv3.

License

This program is licensed with GPL-3.0. For a summary, see the GitHub License page