From 104a8e01112c3d531f726d2e6398b289b91dab4e Mon Sep 17 00:00:00 2001 From: Pogarek Date: Sat, 4 Mar 2017 19:50:50 +0100 Subject: [PATCH] updating docs --- docs/faq.md | 3 +++ docs/installation.md | 9 +++++---- docs/manual_installation.md | 14 +++----------- 3 files changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index ba2524bbce..1475cf1cfb 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,3 +1,6 @@ +### Do I need hashing key ? +Without hashing key, the bot will use API in version 0.45, which is not used in legit game any longer. Learn more about - [hashing key here](http://hashing.pogodev.org). + ### How do I start the application? After [installing] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md), in the root folder run the following command: ### Linux diff --git a/docs/installation.md b/docs/installation.md index 3079f83471..8255fe9d69 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -11,6 +11,7 @@ - [pip](https://pip.pypa.io/en/stable/installing/) - [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) (Recommended) +- [hashing key](http://hashing.pogodev.org) - if you want use latest API, not the old, 0.45 ### Easy installation 1. Clone the git: `git clone https://github.com/PokemonGoF/PokemonGo-Bot` @@ -32,14 +33,14 @@ for manual installation please refer to [here](https://github.com/PokemonGoF/Pok We do recommend Windows users to use [Docker](#docker) this will work much easier and smoother (also safer) ## Requirements +- [hashing key](http://hashing.pogodev.org) - if you want use latest API, not the old, 0.45 ### Easy Installation 1. Download [PokemonGo-Bot-Install.bat](https://github.com/PokemonGoF/PokemonGo-Bot/blob/master/windows_bat/PokemonGo-Bot-Install.bat) -2. Download `encrypt.so` and `encrypt.dll` or `encrypt_64.dll` to the same folder of the `PokemonGo-Bot-Install.bat`. -3. Run `PokemonGo-Bot-install.bat`. +2. Run `PokemonGo-Bot-install.bat`. After that has been done the bot will be installed. -4. Run `PokemonGo-Bot-Configurator` to create auth.json, config.json and userdata.js. -5. Run `PokemonGo-Bot-Start.bat`. +3. Run `PokemonGo-Bot-Configurator` to create auth.json, config.json and userdata.js. +4. Run `PokemonGo-Bot-Start.bat`. This will start the bot and the web interface. ### To update the bot diff --git a/docs/manual_installation.md b/docs/manual_installation.md index fec953cd7a..ce0ac5316a 100644 --- a/docs/manual_installation.md +++ b/docs/manual_installation.md @@ -1,4 +1,5 @@ # Manual installation +Consider purchase of [hashing key](http://hashing.pogodev.org) - if you want use latest API, not the old, 0.45 ## Table of Contents - [Linux and Mac Installation](#linux-and-mac) @@ -55,17 +56,13 @@ virtualenv . source bin/activate ``` #### -- install the requirements and get the needed encryption.so +- install the requirements + -(we move `encrypt.so` to the root folder of the Bot so no need to edit the config regarding that) ```bash pip install -r requirements.txt -wget http://pgoapi.com/pgoencrypt.tar.gz -tar -xzvf pgoencrypt.tar.gz -cd pgoencrypt/src/ make cd ../../ -mv pgoencrypt/src/libencrypt.so encrypt.so ``` #### - copy and edit the config @@ -121,11 +118,6 @@ call C:\Python27\PokemonGo-Bot\Scripts\activate.bat pip2 install --upgrade -r C:/Python27/PokemonGo-Bot/requirements.txt ``` -##### Get encrypt.so and encrypt.dll or encrypt_64.dll -Due to copyright on the encrypt.so, encrypt.dll and encrypt_64.dll we are not directly hosting it. Please find a copy elsewhere on the internet and compile it yourself. We accept no responsibility should you encounter any problems with files you download elsewhere. -Try asking around our Slack chat **(Just say the word "encrypt" and Slackbot will give you info)**! - -Download it to the `C:/Python27/PokemonGo-Bot/` folder ##### Update