Code Monkey home page Code Monkey logo

thepokegobot's Introduction

ThePokeGOBot

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

Requirements

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. Rename the config_blank.json to config.json and edit it 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
  • 0 with your timezone (by default it's using GMT +0)
  1. Run the bot by using python launcher.py
  2. Set the available raids with /setraids command
  3. Add the bot to a supergroup and give it administrator rights
  4. Enjoy the bot!

Localization

Available languages

  • English
  • Brazilian Portuguese

Making your own translation

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 desired language
  4. Translate each of the bot's sentences
  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

These 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
/about All members show a message with info about the bot /about
/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 level/pokémon (pokédex number or name),place,HH:MM
/edit All members change the time and the Pokémon of a on going raid's list ** /edit raid's ID HH:MM Pokémon name
/cancel All members cancel a on going raid's list or delete a quest ** /cancel r/q raid's/quest'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 r/q raid's/quest's ID
/comment All members add informations to a raid's list or quest's report /comment r/q raid's/quest's ID comment
/setraids Master only set the current available raids in the game /setraids pokédex number or name, pokédex number or name
/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
/setlanguage Master only set the language of the bot /setlanguage language

** you must be the one who created it or the master's bot.

TODO

  • Only create raid's list with time in the future
  • Create raid's list by using the Pokémon Pokédex Number
  • Create raid's list for raids that are yet to hatch
  • Edit raid list's raid boss
  • Cancel quests

thepokegobot's People

Contributors

danielsguima avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.