Welcome to RocketMap’s Documentation!¶

Adding or Editing Pages¶

A few guidelines to help keep things clean and organized...

Keep filenames short and to the point, for example: installation.rst

Always begin your new page with a title:

Awesome Wiki Page
################

Titles will be shown at the top of a page and in the site navigation. A title should describe a page in a glance. The rest of the file is written in ReST or Markdown structured text. Here is a cheatsheet for RST formatting, and one for markdown.

Once done editing your page, add it under one of the toctree sections in index.rst.

Now to preview your changes, open a terminal, go into the docs directory and use make clean-auto auto. This will start a local webserver with live updates pages as you save them.

Finally, when you are finished, submit your changes as a Pull Request to be reviewed.

Node and Grunt¶

Grunt is a tool to automatically run tasks against the code. We use grunt to transform the Javascript and CSS before it’s run, and bundle it up for distribution.

If you want to change the Javascript or CSS, you must install and run Grunt to see your changes

npm run watch

npm run build

The “/dist” directory¶

Files in the “static/dist/” subdirectories should not be edited. These will be automatically overwritten by Grunt.

To make your changes you want to edit e.g. static/js/map.js

Prerequisites¶

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

• OSX Prerequisites
• Windows Prerequisites
• Linux Install

Credentials¶

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

Downloading the Application¶

To run a copy from the latest develop branch in git you can clone the repository:

git clone https://github.com/RocketMap/RocketMap.git

Installing Modules¶

At this point you should have the following:

• Python 2.7
• pip
• RocketMap application folder

First, open up your shell (cmd.exe/terminal.app) and change to the directory of RocketMap.

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 RocketMap:

Windows:

pip install -r requirements.txt

Linux/OSX:

sudo -H pip install -r requirements.txt

node --version
npm --version

$ node --version
v4.7.0
$ npm --version
3.8.9

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 RocketMap then:

python ./runserver.py --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 ./runserver.py -ac accounts.csv -tut -st 10 \
-l "a street address or lat/lng coords here" -k "MAPS_KEY_HERE" \
-hk "HASH_KEY_HERE" -cs -ck "CAPTCHA_KEY"

Let’s run through this startup command to make sure you understand what flags are being set.

• -ac accounts.csv

Load accounts from CSV (Comma Seperated Values) file containing “auth_service,username,password” lines. More Info

• -tut

Complete ToS and tutorial steps on accounts if they haven’t already. More Info

• -hk “HASH_KEY_HERE”

Key used to access the hash server. More Info

• -cs -ck “CAPTCHA_KEY”

Enables captcha solving and 2Captcha API key. (Manual captcha available, see Full Info )

Once your setup is running, open your browser to http://localhost:5000 and your pokemon will begin to show up! Happy hunting!

Things to Know¶

• You may want to use more than one account to scan with RocketMap. Here is how to use as many accounts as your heart desires.
• Your accounts need to complete the tutorial before they will be any use to RocketMap! Here is how do that with RM.
• You might experience your accounts encountering Captchas at some point. Here is how we handle those.
• Due to recent updates, you might experience a shaddow ban. Here is what you need to know.
• All of these flags can be set inside of a configuration file to avoid clutter in the command line. Go here to see how.
• A full list of all commands are available here.
• A few tools to help you along the way are located here.

Updating the Application¶

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

You can update with a few quick commands:

git pull
pip install -r requirements.txt --upgrade (Prepend sudo -H on Linux)
npm run build

Watch the latest changes on Discord to know when updating will require commands other than above.

IMPORTANT Some updates will include database changes that run on first startup. You should run only one runserver.py command until you are certain that the DB has been updated. You will know almost immediately that your DB needs updating if Detected database version x, updating to x is printed in the console. This can take a while so please be patient. Once it’s done, you can start all your instances like you normally would.

Prerequisites¶

• git for windows
• Python 2.7.1.2
• Microsoft Visual C++ Compiler for Python 2.7

Step 1: Install Git for Windows¶

Download Git for Windows from the link above and install it. You will be fine with all recommended options during the setup.

Step 2: Install Python¶

Note: If you already have another version of Python installed, you probably want to uninstall that version and install the latest 2.7.x version.

Download the latest Python 2.7.x version either as the 64 bit or the 32 bit version from the link above. Make sure to add Python to PATH during the setup (see screenshot)!

You may run into issues running python if you do not install it onto your primary partition (typically c:)

Optional: Fix Python Path¶

This step is not needed on every system, but it’s probably good to check if everything is set up correctly.

First things first. Press Windows Key + PAUSE on your keyboard and select Advanced System Settings from the left side menu. At the bottom of that windows click Environment Variables. In my case the Python value for the Path variable was set to C:\Python27\; which is wrong. You have to remove final backslash if that’s the case for you too. If you’re having issues with this feel free to open an Issue.

Step 3: Install C++ Compiler for Python¶

Download the Visual C++ Compiler for Python from the link above and install it. There is no changes required other than accepting the terms.

All set, head back to the basic install guide.

Prerequisites for this guide¶

• Mac OSX 10.9+
• Homebrew for Mac

Step 1: Install Homebrew¶

Follow the install instructions at http://brew.sh/ to get Homebrew installed

Step 2: Install Project Requirements¶

brew install git python protobuf

All set, head back to the basic install guide.

Ubuntu¶

You can install the required packages on Ubuntu by running the following command:

sudo apt-get install -y python python-pip python-dev build-essential git
curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
sudo apt-get install -y nodejs

Debian 7/8¶

Debian’s sources lists are out of date and will not fetch the correct versions of Python and PIP. You must download and install these from source:

sudo apt-get install -y build-essential libbz2-dev libsqlite3-dev libreadline-dev zlib1g-dev libncurses5-dev libssl-dev libgdbm-dev python-dev nodejs npm
wget https://www.python.org/ftp/python/2.7.12/Python-2.7.12.tgz
tar xzf Python-2.7.12.tgz && cd Python-2.7.12
./configure --prefix=/opt/python
make
sudo make install
ln -s /opt/python/bin/python2.7 /usr/local/bin/python2.7
ln -s /opt/python/bin/python2.7 /usr/bin/python2.7
ln -s /usr/bin/python2.7 /usr/bin/python
ln -s /usr/local/bin/python2.7 /usr/local/bin/python
ln -s /opt/python/bin/pip /usr/bin/pip
ln -s /opt/python/bin/pip /usr/local/bin/pip
ln -s /usr/bin/nodejs /usr/bin/node
sed -e '$a\PATH="$PATH:/opt/python/bin"\' ~/.profile
source ~/.profile
wget https://bootstrap.pypa.io/get-pip.py
python get-pip.py

After install, check that you have the correct versions in your environment variables:

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

If your output looks as above, you can proceed with installation:

cd ~/
sudo apt-get install git
git clone https://github.com/RocketMap/RocketMap.git
cd RocketMap
sudo -H pip install -r requirements.txt
npm install
sudo npm install -g grunt-cli
sudo grunt build

Troubleshooting:¶

If you have preciously installed pip packages before following this guide, you may need to remove them before installing:

pip freeze | xargs pip uninstall -y

If you have other pip installed packages, the old requirements.txt and cannot uninstall all then you can use:

pip uninstall -r "old requirements.txt"
pip install -r "new requirements.txt"

An error resulting from not removing previous packages can be:

016-12-29 00:50:37,560 [ search-worker-1][        search][    INFO] Searching at xxxxxxx,xxxxxxx
2016-12-29 00:50:37,575 [ search-worker-1][        search][ WARNING] Exception while downloading map:
2016-12-29 00:50:37,575 [ search-worker-1][        search][   ERROR] Invalid response at xxxxxxx,xxxxxxx, abandoning location

If you’re getting the following error:

root:~/RocketMap# ./runserver.py
Traceback (most recent call last):
        File "./runserver.py", line 10, in <module>
        import requests
ImportError: No module named requests

You will need to completely uninstall all of your pip packages, pip, and python, then re-install from source again. Something from your previous installation is still hanging around.

Debian 7¶

Additional steps are required to get Debian 7 (wheezy) working. You’ll need to update from glibc to eglibc

Edit your /etc/apt/sources.list file and add the following line:

deb http://ftp.debian.org/debian sid main

Then install the packages for eglibc:

sudo apt-get update
apt-get -t sid install libc6-amd64 libc6-dev libc6-dbg
reboot

Red Hat or CentOs or Fedora¶

You can install required packages on Red Hat by running the following command:

You may also need to install the EPEL repository to install python-pip and python-devel.

yum install epel-release
yum install python python-pip python-devel

Fedora Server:
dnf install python
dnf install redhat-rpm-config // fix for error: command 'gcc' failed with exit status 1

All set, head back to the basic install guide.

Getting the API Key¶

1. Go to Google API Console

2. If it’s the first time, click ‘Next’ on a bunch of pop-ups or just click somewhere where the pop-ups aren’t

3. Create Credentials

   

   • Select a project: Create a project
   • Project name: Anything you want
   • Yes/No for email
   • Yes to agree to ToS
   • Click create.

4. Get your API Key

   • Click on Credentials again
   • Click Create -> API
   • Choose ‘Browser Key’
   • Click ‘Create’ and then copy the API Key somewhere

5. Enable three Google Maps APIs

   • Google Maps Javascript API - Enables Displaying of Map
     • Click on ‘Library’
     • Click on Google Maps Javascript API
     • Click ‘ENABLE’
   • Google Places API Web Service - Enables Location Searching
     • Click on ‘Library’
     • Type ‘Places’ into the search box ‘ Search all 100+ APIs’
     • Choose Google Places API Web Service
     • Click ‘ENABLE’
   • Google Maps Elevation API - Enables fetching of altitude
     • Click on ‘Library’
     • Type ‘Elevation’ into the search box ‘ Search all 100+ APIs’
     • Choose Google Maps Elevation API
     • Click ‘ENABLE’

Using the API Key¶

The google maps api key may either be installed in config/config.ini file, or you can provide it as a command line parameter like -k 'your key here'

As of May 21st 2017, Niantic has implemented a new kind of ban. This ban will hide rare pokemon and other features within the Pokemon Go app when using an account that is blind.¶

What do we know?¶

Accounts are automattically banned based on specific behaviors known to mappers and botters. While RocketMap is working on a full scale solution, this a guide of what we know.

• New accounts work for 60 to 140 hours (depending on config).
• Blinded accounts can get unblinded after 6 to 10 days.
• Reusing unblinded accounts in any 3rd party app (including RM) will get them blinded again faster than before (sometimes in just a few hours).
• If you buy accounts to scan, do so at your own risk. These have often been getting blinded in a matter of a few hours (~4h), most likely because they had already been flagged before.
• Once flagged, the blinding is inevitable.
• All 3rd party apps/scanners are affected in the exact same manner. We’ve spent extra time to confirm this because some people were pretty convinced we were wrong, although it usually ended up being because they hadn’t even realized their accounts were already blind.
• There is NO recommended way to test accounts for blindness. The current 3rd party implementations are incorrect and could get your accounts flagged if they weren’t already. This is a WIP and is being added to RM itself.

What can I do?¶

Right now, here are 3 approaches for your configs to maximize the scan time per account. Results depend on a lot of things, so test and experiment for yourself until you find what works best for you:

1. Burn through accounts: no sleep, no account rotation. For some whose accounts usually get flagged very early on, this will increase the scan time of the account.
2. Use a basic constant rotation: e.g. asi 8h (8h of scanning) for ari 4h (4 hours of sleep).
3. Use more realistic scan times: low asi and high ari (scan in bursts: short period of scanning for a realistic resting time), or low asi and low ari (what you would call “not too active players”) but use enough spare accounts to fill 24 hours with realistic schedules for all accounts.

The ideal will depend on your own results, we’ve found that all three approaches had positive effects for at least one testing setup. A person who needs #1 will be the direct opposite of someone running #3, but both are equally valid.

UPDATE spawnpoint SET missed_count = 0;

Automatic Mode (2captcha)¶

RocketMap can request tokens for captcha solving from an external service, allowing captchas to be solved “on-the-fly” - meaning that once an account encounters a captcha it immediately starts the uncaptcha process.

If you want to enable this behavior you need to specify:

• Enable captcha solving: -cs / --captcha-solving
• 2captcha API key: -ck / --captcha-key

Enabling Manual/Hybrid Captcha Solving:¶

You can setup RocketMap to enable manual captcha solving. This feature uses common web browsers to let users rescue captcha’d accounts. We use a JavaScript bookmarklet that triggers a captcha which allows the user to solve it in its web browser. The result is then forwarded to the RocketMap instance running at the URL specified by -mcd.

Please remember that if you want your map to be accessed from the exterior you need to setup --host and --manual-captcha-domain to something like http://<your-ip>:<port> or http://<your-domain>:<port>.

In order to enable manual captcha solving we need the following parameters:

• Enable captcha solving: -cs / --captcha-solving
• Manual captcha domain: -mcd / --manual-captcha-domain
• Provide a status name: -sn / --status-name

Hybrid Mode¶

RocketMap also allows an hybrid mode for captcha solving.

This works by first putting the account aside and waiting for manual captcha solve. After x seconds you can force the captcha to be solved by the automatic method (2captcha).

To enable this behavior you need to specify:

• Enable captcha solving: -cs / --captcha-solving
• 2captcha API key: -ck / --captcha-key
• Manual captcha timeout: -mct 1800 / -manual-captcha-timeout 1800

The number 1800 indicates how many seconds you want the accounts to wait for manual tokens before resorting to the automatic method (a.k.a. 2captcha).

• Provide a status name: -sn / --status-name

By default --manual-captcha-timeout is set to 0 which disables hybrid mode and only automatic captcha solve will be used. If you provide --captcha-key and wish to enable hybrid mode then, --manual-captcha-timeout needs to be greater than 0.

status-name: My Server 1
captcha-solving: True
captcha-key: <2Captcha API Key>
manual-captcha-domain: http://<mydomain.com>:<port>
manual-captcha-timeout: 1800

Default file¶

The default configuration file is config/config.ini underneath the project home. However, this location can be changed by setting the environment variable POGOMAP_CONFIG or using the -cf or –config flag on the command line. In the event that both the environment variable and the command line argument exists, the command line value will take precedence. Note that all relative pathnames are relative to the current working directory (often, but not necessarily where runserver.py is located).

Setting configuration key/value pairs¶

For command line values that take a single value they can be specified as:

keyname: value
e.g.   host: 0.0.0.0

For parameters that may be repeated:

keyname: [ value1, value2, ...]
e.g.   username: [ randomjoe, bonnieclyde ]

*for usernames and passwords, the first username must correspond to the first password, and so on *

For command line arguments that take no parameters:

keyname: True
e.g.   fixed-location: True

Example config file¶

  auth-service: ptc
  username: [ username1, username2 ]
  password: [ password1, password2 ]
  location: seattle, wa
  step-limit: 5
  gmaps-key: MyGmapsKeyGoesHereSomeLongString
  hash-kay: MyHashingKeyGoesHere
  print-status: "status"
  speed-scan: True

Running this config file as:

 python runserver.py -cf myconfig.seattle

would be the same as running with the following command line:

 python runserver.py -u randomjoe -p password1 -u bob -p password2 -l "seattle, wa" -st 5 -k MyGmapsKeyGoesHereSomeLongString -ps

Running multiple configs¶

One common way of running multiple locations is to use two configuration files each with common or default database values, but with different location specs. The first configuration running as both a scanner and a server, and in the second configuration file, use the no-server flag to not start the web interface for the second configuration. In the config file, this would mean including a line like:

no-server: True

What are hashing keys for?¶

Hashing keys allow your client program (in this case RocketMap) to access the latest API using the Bossland Hashing service. It is no longer possible to access the API without a hashing key.

Where do I get a hashing key?¶

Check out this FAQ

How many RPMs will I use?¶

There is no perfect way to know. There are many variables that must be considered, including your step size, spawn spoints, encounters.

Please don’t ask “What if my step size is x, and I have encounters for y Pokemon” We still don’t know. Get a key, turn on your map and see if it works.

If you are getting rate limited then either get more keys, or lower your calls (disabling/reducing encounters, disabling gym details, and decreasing step size are a few ways to reduce calls)

You can get a more detailed view of how many Hashing key calls are being used by enabling the status view -ps / --print-status and typing h followed by the enter key OR go to <YourMapUrl>/status and enter the password you defined. The status of each of your workers and hashing keys will be displayed and continually updated. More information about the status page

Common Questions¶

HashingQuotaExceededException('429: Request limited, error: ',)

Hashing server is unreachable, it might be offline.

Invalid or expired hashing key: %s. + api._hash_server_token

TempHashingBanException('Your IP was temporarily banned for sending too many requests with invalid keys',)

Using Command Line Arguments:¶

To use multiple accounts when running from the command line, you must specify multiple -u and -p values.

Example: python runserver.py -a ptc -u thunderfox01 -u thunderfox02 -p thunderfox01 -p thunderfox02

If you have multiple accounts with the same password, you can specify one -p value. RocketMap will use the value for all specified accounts.

Example: python runserver.py -a ptc -u thunderfox01 -u thunderfox02 -p thunderfox

If you have multiple accounts with different auth services, you can specify multiple -a values.

Example: python runserver.py -a ptc -a ptc -a google -u thunderfox01 -u thunderfox02 -u thunderfox03@gmail.com -p thunderfox01 -p thunderfox02 -p thunderfox03

Using config.ini¶

To use multiple accounts with config.ini, you must surround all the accounts and passwords in brackets [] and seperate them with a comma and space.

Example:

auth-service: ptc
username: [thunderfox01, thunderfox02]
password: [password01, password02]

If you have multiple accounts with the same password, you can specify one password value similar to the command line.

Example:

auth-service: ptc
username: [thunderfox01, thunderfox02]
password: password

If you have multiple accounts using Google and PTC, you can specify auth-service for each account.

Example:

auth-service: [ptc, ptc, google]
username: [thunderfox01, thunderfox02, thunderfox03@gmail.com]
password: [password01, password02, password03]

Using CSV file:¶

To use multiple accounts from a CSV file, you create a CSV file with the auth method, username and password on each line. Shorten to 3 fields only, more than 3 fields will error out.

CSV File Example:

ptc,thunderfox01,password01
google,thunderfox02@gmail.com,password02

Example: python runserver.py -ac accounts.csv

RocketMap’s tutorial completion for new accounts (includes getting accounts to level 2.)¶

This is a guide on how to complete the Pokémon Go tutorial steps and becoming level 2 on your accounts as fast as possible, so you can use -tut once on all accounts and disable it again afterwards.

Instruction¶

• We assume you are running a basic RocketMap installation. Using the hashing service with the latest API version will avoid accounts being flagged.
• Create a config/config.tutorial.ini file by copying and renaming config/config.ini.example and make the following changes:
• Config changes are:
  • Set location next to at least one known Pokestop, a cluster is preferred.
  • Set step distance to st: 1.
  • Set scan delay sd to a value which provides enough calls during the following set search time (a good value is around sd: 15 or lower).
  • Set the account search interval to approx. asi: 120.
  • Set the account rest interval as high as possible so all accounts get cycled and none return, a safe value is ari: 36000.
  • Set login delay to at least login-delay: 1 to avoid throttling.
• Put the accounts that need to complete the tutorial and need to level up into your accounts.csv file.
• Set up an instance with the following flags:
  • --complete-tutorial or just -tut
  • --config config/config.tutorial.ini or just -cf config/config.tutorial.ini to use a designated config file.
  • --accountcsv PATH/accounts.csv or just -ac PATH/accounts.csv
  • -w WORKER to set your simultaneously working accounts to a reasonable number, considering hash key limit and throttling. You can have at least 10 accounts running at the same time without any problems.
• If you are not using fresh accounts and you are not using the hashing service, prepare for captchas. Set up your RocketMap accordingly.
• Enable -v in process if you want to see the debug logs.
• Let it run and your accounts will complete the tutorial and rise to level 2.

What’s wrong:¶

Windows defines commands in something called “environment variables”, if a program isn’t here, Windows doesn’t know where to find what you’re asking for.

How to solve this:¶

If you install python, it can automatically set the correct environment variables. However, if you didn’t enable this feature, you need to do it manually.

How to set them manually:¶

Step 1] Press the Windows Key + Pause/Break (Or right click on “This PC” and select properties)

Step 2] Click on “Advanced system settings”, a new window will appear. Now click “Environment Variables”

Step 3] Another window will pop up, now find “Path” and click “Edit...”, then another window will pop up.

Step 4] Hit “New” and enter “C:\Python27”, hit “New” again and now enter “C:\Python27\Scripts”

Step 5] Close all windows by pressing “OK” and restart the command prompt, now everything should be working fine!

Credit: Langoor2

Should I use this as a way to make money?¶

No, it is gross to charge people for maps when the information should be provided by Niantic! We do not endorse paid maps, which is why this platform is opensource.

What do the spawn point colors mean?¶

• A grey dot represents a spawn point that is more than 5 minutes from spawning.
• A light blue dot represents a spawn point that will spawn in 5 minutes. Light blue changes to dark blue and finally into purple just before spawn time.
• A green dot represents a fresh spawn. This will transition to yellow, through orange and finally red (like a stop light) as it is about to despawn.

All I see are numbers! Where are the pokemon?¶

You are missing the sprite files. Please consult #faq on the RocketMap Discord.

Lures are 6 hours right now! Why is it saying they have already expired?¶

You need to add -ldur 360 to change the lure assumption to 6 hours (360 minutes.)

Can I sign in with Google?¶

Yes you can! Pass the flag -a google (replacing -a ptc) to use Google authentication.

If you happen to have 2-step verification enabled for your Google account you will need to supply an app password for your password instead of your normal login password.

Which is the best scan option to use to find pokemon?¶

SpeedScan (-speed) is the most used scheduler: it’s the only scheduler that currently supports finding the proper spawnpoint time and duration, and it also features a built-in speed limiter to avoid speed violations (i.e. softbans).

More information can be found here : Speed Scheduler

But I was happy using the default Hex or -ss...¶

Speed Scheduler combines both and is more efficient, -ss is not being actively maintained and doesn’t work unless you already have spawnpoints and timers exported.

All pokemon disappear after only 1 minute, the map is broken!¶

One of Niantic’s updates removed spawn timers from Pokémon (until there’s little time left until they despawn). SpeedScan does an initial scan to determine all spawn points and their timers and automatically transitions into spawn scanning once it found them all. Seeing 1-minute timers during initial scan is perfectly normal.

What’s the simplest command to start the map scanning?¶

./runserver.py -speed -l LOCATION -a GOOGLE/PTC -u USER -p PASS -k GOOGLEKEY -hk HASHINGHEY You must replace the values for GOOGLE,PTC/LOCATION/USER/PASS/GOOGLEKEY/HASHINGKEY with your information.

Nice, what other stuff can I use in the command line?¶

There is a list here or a more up to date list can be found by running ./runserver.py -h

Woah I added a ton of cool stuff and now my command line is massive, any way to shorten it?¶

It is a lot simplier to use a config file

Can I scan for free or do I need to pay for a hashing key?¶

Using a hashing key is mandatory at this point. The API will not function without an active hashing key from Bossland. More Informatiion about Hashing Keys

Is there anything I can do to lower captchas?¶

Yes, you can run with -tut to level your workers to level two (spinning a single pokéstop), this reduces captchas a lot. You may also consider scanning a smaller area, using less workers or encountering less pokemon for IV.

How many workers do I need?¶

There is no simple answer to this, it all depends on your -st and more importantly how spawn dense that location is.For a rough guide you can use the formulas at the bottom of this page.

example.py isn’t working right!¶

Seb deleted it, it was the only good thing left in our lives. Seb has murdered us all.

I have problems with my database because......¶

RocketMap uses SQLite which doesn’t support real concurrency, so you’re limited directly by the read/write speed of your drive and you’re hoping that nothing happens concurrently (otherwise it breaks).

Higher threads or extra workers = increased odds of SQLite locking up. sqlite also has a very low limit of number of variables that can be used in a single query, which breaks support for medium or large sized maps.

You need MySQL if you want a proper database.

How do I setup port forwarding?¶

See this helpful guide

I edited my files/installed unfinished code and messed up, will you help me fix it?¶

No, the best course of action is to delete it all and start again, this time don’t edit files unless you know what you are doing.

I used a PR and now everything is messed up! HELP ME!¶

No, remove everything and start from scratch. A Pull Request is merged when it meets the standards of the project.

“It’s acting like the location flag is missing.”¶

-l, never forget.

I overridden watchdog and now all my accounts are flagged/banned.¶

Good Job! We recommend making new accounts. Current Tools are Here!

I’m getting this error...¶

pip or python is not recognized as an internal or external command

Python/pip has not been added to the environment

Exception, e <- Invalid syntax.

This error is caused by Python 3. The project requires python 2.7

error: command 'gcc' failed with exit status 1

# - or -

[...]failed with error code 1 in /tmp/pip-build-k3oWzv/pycryptodomex/

Your OS is missing the gcc compiler library. For Debian, run apt-get install build-essentials. For Red Hat, run yum groupinstall 'Development Tools'

cells = map_dict['responses']['GET_MAP_OBJECTS']['map_cells']

KeyError: 'map_cells'

The account is banned or hasn’t completed the tutorial.

InternalError(1054, u"unknown column 'cp' in 'field list'") or similar

Only one instance can run when the database is being modified or upgraded. Run ONE instance of RM with -cd to wipe your database, then run ONE instance of RM (without -cd) to setup your database.

ValueError: Exceeded maximum connections.

Try raising –db-max_connections, default is 5.

OperationalError(1040, u'Too many connections')

You need to raise the maximum connections allowed on your MySQL server configuration, this is typically by setting max_connections in my.cnf or my.ini. Please use Google to find where this file is located on your specific operating system.

OperationalError: too many SQL variables

Due to SQLite supporting only a small amount of variables in a single query, you will need to use MySQL as you are above said limit. This is typically due to the adding of more workers/area to your map.

I have more questions!¶

Please read all wiki pages relating to the specific function you are questioning. If it does not answer your question, join us on the RocketMap Discord. Before asking questions in #help on Discord, make sure you’ve read #announcements and #faq.

Formulas?¶

st=step distancesd=scan delay [default: 10]w=# of workerst=desired scan time

Features¶

• Limit speed according to default of 35 kph or by setting -kph
• Do an initial scan of the full area, then automatically switch to tracking down the exact spawn time (finding the TTH) and only scan for spawns (an -ss like behaviour).
• Add spawn point type identification of the three current types of spawn points – 15, 30, and 60 minute spawns.
• Change spawn point scans to correct spawn time according to spawnpoint type
• Add scans to complete identification for partially identified spawn points
• Dynamically identify and check duration of new spawn points without requiring return to Hex scanning
• Identify spawn points that have been removed and stop scanning them

To use Speed Scheduler, always put -speed in the command line or set speed-scan in your config file.

Commands and configs¶

What command line args should I use for Speed Scheduler?

Here’s an example: runserver.py -speed -st 25 -w 100 -ac accounts.csv

How big should I make my -st?

Speed Scheduler works best with -st larger than 20. For smaller -st, more instances will be required to handle a large area, and the workers will not be able to help each other because they are walled off into separate instances.

What should I set scan delay (-sd) to?

With the default speed limit of 35 kph, scan delay isn’t needed. It takes about 12 seconds to get to a neighboring location, which is sufficient delay. If you include an -sd lower than 12 seconds, it won’t have an effect. If you use a -sd higher than 12, it will decrease the amount of scans your workers can do.

Is there a different command line option to tell Speed Scheduler to do an initial scan or to do -ss (spawnpoint based scanning)?

Speed workers are independent and look for the best scans they reach under the speed limit. The priority is initial scans, TTH, and then spawns. If a worker can not reach an initial scan under the speed limit, it will do a TTH search. If it can’t do an initial scan or a TTH search, it will scan for new pokemon spawns, so all workers are always doing their best to find pokemon. Always put -speed in the command line or set speed-scan in your config file.

Does Speed Scheduler work with beehives (-bh argument)?

Yes, although before using beehives, it’s first recommended to use larger -st. The logic of Speed Scheduler scheduler works with the beehives, but the strength of Speed Scheduler is it’s ability to have multiple workers in a single hive working together to cover the closest spawns. If the area you have to cover is so large (> -st 50?) that CPU load is becoming an issue, then using -bh in combination with -wph (–workers_per_hive) to set more workers per hive may be helpful.

Does Speed Scheduler work with no-jitter (-nj)?

Yes. Jitter adjusts only the location sent to the API, not the location used internally, so Speed Scheduler can still recognize the location.

Does Speed Scheduler work with spawn point json lists?

No. I’m not aware of a method to populate the Spawnpoint DB table with a JSON list. Writing and testing and publishing such a method left as an exercise for the reader.

You mean I will need to do an initial scan again? Oh, the captchas! Oh, the humanity!

I feel your pain. At least I can tell you that Speed Scheduler will do the initial scan and find the TTHs with less scans than any other Scheduler. Hex Scheduler would take 60 scans to find spawn points and TTH, whereas Speed Scheduler will only take 5 scans per location to find the spawn points, and perhaps another 5 scans to find the TTH per spawn point, so it’s about one fifth of the scans other schedulers require.

General¶

How long does the initial scan take?

With sufficient workers, the initial scan to find all the spawnpoints should be completed in a little over an hour.

I’m doing the initial scan, and the spawns have a duration under 1 minute. Why?

Speed Scheduler doesn’t make assumptions about how long the spawns are, so when it first sees a spawn, if there’s no TTH, all it can say is that the spawn will be there for at least 60 seconds. After the initial scan is done, durations will be longer.

How does Speed Scheduler find the time_til_hidden or TTH?

At the last minute or so of a Pokemon spawn, the servers include a time stamp of when the pokemon will disappear, called the time_til_hidden (TTH). Until the TTH is found, spawns are scanned twice – once when they first spawn and again at the end of their spawn window to find the time_til_hidden and get the exact spawn time. Speed Scheduler searches for the TTH by doing a search between the last seen time and 15 minutes after. If the spawn isn’t there at this time, it searches again between that last seen time and earliest unseen time. Next check is between those times again, and so on. This reduces the time where the TTH could be by about half every search, so it should find the TTH within five or so searches.

Speed Scheduler has been running for days, but the TTH found is still about 99%. Why doesn’t it find 100% of the TTH?

There appear to be some rare spawns that are not simple 15, 30, or 60 minute spawns. These spawns may have hidden times or not end with a TTH period. Also, as the possible window for where the TTH could be gets smaller, the time for a worker to scan that location also becomes smaller, so it takes longer to hit the window and find the TTH.

Does Speed Scheduler still find new spawns even if TTH complete is less than 100%?

Yes. For the few spawns where the TTH still hasn’t been found, there is usually only a few minutes when it could be, so Speed Scheduler still queues those new spawns and is probably only late to scan them by a minute or two.

How many workers will I need for the initial scan?

Here’s a rough formula for how many workers:

Workers = Cells / 20 Cells = (((steps * (steps - 1)) * 3) + 1)

With -st 26, you will have 1951 cells and need about 98 workers.

To do the initial scan in an hour so, at -kph 35, it takes about half a minute to get to a the next location to scan, and you will want to be able to scan all cells in about 10 minutes, so the workers Cells / 20. If you reduce the -kph from 35 by half, increase the workers by double.

How many workers will I need after the initial scan is done?

This will depend on the spawn density of your area. If the Spawns Reached percentage is 100%, you should be able to reduce the number of workers.

What if I don’t have enough workers?

Speed Scheduler will work with less workers, although it will take longer than an hour for the initial scan and may take a while raise the TTH found percent.

Does this work with beehive instances?

Unless scanning a very large area (> -st 50?), Speed Scheduler does not require beehives. Each worker independently looks for the best scan it can do closest to it, so they work well together without fencing off workers into different hives.

Can I run multiple instances with Speed Scheduler with one DB?

Yes.

Can the instances overlap?

Yes.

How does it find the spawn points without having data from a Hex Scan?

Magic. This is covered in more detail in my initial PR#1386

What happens when it finds a new spawn point after the initial scan is done?

If a spawn point is noticed while scanning other spawnpoints, that scan location alone is reset and fully scanned to find the spawn point duration and exact spawn time.

How does it handle spawn points disappearing?

After a spawn point is not seen as expected over five times in a row, it stops scheduling scans for that spawnpoint. The data remains in the DB.

How does it handle web changes in the search location?

For changing the location of the searcher, this should work, but with lots of rescanning of the initial scan. Each time you change the location of the server, Speed Scheduler will restart its initial scan. Since Speed Scheduler records data about each search location, it is sensitive to changes in the location, and has to start over with the initial scan every time it is changed. This is true even if you move back to an already scanned location, but the loc is only slightly different.

Is the speed limit also used when changing the scanner location?

Yes. Each worker remembers it’s last scan location and time, so if the scanner is moved, it will take the workers time to get to the new location.

Print Screen, Status Page, and Log Messages¶

I’m seeing a lot of “[ WARNING] Nothing on nearby_pokemons or wild. Speed violation?” in the log. What could cause this?

Common causes:

• Not using -speed as an argument. Other schedulers ignore the -kph argument.
• If the DB worker table has been recently deleted and the script restarted, such as with -cd (clear DB) option, the old position of the workers is forgotten, so they may violate the speed limit.
• There aren’t any pokemon nearby. In areas over water or without pokemon spawns in 200m, these messages may be common. This is just a warning, and the data for that position is recorded normally.

I’m seeing a lot of “[ WARNING] Bad scan. Parsing found 0/0/0 pokemons/pokestops/gyms”

Common causes:

• captchas
• IP bans
• Running Pogo-map with –no-gyms (-ng) and –no-pokestops (-nk). Speed Scheduler uses visible Gyms and Pokestops to determine if a scan is valid. Try adding gyms and stops back into your scan.

I’m seeing a lot of “[ WARNING] hhhs kind spawnpoint 12341234123 has no pokemon 2 times in a row”

Possible causes:

• Spawnpoint is one of the extremely rare double spawnpoints and was scanned during it’s hidden period
• Spawnpoint has been removed by Niantic. Speed Scheduler will no longer queue for scans after missing five times.

What does this line mean? SpeedScan Overseer: Scanning status: 27 total waiting, 0 initial bands, 0 TTH searches, and 27 new spawns

• Intial bands are the scans done to find the spawn points
• TTH searches are looking for the time_til_hidden stamp to find the exact spawn time
• New spawn searches are scanning new spawns.

How about this line? Initial scan: 100.00%, TTH found: 100.00%, Spawns reached: 100.00%, Spawns found: 100.00%, Good scans 99.59%

• Initial scan is the search for spawn points and scans each location in five bands within an hour, about 12 minutes apart. This should take a little over an hour to reach 100% with sufficient workers.
• TTH found is the percentage of spawn points for which the exact spawn time is known. This could take up to a day to get over 90%.
• Spawns reached is the percentage of spawns that are scanned before their timer runs out and they disappear. Will be low during the initial scan and possibly while still finding TTHs, but should reach 100% afterwards with sufficient workers.
• Spawns found is the percentage of spawns that found when and where they were expected. Low percentages mean the durations or end time of the spawnpoints are incorrect.
• Good scans are scans that aren’t 0/0/0. Should be over 99% generally. If not, see above note about 0/0/0 warnings.

On the print screen (-ps) or status page (-sn) what do the messages mean?

• Not able to reach any scan under the speed limit — Worker is not able to find anything to scan within range and stay under the speed limit.
• Nothing to scan — All initial scans, spawns, and TTHs searches have been done, and workers are waiting for next spawn. Usually a good sign that you have more than enough workers.

But my system has been saying Nothing to scan for several minutes, and I know there are pokemon that have spawned during that time.

Ok, that’s a bad sign. It means the Overseer thread has probably had an uncaught exception and died. Restart, and if you see an exception error in the logs, please report to @Artifice to fix.

Visual Representation¶

-bh -st 5 -w 19

Option #1: Intergrated beehive¶

PRO: Quicker Deployment

PRO: Less Memory usage

CON: Less Flexibility

CON: Limited to 1 Beehive per RM instance

Example of walking path assignments with 1 wph.

Command line option -bh or --beehive enables your workers to be organized into 1 search area per worker by default. The beehive will automatically center around your specified location -l and spirials out from there. This method uses the -st to determine the size of each hive. You increase the number of hives by adding more workers -w. You can also add more than one worker per a hive. For example, you can place two workers in a hive by using -wph 2. NOTE: Adding more than 1 worker per hive is only reccomended if you are using speed scheduler.

For each -w, you must have at least account one account. It is best to have at least 4 accounts per worker. This will allow your workers to always be working, no matter if the account encounters an error. It is also always a great idea to set an Account Search Interval -asi. This will limit each account to a certain ammount of search time before putting it to sleep. You can control the ammount of sleep with Account Rest Interval -ari.

python runserver.py -ac accounts.csv -bh -st 5 -w 31 -l "Nashville, TN"

Option #2: Use the RM Multi Location tool.¶

PRO: TONS of Flexibility

PRO: As many hives as your set up will allow!

CON: Uses A LOT More Memory

CON: Not as easy to make quick changes.

ptc,username,password

Troubleshooting¶

If your instances start but then immediately stop, take each line and run the part after /MIN starting with the python path. This will stop the window from automatically closing so that you can see what the actual error is.

Distances¶

if using -st 10, these are the numbers you should know: 4.9283 km, 1.425 km, 2.468175 km, 2.85 km - you can use the distances to calculate coords here http://www.sunearthtools.com/tools/distance.php

KinanCity¶

Node.js CORS proxy server¶

PGM Multi Loc¶

PokeAlarm¶

Use of custom styles¶

Place your custom CSS into ‘custom.css’ in the folder ‘static/css’. Examples are found in ‘static/css/custom.css.example’.

CSS classes¶

There are four different classes added to style individual map templates.

• Use class .mapPage for styles in map.html.
• Use class .mobilePage for styles in mobile_list.html.
• Use class .statisticsPage for styles in statistics.html.
• Use class .statusPage for styles in status.html.

.mapPage #nav h3 {font-size: 11px;}

.form-control input[type=text] {font-size: 11px !important;}
.onoffswitch-label, .onoffswitch-label:before {border-color: #256db6 !important;}
#nav .onoffswitch-checkbox:checked+.onoffswitch-label {border-color: #256db6; background-color: #ffde4e;}
.select2-container {font-size: 11px;}

.mapPage button {border: 1px solid #256db6; background-color: #fff; color: #256db6 !important; font-size: 11px;}
.mapPage button:hover {background-color: #ffde4e;}

Spawnpoint Scanning can be run in one of three different modes:¶

python runserver.py -ss -l YOURLOCATION -st STEPS

python runserver.py -ss YOURFILE.json -l YOURLOCATION -st STEPS --dump-spawnpoints

python runserver.py -ss YOURFILE.json -l YOURLOCATION

How Do RocketMap Webhooks Work?¶

Every time an event occurs (e.g. a Pokemon spawns) a POST request will be sent to a provided URL containing information about that event. A developer may create a listener in whatever language they feel most comfortable in (it just has to handle incoming connections, after all) and do certain things when information from the webhook is received. For example, a developer would be able to wait for a Dragonite to spawn, then play a loud alarm throughout the house and flash the lights in order to get their attention. All of this could be done without even the slightest touch to the internal RocketMap code, so there’s no risk to break anything.

Types of Webhooks¶

Pokemon Spawn webhooks are available. If you’re a developer, feel free to contribute by creating some more webhooks.

• pokemon - Emitted every time a Pokemon spawns.
• gym - Emitted when finding a gym.
• pokestop - Emitted when finding a pokestop.
• pokestop_lured - Emitted every time a Pokestop is lured.
• gym_defeated - Emitted every time a Gym is defeated (prestige changes)
• gym_conquered - Emitted every time the owner of a Gym is changed

Configuring Webhooks¶

Add -wh http://my-webhook/location argument when starting RocketMap (runserver.py) to define the location of your webhook. You can add multiple webhook locations to a single -wh argument to define multiple webhooks.

python runserver.py -a ptc -u [username] -p [password] -l "Location or lat/lon" -st 15 -k [google maps api key] -wh http://localhost:9876

RocketMap Public Webhook¶

RM is collecting data for an upcoming project. If you would like to donate your data, please fill out this form and add -wh [your webhook URL here] to your command line.

PokeAlarm¶

PokeAlarm is an example of a script you can run to accept webhook data and send it elsewhere. In PokeAlarm’s usage it is publishing that information on Facebook, Twitter, Discord, etc.

Learn More Here

Webhook Data¶

The POST request made by RocketMap will contain the following data for pokemon type webhooks:

{
   "message":{
      "disappear_time":1493734519,
      "form":null,
      "seconds_until_despawn":1748,
      "spawnpoint_id":"0d24fec01e7",
      "cp_multiplier":null,
      "move_2":null,
      "height":null,
      "time_until_hidden_ms":915847883,
      "last_modified_time":1493732771124,
      "cp":null,
      "encounter_id":"AzMxMjYyNjhWeDI4ODgwNjI1Mg==",
      "spawn_end":919,
      "move_1":null,
      "individual_defense":null,
      "verified":true,
      "weight":null,
      "pokemon_id":187,
      "player_level":6,
      "individual_stamina":null,
      "longitude":0,
      "spawn_start":0,
      "pokemon_level":null,
      "gender":null,
      "latitude":0,
      "individual_attack":null
   },
   "type":"pokemon"
}

Relevant Logs¶

The following messages can be logged (-v) and used to debug problems. Values denoted as %s are variable.

Info & debug:

• Encountering Pokémon ID %s with account %s at %s, %s.

• Using hashing key %s for this encounter.

• Encounter for Pokémon ID %s at %s, %s successful: %s/%s/%s, %s CP.

Errors & exceptions:

• Exception while encountering Pokémon: %s.

• Account %s encountered a captcha. Account will not be used.

• Expected account of level 30 or higher, but account %s is only level %s.

• No L30 accounts are available, please consider adding more. Skipping encounter.

Introduction¶

This guide will show you how to make your map available on the internet, including yourself on the go. These instructions should not be used on a server you are giving out to other people for use, as it is not the most secure option available. We are not responsible for damage caused to your software, equipment, or anything else, proceed at your own risk.

This guide will most likely not match your router exactly, as different manufacturers have different software and configuration. This is meant to be a general guide as many routers have a lot in common, but if you can’t follow these following instructions, try Googling something like “Port forwarding [MY ROUTER MODEL]“

Gathering Information¶

First we should find some information about your network. Press Win+R and type “cmd” on Windows to open a Command Prompt. On Linux and OS X, open a Terminal application.

On Windows, enter the following command:

ipconfig

On Linux and OS X, enter:

ifconfig

A lot of information will appear on your screen, but these two lines are what we’re looking for:

IPv4 Address. . . . . . . . . . . : 192.168.29.22
Default Gateway . . . . . . . . . : 192.168.29.1

Obviously, your numbers (IP Addresses) will most likely look different from mine. Jot those two down so we can use them later.

Let’s also find your Public IP address, browse to mxtoolbox.com/whatismyip and note the IP Address it gives you there.

Port Forwarding¶

Open an internet browser and type in the “Default Gateway” IP address we just found in the last step. It may ask you to login at this point, enter the login credentials for your router. It is important to note that this generally isn’t your wifi password, if you don’t know your router login credentials, they are usually on the bottom of the router unless they’ve already been changed.

Now you should be on the homepage of your router’s configuration. Find the Port Forwarding section of your router. On mine it was under “WAN” > “Virtual Server / Port Forwarding” but yours may differ.

Enter the following information on that screen. Some routers may make you press a menu before you can see these text boxes:

Replace “Local IP” (sometimes called “Internal IP”) with the IPv4 Address we found in the first step of this guide. Both port boxes should have the same number, 5000. If you only have one box for ports just enter “5000” in that one. Click the Add button to save your settings. If you have an option to choose from UDP or TDP, choose TDP.

Finishing Up¶

Your port should now be added! Next time you start your server, add -H 0.0.0.0 to the list of flags so it’s accessible from the internet!

Connecting¶

In any web browser not connected to your wifi, your phone for instance, browse to http://11.22.33.44:5000/ replacing 11.22.33.44 with your external IP address, and you should be set!

Note: It is a known bug that Safari on iOS may not be able to load the map, if this happens to you download Chrome from the app store.

MySQL Recommended¶

Because of the increased data being sent to the database, it is recommended to use MySQL when using this feature.

ALTER TABLE `gymdetails` COLLATE='utf8_general_ci', CONVERT TO CHARSET utf8;

Enabling Gym Information Parsing¶

To enable gym parsing, run with the -gi argument:

python runserver.py -gi

Or update your config.ini:

gym-info            # enables detailed gym info collection (default false)

Displaying the gym details sidebar in the front-end¶

To show the gym details sidebar on the front-end, -gi needs to be enabled on your webserver instance. To scan gyms for the gym details, -gi must also be enabled on your scanner instances.

New Webhook¶

When gym info parsing is enabled, gym details will be sent to webhooks. A sample webhook is below for reference:

{
    "message": {
        "id": "4b432a31c3c247e5b0f7656d09e2c050.11",
        "url": "http://lh3.ggpht.com/yBqXtFfq3nOlZmLc7DbgSIcXcyfvsWfY3VQs_gBziPwjUx7xOfgvucz6uxP_Ri-ianoWFt5mgJ7_zpsa7VNK",
        "name": "Graduate School of Public Health Sculpture",
        "description": "Sculpture on the exterior of the Graduate School of Public Health building.",
        "team": 1,
        "latitude": 40.442506,
        "longitude": -79.957962,
        "pokemon": [{
            "num_upgrades": 0,
            "move_1": 234,
            "move_2": 99,
            "additional_cp_multiplier": 0,
            "iv_defense": 11,
            "weight": 14.138585090637207,
            "pokemon_id": 63,
            "stamina_max": 46,
            "cp_multiplier": 0.39956727623939514,
            "height": 0.7160492539405823,
            "stamina": 46,
            "pokemon_uid": 9278614152997308833,
            "iv_attack": 12,
            "trainer_name": "SportyGator",
            "trainer_level": 18,
            "cp": 138,
            "iv_stamina": 8
        }, {
            "num_upgrades": 0,
            "move_1": 234,
            "move_2": 87,
            "additional_cp_multiplier": 0,
            "iv_defense": 12,
            "weight": 3.51259708404541,
            "pokemon_id": 36,
            "stamina_max": 250,
            "cp_multiplier": 0.6121572852134705,
            "height": 1.4966495037078857,
            "stamina": 250,
            "pokemon_uid": 6103380929145641793,
            "iv_attack": 5,
            "trainer_name": "Meckelangelo",
            "trainer_level": 22,
            "cp": 1353,
            "iv_stamina": 15
        }, {
            "num_upgrades": 9,
            "move_1": 224,
            "move_2": 32,
            "additional_cp_multiplier": 0.06381925195455551,
            "iv_defense": 13,
            "weight": 60.0,
            "pokemon_id": 31,
            "stamina_max": 252,
            "cp_multiplier": 0.5974000096321106,
            "height": 1.0611374378204346,
            "stamina": 252,
            "pokemon_uid": 3580711458547635980,
            "iv_attack": 10,
            "trainer_name": "Plaidflamingo",
            "trainer_level": 23,
            "cp": 1670,
            "iv_stamina": 11
        }]
    },
    "type": "gym_details"
}

I. Prerequisites¶

1. Have already ran/operated the RocketMap using the default database setup.
2. Have the “develop” build of RocketMap. Available here.
3. Downloaded MariaDB

II. Installing MariaDB¶

1. Run the install file, for me this was: mariadb-10.1.16-winx64.msi
2. Click next
3. Check “I accept the terms in the License Agreement” and click next
4. If you wish to change the installation location do that. If not click next.
5. Decide whether or not you want a password on your root account, if you don’t put a password on it this database cannot be accessed from remote machines, which isn’t necessary for what were doing. But if you do want a password go to 5a, if not go to 5b.
   • 5a. Input the password you want into “new root password”, and again into the “confirm” textbox.
   • 5b. Uncheck “modify password for database user ‘root’.
6. Click next
7. All the default options are acceptable here. Hit next.
8. This screen wants to know if you can submit anonymous usage data, feel free to hit next or if you’d like to contribute data go ahead and check “enable the Feedback plugin and submit anonymous usage information” and then click next.
9. Click install. Administrator privileges required.
10. Congratulations you’ve installed MariaDB and it’s all downhill from here.

III. Setting up your database¶

1. Go to your windows start menu and locate MariaDB.

2. Open “MySQL Client”

3. If you created a password in step 5a above enter it now and hit enter. If you didn’t create a password simply hit enter.

4. One this command prompt screen you’ll want to enter:

   CREATE DATABASE rocketmapdb;
   CREATE USER 'rocketmapuser'@'localhost' IDENTIFIED BY 'password';
   GRANT ALL PRIVILEGES ON rocketmapdb . * TO 'rocketmapuser'@'localhost';
   exit
   

   You can change rocketmapdb to whatever you want the name of the database to be.

5. If the database creation was successful it will tell you “Query OK, 1 row affected”. If it doesn’t echo that back at you then you either received an error message, or it just created a blank line. I’ve detailed how to fix common errors, and the blank line below.

   • Blank line: You simply missed the ”;” in the CREATE DATABASE command. Essentially you didn’t close of the line, so the program thinks you still have more information to input. Simply insert a ; onto the blank line and hit enter and it should echo “Query OK” at you.
   • Error: “ERROR 1064 (42000): You have an error in your SQL syntax” Double check that you put in the CREATE DATABASE command exactly as it’s typed above. If you had the blank line error, and then retyped the CREATE DATABASE line it will spit this at you because you actually typed CREATE DATABASE rocketmapdb CREATE DATABASE rocketmapdb;. Simply retry the CREATE DATABASE rocketmapdb; and don’t forget your ;.
   • Error: “ERROR 1007 (HY000): Can’t create database ‘rocketmapdb’; database exists” The rocketmapdb database already exists. If you’re trying to start a fresh database you’ll need to execute DROP DATABASE rocketmapdb, and then run CREATE DATABASE rocketgomapdb. If you want to keep the rocketmapdb but start a new one, change the name.

6. Congratulations, your database is now setup and ready to be used.

IV. Setting up the Config.ini file¶

V. Run it!¶

Now that we have our server setup and our config.ini filled out it’s time to actually run the workers to make sure everything is in check. Remember from above if you commented out any parameters in the util.py file that all of those parameters need to be met and filled out when you run the runserver.py script. In our case we commented out location, and steps so we could individual choose where each worker scanned, and the size of the scan. I’ve put two code snippets below, one would be used if you didn’t comment out anything and instead filled out the [Search_Settings] in section IV step 4 above. The other code snippet is what you would run if you commented out the same lines as I did in our running example.

python runserver.py

Left Search_Settings at default

python runserver.py -st 10 -l "[LOCATION]"

You should now be up and running. If you’ve encountered any errors it’s most likely due to missing a parameter you commented out when you call runserver.py or you mis-typed something in your config.ini. However, if it’s neither of those issues and something not covered in this guide hop into the RocketMap discord server, and go to the help channel. People there are great, and gladly assist people with troubleshooting issues.

Set up MySQL on a second computer, seperate from RM instances.¶

In this example, computer running RocketMap will be Server A while computer running MySQL will be Server B.

You will follow above directions for II and III on Server B and directions for IV on Server A. However: The following steps will be different.

Server B- III

You will need to grant your account permission to use the database outside of your database server.

   CREATE DATABASE rocketmapdb;
   CREATE USER 'rocketmapuser'@'%' IDENTIFIED BY 'password';
   GRANT ALL PRIVILEGES ON rocketmapdb . * TO 'rocketmapuser'@'%';
   exit

Server A- IV

You need to tell RocketMap where the database is!

**Database Settings:** This is the important section you will want to modify.
 - Change the "db-type" to "mysql"
 - Change "db-host" to [IP ADDDRESS OF SERVER B]
 - Change "db-name:" to "rocketmapdb"
 - Change "db-user:" to "rocketmapuser"
 - Change "db-pass" to the password you chose in section III step 4, or leave it blank if you chose to roll with no password.

AND

 **Webserver Settings:** This is how your server knows where to communicate.
 - Change "host" to "0.0.0.0"

Linux Instructions¶

1. Visit https://downloads.mariadb.org/mariadb/repositories/ and download mariaDB

2. Login to your MySQL DB

   • mysql -p
   • Enter your password if you set one

3. Create the DB

   CREATE DATABASE rocketmapdb;
   CREATE USER 'rocketmapuser'@'localhost' IDENTIFIED BY 'password';
   GRANT ALL PRIVILEGES ON rocketmapdb.* TO 'rocketmapuser'@'localhost';
   

4. Quit the MySQL command line tool quit

5. Edit the config/config.ini file

   # Database settings
   db-type: mysql          # sqlite (default) or mysql
   db-host: 127.0.0.1      # required for mysql
   db-name: rocketmapdb # required for mysql
   db-user: rocketmapuser    # required for mysql
   db-pass: YourPW         # required for mysql
   

Docker Settings w/ Let’s Encrypt¶

Note: These are preliminary until better Docker support in the official container hosted on Docker Hub Note: These commands require git to be installed

docker build -t pokemap https://github.com/RocketMap/RocketMap.git:develop
docker run --name pokesql -e MYSQL_ROOT_PASSWORD=some-string -e MYSQL_DATABASE pokemap -d mysql:5.6

only pain comes from mysql5.7 and beyond

docker run --name mainmap -d --link pokesql pokemap --auth-service=ptc \
  --username=youruser --password=yourpassword --db-type=mysql --db-host=pokesql \
  --db-name=pokemap --db-user=root --db-pass=some-string --gmaps-key=someapikey

all optional arguments except db type omitted, including –location (you can set it in the web ui!)

OPTIONAL: always scan Austin, TX (SQL benchmark?)

docker run --name scanagent -d --link pokesql pokemap --no-server \
 --auth-service=ptc --location="Austin, TX" --username=yourotheruser \
 --password=yourotherpassword --db-type=mysql --db-host=pokemap \
 --db-name=pokemap --db-user=root --db-pass=some-string \
 --gmaps-key=some-api-key

Part 1: Register at StartSSL¶

Step 1 browse to:

StartSSL

Step 2 click on Sign-Up:

Step 3 Choose your country and pick an email address to receive a verification code at. This email should not be disposable:

Step 4 Enter the verification code that they sent you to your non disposeable email:

Step 5 Now for the sake of easiness lets let the system generate the CSR for us. So in this step pick and confirm a password and then click submit:

Step 6 You should now be at this screen so click download files:

Step 7 A wild certificate is downloaded, you need this to login to www.startssl.com so lets click on it:

Step 8 Click next:

Step 9 Cleck next again:

Step 10 Now enter your password that you chose at www.startssl.com and press next:

Step 11 Click next again:

Step 12 Now click finish:

Step 13 You should now see that the import was successful:

Step 14 Click login now:

Step 15 You will see a box like this come up with your certificate in it that you just imported. Click it then click okay. If prompted for a password enter your password that you used when createing it.

Part 2: Validate Domain¶

Step 16 Click on validations wizard:

Step 17 It should be on Domain Validation, if so click continue:

Step 18 Enter a domain that you have access to an email address for (webmaster, or admin@domain.com) and press continue:

Step 19 Pick whichever email you have access to and then click send verification code, check your email and paste your verification code then press Validation:

Part 3 Get Your Certificate¶

Step 20 Once validated click certificates wizard:

Step 21 We should be already on Web Server, if not click it then click continue:

Step 22 You will now see a box like in this image and you will type your validated domain name, if you want to host from a subdomain that is fine too:

Step 23 We will generate our own CSR for this step, open bash, cmd, or git shell on your desktop and enter openssl req -newkey rsa:2048 -keyout yourname.key -out yourname.csr just like that for simplicity:

Step 24 It will ask you questions (first being a pass phrase and to confirm that phrase), fill everything out to the best of your ability, if you dont know the answer to something use .:

Step 25 When the script is done it will dump the files (yourname.key and yourname.csr) on your desktop:

Step 26 Open yourname.csr with a text editor, I use sublime:

Step 27 Copy and paste it all into StartSSL in the box asking you for the CSR and press submit:

Step 28 It will show you a screen like this, if it says “Click here” then click on the “here” and it will download the certificates in a zipped folder:

Step 29 Wild certificate zip has appeared:

Part 4 Create the .PEM File For the Server¶

Step 30 Unzip that folder and open it up then unzip the other server folder and open that up it will have the intermediate, root and the certificate within it:

Step 31 We will now combine these certs into one file in a certain way

• Open your_domain_name.crt in a text editor and copy it to a new file
• Open the intermediate certificate in a text editor copy it and paste it in the file directly below your_domain_name.crt
• Repeat the same exact thing with the root certificate and save this file as cert.pem (save it on your desktop) it should look similar to the image below:

Step 32 Now the server needs yourname.key to be unencrypted to be able to function in SSL mode. So we will go back to shell on our desktop and type this openssl rsa -in yourname.key -out private.key:

Step 32 Enter the passphrase, if everything went well you will see this:

Step 33 We are pretty much done now you should have these two files on your desktop:

Part 5 Setup the Server¶

Step 34 Copy and paste these two files to your config folder open your config.ini in a text editor thats not notepad.exe and make the ssl lines look similar to mine (copy the path to each file into your config.ini):

Step 35 You should now be able to run the server in SSL mode if you followed this guide and if I didnt mess up somewhere along the way:

Step 36 Profit!

Setup¶

There are two steps to enable the status page:

1. Set a password for the status page by adding the -spp argument to each worker running the web service or by setting the status-page-password field in config.ini. A password is required to enable the status page.
2. Give each of your workers a unique “status name” to identify them on the status page by setting the -sn argument.

Accessing¶

To view your status page, go to <YourMapUrl>/status (for example, http://localhost:5050/status) and enter the password you defined. The status of each of your workers and hashing keys will be displayed and continually update. Remember to double-check your hashing keys before starting your instances. Invalid or expired hashing keys currently won’t be cleared from the database or status page automatically.

Screenshots¶

Requirements¶

• AWS Account
• AWS ECS Cluster with at least one instance assigned
  • t2.micro type is sufficient for this setup

Process¶

In the AWS ECS console create a Task Definition with the JSON below. You will need to set the following values:

• POGOM_USERNAME - username for pokemongo
• POGOM_PASSWORD - password for pokemongo
• POGOM_AUTH_SERVICE - Define if you are using google or ptc auth
• POGOM_LOCATION - Location to search
• POGOM_DB_USER - Database user for MariaDB
• POGOM_DB_PASS - Database password for MariaDB

{
    "taskRoleArn": null,
    "containerDefinitions": [
        {
            "volumesFrom": [],
            "memory": 128,
            "extraHosts": null,
            "dnsServers": null,
            "disableNetworking": null,
            "dnsSearchDomains": null,
            "portMappings": [
                {
                    "hostPort": 80,
                    "containerPort": 5000,
                    "protocol": "tcp"
                }
            ],
            "hostname": null,
            "essential": true,
            "entryPoint": null,
            "mountPoints": [],
            "name": "pokemongomap",
            "ulimits": null,
            "dockerSecurityOptions": null,
            "environment": [
                {
                    "name": "POGOM_DB_TYPE",
                    "value": "mysql"
                },
                {
                    "name": "POGOM_LOCATION",
                    "value": "Seattle, WA"
                },
                {
                    "name": "POGOM_DB_HOST",
                    "value": "database"
                },
                {
                    "name": "POGOM_NUM_THREADS",
                    "value": "1"
                },
                {
                    "name": "POGOM_DB_NAME",
                    "value": "pogom"
                },
                {
                    "name": "POGOM_PASSWORD",
                    "value": "MyPassword"
                },
                {
                    "name": "POGOM_GMAPS_KEY",
                    "value": "SUPERSECRET"
                },
                {
                    "name": "POGOM_AUTH_SERVICE",
                    "value": "ptc"
                },
                {
                    "name": "POGOM_DB_PASS",
                    "value": "somedbpassword"
                },
                {
                    "name": "POGOM_DB_USER",
                    "value": "pogom"
                },
                {
                    "name": "POGOM_USERNAME",
                    "value": "MyUser"
                }
            ],
            "links": [
                "database"
            ],
            "workingDirectory": null,
            "readonlyRootFilesystem": null,
            "image": "frostthefox/rocketmap",
            "command": null,
            "user": null,
            "dockerLabels": null,
            "logConfiguration": null,
            "cpu": 1,
            "privileged": null
        },
        {
            "volumesFrom": [],
            "memory": 128,
            "extraHosts": null,
            "dnsServers": null,
            "disableNetworking": null,
            "dnsSearchDomains": null,
            "portMappings": [],
            "hostname": "database",
            "essential": true,
            "entryPoint": null,
            "mountPoints": [],
            "name": "database",
            "ulimits": null,
            "dockerSecurityOptions": null,
            "environment": [
                {
                    "name": "MYSQL_DATABASE",
                    "value": "pogom"
                },
                {
                    "name": "MYSQL_RANDOM_ROOT_PASSWORD",
                    "value": "yes"
                },
                {
                    "name": "MYSQL_PASSWORD",
                    "value": "somedbpassword"
                },
                {
                    "name": "MYSQL_USER",
                    "value": "pogom"
                }
            ],
            "links": null,
            "workingDirectory": null,
            "readonlyRootFilesystem": null,
            "image": "mariadb:10.1.16",
            "command": null,
            "user": null,
            "dockerLabels": null,
            "logConfiguration": null,
            "cpu": 1,
            "privileged": null
        }
    ],
    "volumes": [],
    "family": "rocketmap"
}