Basic Installation

These instructions cover an instation from a release as well as from a git clone.


Follow one of the guides below to get the basic prerequisites installed:


  • You’ll need an active Pokemon Trainer Club account or Google account
  • Get a Google Maps Key

Downloading the Application

You have an important decision here, you may either download a “release” or use git to fetch the latest development version. The release versions tend to be more stable and require less technical install steps, but they will have fewer features.

Release Version

If you want to run a release version, visit the Github releases page and download and extract the release you want to run

git Version

If you’re going to run a copy from the latest develop branch in git you can clone the repository:

git clone

Installing Modules

At this point you should have the following:

  • Python 2.7
  • pip
  • PokemonGo-Map application folder

First, open up your shell (cmd.exe/ and change to the directory of PokemonGo-Map.

You can verify your installation like this:

python --version
pip --version

The output should look something like:

$ python --version
Python 2.7.12
$ pip --version
pip 8.1.2 from /usr/local/lib/python2.7/site-packages (python 2.7)

Now you can install all the Python dependencies, make sure you’re still in the directory of PokemonGo-Map:


pip install -r requirements.txt


sudo -H pip install -r requirements.txt

git Version Extra Steps


This only applies if you are running from a git clone. If you are using a release version, skip this section

In order to run from a git clone, you must compile the front-end assets with node. Make sure you have node installed for your platform:

Once node/npm is installed, open a command window and validation your install:

node --version
npm --version

The output should look something like:

$ node --version
$ npm --version

Once node/npm is installed, you can install the node dependencies and build the front-end assets:

npm install

# The assets should automatically build (you'd see something about "grunt build")
# If that doesn't happen, you can directly run the build process:
npm run build

Basic Launching

Once those have run, you should be able to start using the application, make sure you’re in the directory of PokemonGo-Map then:

python ./ --help

Read through the available options and set all the required CLI flags to start your own server. At a minimum you will need to provide a location, account login credentials, and a google maps key.

The most basic config you could use would look something like this:

python ./ -a ptc -u "USERNAME_HERE" -p "PASSWORD_HERE" \
 -l "a street address or lat/lng coords here" -st 3 -k "maps key here"

Open your browser to http://localhost:5000 and your pokemon will begin to show up! Happy hunting!

Updating the Application

PokemonGo-Map is a very active project and updates often. You can follow the latest changes to see what’s changing.

If you are running a release version, you can simply start this tutorial over again with a new download.

If you are running a git version, you can update with a few quick commands:

git pull
pip install -r requirements.txt --upgrade
npm install
npm run build

You can now restart your command.