Skip to content
This repository has been archived by the owner on Apr 5, 2024. It is now read-only.

Latest commit

 

History

History
58 lines (49 loc) · 3.31 KB

README.md

File metadata and controls

58 lines (49 loc) · 3.31 KB

ThePokeGOBot

A Pokémon GO Telegram bot to manage raids and quests.

Requirements

How to autorun

  1. Update autobackup.py
  2. update dockerfile
  3. run dockerfile

Installation

  1. Install Python 3.6+
  2. Install the requirements python -m pip install -r requirements.txt
  3. Create a Telegram bot using BotFather and get its token
  4. Edit the config.json by replacing the following:
  • BOT_TOKEN with your Telegram Bot Token
  • 123456 with your Telegram ID (some commands will only respond to this ID), that can be found by starting a conversation with this bot
  • en with any of the available languages (one of the folder names inside /locale directory). If empty or set to an unavailable language it will be set to the main language (English).
  • YOUR_USERNAME with your Telegram username
  1. Add the bot to a supergroup and give it administrator rights
  2. Enjoy the bot!

Localization

It's possible to translate the bot to your own language. To do so, follow this steps:

  1. Download POEdit
  2. Open the file launcher.py.pot with POEdit
  3. Click on Create new translation and choose the desided language
  4. Translate each of the bot's sentence
  5. Save the file and place it inside locale, following the pattern of the locale\en folder
  6. Change the config.json file by replacing the language parameter to the name of the folder you just created on the step above
  7. Start the bot

Commands

This are the commands when using the English version of the bot. You can change them (or not) by translating the bot to your own language.

Command Permission Function Usage
/help All members show a help message /help
/trainer All members set your team and level /trainer initial letter/team name/color 30
/level All members update your level but only works after the /trainer command has already been used /level 31
/raid All members starts a new raid's list /raid pokémon,place,HH:MM
/edit All members change the time of a on going raid's list /edit raid's ID HH:MM
/editname All members change the name of a pokemon on goin raid's list /editname raid's ID pokemon
/cancel All members cancel a on going raid's list /cancel raid's ID
/end All members finish a on going raid's list /end raid's ID
/quest All members report a found quest /quest task,place,reward
/share All members send a raid's list or quest's report to another group so that both are automatically updated in the groups it was shared to /share q/r raid's/quest's ID
/comment All members add informations to a raid's list or quest's report /comment q/r raid's/quest's ID comment
/setraids Master only set the current available raids in the game /setraid pkmn_number,pkmn_number
/getraids Master only get the list of current available raids in the game /getraids
/gettrainers Master only get the list of users that have set their trainer's information /gettrainers