These instructions cover an installation from the develop branch in git.
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¶
To run a copy from the latest
develop branch in
git you can clone the repository:
git clone https://github.com/RocketMap/RocketMap.git
At this point you should have the following:
- Python 2.7
- RocketMap application folder
First, open up your shell (
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:
pip install -r requirements.txt
sudo -H pip install -r requirements.txt
Building Front-End Assets¶
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 v4.7.0 $ npm --version 3.8.9
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
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,passwd” lines. [More Info](http://rocketmap.readthedocs.io/en/develop/extras/multi-account.html)
Complete ToS and tutorial steps on accounts if they haven’t already. [More Info](http://rocketmap.readthedocs.io/en/develop/extras/multi-account.html)
- -hk “HASH_KEY_HERE”
Key used to access the hash server. [More Info](http://rocketmap.readthedocs.io/en/develop/extras/hashing.html)
- -cs -ck “CAPTCHA_KEY”
Enables captcha solving and 2Captcha API key. (Manual captcha available, see [Full Info](http://rocketmap.readthedocs.io/en/develop/extras/captchas.html))
Another thing to note is that all of these flags can be set inside of a configuration file to avoid clutter on the command line. View [this page](http://rocketmap.readthedocs.io/en/develop/extras/configuration-files.html) to see how.
Open your browser to http://localhost:5000 and your pokemon will begin to show up! Happy hunting!
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 install npm run build
IMPORTANT Some updates will include database changes that run on first startup. These can take a while to update. You should run only one
runserver.py command until you are certain that the DB has been updated. You will know almost immediatly that your DB needs updating by seing the following in the log/terminal screen Detected database version 7, updating to 8 when it’s done the log/terminal will continue as normal. This can take a while so be patient. Once it’s done you can start all your instances like you normally would.