POGOserver/README.md
2016-08-23 14:08:47 +02:00

60 lines
2.2 KiB
Markdown

````
______ _____ _____ _____
| ___ \ _ | __ \ _ |
| |_/ / | | | | \/ | | | ___ ___ _ ____ _____ _ __
| __/| | | | | __| | | |/ __|/ _ \ '__\ \ / / _ \ '__|
| | \ \_/ / |_\ \ \_/ /\__ \ __/ | \ V / __/ |
\_| \___/ \____/\___/ |___/\___|_| \_/ \___|_|
````
<a href="#">
<img src="https://img.shields.io/badge/Pokemon%20GO-0.35.0-blue.svg?style=flat-square" />
</a>
<a href="https://discord.gg/gu8ZUJp">
<img src="https://img.shields.io/badge/Discord-Join%20Chat%20%E2%86%92-738bd7.svg?style=flat-square" />
</a>
<a href="https://nodejs.org/api/documentation.html#documentation_stability_index">
<img src="https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square" alt="Stability" />
</a>
<img width="25%" src="http://image.prntscr.com/image/55fb47b99164465abefb2698a7bb142d.png" />
<img width="24%" src="http://image.prntscr.com/image/0ab416fa479f427180476cad8a238f04.png" />
<img width="24%" src="http://image.prntscr.com/image/918383bb5cde453ab2572461084b4601.png" />
<img width="25%" src="http://i.imgur.com/iZypeny.png" />
# Getting started
## Setup
Copy and rename ``cfg.js.example`` to ``cfg.js``.
Open ``cfg.js`` and fill the following fields:
````js
DOWNLOAD_PROVIDER: "GOOGLE";
DOWNLOAD_USERNAME: "USERNAME";
DOWNLOAD_PASSWORD: "PASSWORD";
````
## Tunneling setup
The pokemon go app traffic has to get forwarded manually to this custom server. To do so, download [rastapasta](https://github.com/rastapasta)'s [Pokemon Go Xposed](https://github.com/rastapasta/pokemon-go-xposed/releases) app and follow the installation instructions [here](https://github.com/rastapasta/pokemon-go-xposed#how-to-use-it).
## Database setup
To setup a database connection, open ``cfg.js`` and change the database login credentials:
````js
MYSQL_PORT: 3306,
MYSQL_HOST_IP: "127.0.0.1",
MYSQL_DB_NAME: "pogosql",
MYSQL_USERNAME: "root",
MYSQL_PASSWORD: "",
````
The required database tables get generated automatically.
## Server setup
You need at minimum [Node.js](https://nodejs.org/en/) version 6.x.
Depending on your OS, you need to run either ``run-linux.sh`` or ``run-windows.bat`` from the root folder.