PokemonGo-Bot

The Pokemon Go Bot, baking with community.

Project Chat

We use Slack as a web chat. Click here to join the chat!

Breaking Changes

You need modify config.json (config.json.example for example) then pokecli.py --config config.json

CI ERROR Need Help

Our CI check turn lots of lint error, please help to fix. Commit comment set to 'CI FIX, File: '

About dev/stable/master Branch

Dev branch has most up to date feature and even everyone handle the part well, still, will have broken changes. Your test contribute and PR for fix are warm welcome. Stable branch is better than dev branch. Setup with milestone tag.
Master branch is the thing you familiar.
No PR on stable/master branch to keep things easier.

Project Chat
Features
TODO List
Installation
- Requirements
- Mac
- Linux
- Windows
Develop PokemonGo-Bot
Usage
Docker Usage
FAQ
Credits
Donation

Features

Search Fort (Spin Pokestop)
Catch Pokemon
Release low cp pokemon
Walking as you
Limit the step to farm specific area for pokestops
Use the ball you have to catch, don't if you don't have
Rudimentary IV Functionality filter
Auto switch mode(Full of item then catch, no ball useable then farm)
Ignore certain pokemon filter
Use superior ball types when necessary
When out of normal pokeballs, use the next type of ball unless there are less than 10 of that type, in which case switch to farm mode
Drop items when bag is full (In Testing, Document contribute needed)
Pokemon catch filter (In Testing, Document contribute needed)
Google Map API key setup (Readme update needed)
Show all objects on map (In Testing)
Evolve pokemons (Code in, Need input, In Testing)

TODO List

Installation

Requirements (click each one for install guide)

Python 2.7.x
pip
git
virtualenv (Optional)
docker (Optional)
protobuf 3 (OS Dependent, see below)

Protobuf 3 installation

OS X: brew update && brew install --devel protobuf
Windows: Download protobuf 3.0: here and unzip bin/protoc.exe into a folder in your PATH.
Linux: apt-get install python-protobuf

Installation Linux

$ git clone -b master https://github.com/PokemonGoF/PokemonGo-Bot  
$ cd PokemonGo-Bot  
$ pip install -r requirements.txt

Installation Mac

$ git clone -b master https://github.com/PokemonGoF/PokemonGo-Bot  
$ cd PokemonGo-Bot  
$ virtualenv .  
$ source bin/activate  
$ pip install -r requirements.txt

Installation Windows

Windows Note

On Windows, you will need to install PyYaml through the installer and not through requirements.txt.

Windows 10: Go to this page and download: PyYAML-3.11-cp27-cp27m-win32.whl
(If running 64-bit python or if you get a 'not a supported wheel on this platform' error, download the 64 bit version instead: PyYAML-3.11-cp27-cp27m-win_amd64.whl )

$ cd download-directory
$ pip install PyYAML-3.11-cp27-cp27m-win32.whl
// (replace PyYAML-3.11-cp27-cp27m-win32.whl with PyYAML-3.11-cp27-cp27m-win_amd64.whl
// if you needed to download the 64-bit version)

Develop PokemonGo-Bot

$ git clone -b dev https://github.com/PokemonGoF/PokemonGo-Bot  
$ cd PokemonGo-Bot  
$ virtualenv .  
$ source bin/activate  
$ pip install -r requirements.txt

Google Maps API (in development)

Google Maps API: a brief guide to your own key

This project uses Google Maps. There's one map coupled with the project, but as it gets more popular we'll definitely hit the rate-limit making the map unusable. That said, here's how you can get your own and replace ours:

Navigate to this page
Select 'Create a project' in the dropdown menu.
Wait an eternity.
Click 'Create' on the next page (optionally, fill out the info)
Copy the API key that appears.
After the code done, will update here how to replace.

Usage

usage: pokecli.py [-h] -a AUTH_SERVICE -u USERNAME -p PASSWORD -l LOCATION [-lc] [-m] [-w] [--distance_unit] [--initial-transfer] [--maxsteps] [-iv] [-d] [-t]

optional arguments:
  -h, --help                                    show this help message and exit
  -a AUTH_SERVICE, --auth_service AUTH_SERVICE  Auth Service ('ptc' or 'google')
  -u USERNAME, --username USERNAME              Username
  -p PASSWORD, --password PASSWORD              Password
  -l LOCATION, --location LOCATION              Location (Address or 'xx.yyyy,zz.ttttt')
  -lc, --location_cache                         Bot will start at last known location
  -m MODE, --mode MODE                          Set farming Mode for the bot ('all', 'poke', 'farm')
  -w SPEED,  --walk SPEED                       Walk instead of teleport with given speed (meters per second max 4.16 because of walking end on 15km/h)
  -du, --distance_unit UNIT                     Set the unit to display distance in (e.g, km for kilometers, mi for miles, ft for feet)
  -it, --initial_transfer                       Transfer all duplicate pokemon with same ID on bot start, except pokemon with highest CP. Accepts a number to prevent transferring pokemon with a CP above the provided value.  Default is 0 (aka transfer none).
  -ms, --max_steps MAX_STEP                     Set the steps around your initial location (DEFAULT 5 mean 25 cells around your location)
  -iv IV, --pokemon_potential                   Set the ratio for the IV values to transfer (DEFAULT 0.4 eg. 0.4 will transfer a pokemon with IV 0.3)
  -if LIST, --item_filter LIST                  Pass a list of unwanted items to recycle when collected at a Pokestop (e.g, \"101,102,103,104\" to recycle potions when collected)"
  -d, --debug                                   Debug Mode
  -t, --test                                    Only parse the specified location

Command Line Example

Pokemon Trainer Club (PTC) account:
$ python2 pokecli.py -a ptc -u tejado -p 1234 --location "New York, Washington Square"
Google Account:
$ python2 pokecli.py -a google -u tejado -p 1234 --location "New York, Washington Square"

Advance Releasing Configuration

To edit the pokemon release configuration, copy file ``release_config.json.example`` and rename it to ``release_config.json``

Edit this file however you like, but keep in mind:

1. Pokemon name is always capitalize and case-sensitive
2. Be careful with the ``any`` configuration!

How to run with Docker

How to add/discover new API

The example is here
1. Check the type of your API request in POGOProtos For example: RECYCLE_INVENTORY_ITEM
2. Convert to the api call in pokemongo_bot/init.py, RECYCLE_INVENTORY_ITEM change to self.api.recycle_inventory_item def drop_item(self,item_id,count): self.api.recycle_inventory_item(...............) 3. Where is the param list?
You need check this Requests/Messages/RecycleInventoryItemMessage.proto 4. Then our final api call is
def drop_item(self,item_id,count): self.api.recycle_inventory_item(item_id=item_id,count=count) inventory_req = self.api.call() print(inventory_req)
5. You can now debug on the log to see if get what you need

How to set up a simple webserver with nginx

Nginx on Ubuntu 14.x, 16.x

1. Install nginx on your Ubuntu machine (e.g. on locally or AWS)

sudo apt-get update
sudo apt-get install nginx

2. Check the webserver

Check if the webserver is running by using your browser and entering the IP address of your local machine/server. On a local machine this would be http://127.0.0.1. On AWS this is your public DNS if you havent configured an elastic IP.

3. Change Base Directory of the Webserver

sudo nano "/etc/nginx/sites-enabled/default"

Comment out following line: root /var/www/html; and change it to the web folder of your PokemonGo-Bot: eg:

/home/user/dev/PokemonGo-Bot/web;

FAQ

What's IV ?

Here's the introduction

Does it run automatally?

Not yet, still need a trainer to train the script param. But we are very close to.

Set GEO Location

It works, use -l "xx.yyyy,zz.ttttt" to set lat long for location. -- diordache

Google login issues (Login Error, Server busy)?

Try to generate an app password and set is as

-p "<your-app-password>"

This error is mostly occurs for those who using 2 factor authentication but either way for the purpose of security would be nice to have a separate password for the bot app.

FLEE

The status code "3" corresponds to "Flee" - meaning your Pokemon has ran away. {"responses": { "CATCH_POKEMON": { "status": 3 } }

My pokemon are not showing up in my Pokedex?

Finish the tutorial on a smartphone. This will then allow everything to be visible.

How can I maximise my XP per hour?

Quick Tip: When using this script, use a Lucky egg to double the XP for 30 mins. You will level up much faster. A Lucky egg is obtained on level 9 and further on whilst leveling up. (from VipsForever via /r/pokemongodev)

How can I not collect certain pokemon

You don't want to collect common pokemon once you hit a certain level. It will slow down leveling but you won't fill up either.

Create the following filter

./data/catch-ignore.yml

Its a yaml file with a list of names so make it look like

ignore:
  - Pidgey
  - Rattata
  - Pidgeotto
  - Spearow
  - Ekans
  - Zubat

How do I use the map??

You can either view the map via opening the html file, or by serving it with SimpleHTTPServer (runs on localhost:8000)
To use SimpleHTTPServer:
$ python -m SimpleHTTPServer [port] The default port is 8080, you can change that by giving a port number. Anything above port 1000 does not require root. You will need to set your username(s) in the userdata.js file before opening:
Copy userdata.js.example to userdata.js and edit with your favorite text editor. put your username in the quotes instead of "username" If using multiple usernames format like this:
var users = ["username1","username2"];

Contributors (Don't forget add yours here when you create PR)

eggins -- The first pull request :)
crack00r
ethervoid
Bashin
tstumm
TheGoldenXY
Reaver01
rarshonsky
earthchie
haykuro
05-032
sinistance
CapCap
mzupan
gnekic(GeXx)
Shoh
luizperes
brantje
VirtualSatai
dmateusp
jtdroste
msoedov
Grace
Calcyfer
asaf400
guyz
DavidK1m
budi-khoirudin
riberod07

Credits

tejado many thanks for the API
Mila432 for the login secrets
elliottcarlson for the Google Auth PR
AeonLucid for improved protos
AHAAAAAAA for parts of the s2sphere stuff

Donation

Bitcoin Address: 1PJMCx9NNQRasQYaa4MMff9yyNFffhHgLu