Updated README.md

This commit is contained in:
Daniel Brunner
2016-08-02 21:01:46 +02:00
parent 61e7e9a85d
commit 45bcfce844

View File

@@ -1,2 +1,28 @@
# PokeMobBotMap
A browser map for PokeMobBot
## Installation
I recomment using an apache webserver for serving the map because there is an websocket module that can help you to avoid using a second tcp port just for the websocket.
The apache acts then as a "proxy" for the websocket api on `/websocket`.
First step is to obtain the live map from GitHub. You could download a simple zip-archive [here](https://github.com/0xFEEDC0DE64/PokeMobBotMap/archive/master.zip). Experienced users can `git clone` it.
### Installation on Windows
Download the latest apache binaries on [Apache Lounge](https://www.apachelounge.com/download/) (httpd-2.4.*-win64-VC14.zip). Unpack it to somewhere. Open the configuration file (located in `conf/httpd.conf` in your favourite editor. **Change the following configs to match you paths:**
* ServerRoot "**c:/Path/To/Apache24**"
* DocumentRoot "**C:/Path/To/PokeMobBotMap/src**"
* <Directory "**C:/Path/To/PokeMobBotMap/src**">
You also need to **uncomment** (remove the hashtag) the following lines:
* LoadModule proxy_module modules/mod_proxy.so
* LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so
Now you need to configure the websocket proxy thing. Add the following lines on the end of the configuration file:
```
<IfModule proxy_wstunnel_module>
ProxyPass "/websocket" "**ws://localhost:14251/**"
</IfModule>
```
Be sure the **port 14251** matches your websocket port in the bot configuration.