Skip to content

Windows Installation

ranrinc edited this page Sep 14, 2016 · 15 revisions

This is still a W.i.P

Nodejs and NPM

To install POGOserver on Windows you first are required to install nodejs. Download nodejs from the official site: https://nodejs.org/en/download/current/ download either the x86 or x64 version if you aren't certain which one you need download the x86 version. It does not matter if you pick the .msi or .exe one. Execute the file you have downloaded and follow the download instructions. Basically next next next next. Just make certain the below is all selected for install (default it is)

XAMPP

MySQL will be changed to using XAMPP since we will be needing a webserver as well. Will later add how to do this.

XAMPP will allow your API to be accessed and also will be used as your MySQL database. Install XAMPP from the official site: https://www.apachefriends.org/download.html, pick a download according to your Operating Software and install it as you would with any other installer. Start XAMPP and start up Apache and MySQL. Click Start on Apache and MySQL

After doing that click Admin in MySQL

Once you open it up, on the top left of your browser you should find new, click new and type pogosql in database name. You're done setting up MySQL now. In order to setup your API page navigate to the directory where you installed XAMMP, click that and then navigate to htdocs. Copy your API folder and paste it into htdocs. Now you're done setting up your API webserver. In order to access your webserver you must type in localhost/(name of your folder), you may rename your folder to make it more easily accessible. You're now done setting up your MySQL database and your API webserver.

This is GitHub, not Language Arts don't complain.

Protobuf

Please used this guide to compile a Protobuf

Once completed using the guide copy the protobuf/install directory and paste it into POGOserver directory and rename install to protobuf. This way the new install-windows.bat will work without need editing.

Need more detail about protobuf installation please follow the official README/setup to get google protobuf: https://github.com/google/protobuf/blob/master/cmake/README.md

POGOserver

Now download the official POGOserver source zip from maierfelix.

Extract the downloaded zip with your preferred extractor (Default Windows extractor, WinRar, 7-Zip, etc...)

Copy and rename the cfg.js.example to cfg.js and place it in the same folder.

Best way to modify the cfg.js is by using notepad++ https://notepad-plus-plus.org/

Modify the following section:

// MySQL credentials
  MYSQL_PORT: 3306,
  MYSQL_HOST_IP: "127.0.0.1",
  MYSQL_DB_NAME: "pogosql",
  MYSQL_USERNAME: "root",
  MYSQL_PASSWORD: "", 
  // Used for asset download session
  DOWNLOAD_PROVIDER: "GOOGLE",
  DOWNLOAD_USERNAME: "USERNAME",
  DOWNLOAD_PASSWORD: "PASSWORD",

Only change MYSQL_PORT if you knew what you are doing and changed it yourself after you installed MySQL. Change MYSQL_HOST_IP when the MySQL server is running on another machine then the machine your trying to install POGOserver on.

Change MYSQL_DB_NAME if you wan't another name for your database to make it more clear what it is used for (ex. pogoserver) Just make certain it's the same name you used at the CREATE DATABASE statement earlier.

Change MYSQL_USERNAME if you created a separate user for the database default user is root that has access to all databases your running.

Change MYSQL_PASSWORD to the password you used for your root account or an alternate account.

Once this is all ready go the the folder your POGOserver is placed. First run the install-windows.bat and wait for this to finish and succeed. Once this is done you can run the run-windows.bat.

Suggested way to run the .bat files is as followed:

Hold Shift and right click into the folder. Then Click Open command window here

Type install-windows.bat if you type in inst and press the tab key on your keyboard it automatically fills the rest in then wait for it to finish and succeed.

Current repository do not have run-windows.bat so you will need to create one. Simply using Notepad++ you need to create a new file and wrote this

  npm run boot
  pause

Afterwards save it as run-windows.bat

Again like install-windows.bat you will need to run run-windows.bat using command prompt.

You're server should be up and running then.

Next you will need to [setup API services through Google Console] (https://github.com/maierfelix/POGOserver/wiki/How-to-setup-API--services-through-Google-Console)

For Windows you will need to copy API files into XAMMP HTDocs folder and you will be able to called it http://localhost/APIdirectory from your browser.

for login please used default user id root and password blank once login if you done everything correctly you should be able to see the map. Double click the map and you should be able to add pokestop, gym, and spawn point.