Installation and requirements
In order to run the project, you will need Python, pip and the project dependencies. Version 2.7 is what we usually test against. You can use 3.x but no support will be given.
- If you are having Issues with Step 6 and did not install Python on your C: drive, try uninstalling and reinstalling Python on C: before opening an issue (thanks @RicarFox).
Download Git for Windows from the link above and install it. You will be fine with all recommended options during the setup.
Note: If you already have another version of Python installed, you probably want to uninstall that version and install 2.7.1.2. I did not test this setup with any other version.
Download Python 2.7.1.2 either as the 64bit or the 32bit version from the link above. Make sure to add Python to PATH during the setup (see screenshot)!
Navigate to the folder you want to download PokemonGo-Map to. For this guide we'll be using the Downloads folder. Rightclick inside the folder and select Git Bash Here from the context menu.
You can copy the following command and paste it with a rightclick into the shell window that has opened:
git clone https://github.com/AHAAAAAAA/PokemonGo-Map.git
Now we have all PokemonGo-Map files inside our Downloads folder.
Go to this page to get your own Google Maps API Key. If you do not get your own API Key, you'll very likely run into an error telling you that you reached the daily request limit.
If you got your own API Key, open the credentials.json file inside the PokemonGo-Map folder. You can edit that file with Windows' built in text editor. Now replace the API Key in line 6 with the one you got from that Google website.
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 WindowsKey + 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.
That was the hard part. Now navigate to the PokemonGo-Map folder and Git Bash Here, like in Step 3. Now paste this command:
pip install -r requirements.txt
Now we are ready to start the map.
A full list of parameters you can use with the map and what they mean can be found here. This guide will only cover the important ones:
-a: Use either ptc or google for the login
-u: Your Username
-p: Your Password
-l: The location you want to scan for Pokémon. You can try something like La tour Eiffel, Paris, your street or exact coordinates in this format: 47.6062100 -122.3320700
-st: The amount of steps to take (5 steps is approximately a 1.2km radius according to this list)
-ar: Auto refresh interval (in seconds), so you don't have to refresh the map all the time
Note: It's recommended that you create a dummy account to use this Map with in order to prevent your real account from getting (soft)banned.
The final command should look like this:
python example.py -a ptc -u johndoe -p ilovemama -l "400 Broad St, Seattle, WA 98109, USA" -st 5 -ar 10
Hit enter and view your map in all it's glory at http://127.0.0.1:5000/. Done!
Since PokemonGo-Map is under active development and gets a lot of updates, you probably want to get all the latest features and bug fixes. You can see the latest updates (called commits) here. To update your copy, Git Bash here from the PokemonGo-Map folder, paste this command and hit enter:
git pull origin master
Now repeat Step 7 to restart your map.
You can install Python and Pip on Ubuntu by running the following command:
sudo apt-get install python python-pip
Create a Pokemon Club account [on their official website] to be used by the program to search for Pokemon. This generally shouldn't be the same as your main Trainer account you personally use. As of 7/21/2016 this page is unavailable most of the time, refresh the page every 5-10 minutes and it should allow signups eventually.
Then, download one of the following branches below:
- Download master (Stable builds)
- Download dev branch (Active development)
The dev branch will have latest features from the development team, however it may be unstable at some times.
Extract this zip file to any location.
Now, open a Terminal/Command Line (Win+R and cmd on Windows) and cd to the folder you extracted the zip file to.
cd some/directory/
In Windows you can also right click within the folder and select "Open Command Window Here."
Then enter the following:
pip install -r requirements.txt
To start the server, run the following command:
python example.py -a ptc -u [USERNAME] -p [PASSWORD] -l "[LOCATION]" -st 10
Replaing [USERNAME] and [PASSWORD] with the Pokemon Club credentials you created previously, and [LOCATION] with any location, for example Washington, D.C or latitude and longitude coordinates, such as 38.9072 77.0369.
Additionally, you can change the 10 after -st to any number. This number indicates the number of steps away from your location it should look, higher numbers being farther.
Open your browser to http://localhost:5000 and keep refreshing as it loads more Pokemon (auto refresh is not implemented yet).