tibotic · tibotic · Aug 11, 2016
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -62,3 +62,6 @@
  * eevee-github
  * g0vanish
  * cmezh
+ * Nivong
+ * kestel
+ * joaodragao
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,7 @@
-FROM python:2.7-onbuild
+FROM python:2.7
+
+WORKDIR /usr/src/app
+VOLUME ["/usr/app/configs", "/usr/src/app/web"]
 
 ARG timezone=Etc/UTC
 RUN echo $timezone > /etc/timezone \
@@ -15,8 +18,11 @@ RUN cd /tmp && wget "http://pgoapi.com/pgoencrypt.tar.gz" \
     && cd /tmp \
     && rm -rf /tmp/pgoencrypt*
 
-VOLUME ["/usr/src/app/web"]
-
 ENV LD_LIBRARY_PATH /usr/src/app
 
+COPY requirements.txt /usr/src/app/
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . /usr/src/app
+
 ENTRYPOINT ["python", "pokecli.py"]
diff --git a/README.md b/README.md
@@ -1,18 +1,14 @@
-
-# PokemonGo-Bot (Working)
+# PokemonGo-Bot
 PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team.
-The project is currently setup in two main branches. `dev` and `master`.
-
-## Help Needed on [Desktop Version](https://github.com/PokemonGoF/PokemonGo-Bot-Desktop)
 
-## Please submit PR to [Dev branch](https://github.com/PokemonGoF/PokemonGo-Bot/tree/dev)
+The project is currently setup in two main branches. `dev` also known as `beta` and `master` also known as `stable`. Submit your PR's to `dev`.
 
-We use [Slack](https://slack.com) as a web chat. [Click here to join the chat!](https://pokemongo-bot.herokuapp.com)
-You can count on the community in #help channel.
+If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel.
 
 ## Table of Contents
+- [Installation](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md)
+- [Documentation](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/)
 - [Features](#features)
-- [Wiki](#wiki)
 - [Credits](#credits)
 
 ## Features
@@ -27,9 +23,9 @@ You can count on the community in #help channel.
 - [x] Rudimentary IV Functionality filter
 - [x] Ignore certain pokemon filter
 - [x] Adjust delay between Pokemon capture & Transfer as per configuration
-- [ ] Standalone Desktop Application
 - [x] Hatch eggs
 - [x] Incubate eggs
+- [ ] [Standalone Desktop Application] (https://github.com/PokemonGoF/PokemonGo-Bot-Desktop)
 - [ ] Use candy
 - [ ] Inventory cleaner
 
@@ -45,22 +41,8 @@ If there are any concerns with this policy or you believe we are tracking someth
 
 If you do not want any data to be gathered, you can turn off this feature by setting `health_record` to `false` in your `config.json`.
 
-## Wiki
-All information on [Getting Started](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Getting-Started) is available in the [Wiki](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/)!
-- __Installation__
-  - [Requirements] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#requirements-click-each-one-for-install-guide)
-  - [How to run with Docker](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/How-to-run-with-Docker)
-  - [Linux] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-linux)
-  - [Mac] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-mac)
-  - [Windows] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Installation#installation-windows)
-- [Develop PokemonGo-Bot](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Develop-PokemonGo-Bot)
-- [Plugins](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/plugins.md)
-- [Configuration-files](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Configuration-files)
-- [Front end web module - Google Maps API] (https://github.com/PokemonGoF/PokemonGo-Bot/wiki/Google-Maps-API-(web-page))
-- [Docker Usage](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/FAQ#how-to-run-with-docker)
-- [FAQ](https://github.com/PokemonGoF/PokemonGo-Bot/wiki/FAQ)
+## Help Needed on [Desktop Version](https://github.com/PokemonGoF/PokemonGo-Bot-Desktop)
 
-To ensure that all updates are documented - [@eggins](https://github.com/eggins) will keep the Wiki updated with the latest information on installing, updating and configuring the bot.
 
 ## Credits
 - [tejado](https://github.com/tejado) many thanks for the API

diff --git a/configs/config.json.cluster.example b/configs/config.json.cluster.example
@@ -9,6 +9,16 @@
       {
         "type": "HandleSoftBan"
       },
+      {
+        "type": "SleepSchedule",
+        "config": {
+          "enabled": false,
+          "time": "22:54",
+          "duration":"7:46",
+          "time_random_offset": "00:24",
+          "duration_random_offset": "00:43"
+        }
+      },
       {
         "type": "CollectLevelUpReward"
       },
@@ -18,6 +28,16 @@
           "longer_eggs_first": true
         }
       },
+      {
+        "type": "UpdateLiveStats",
+        "config": {
+          "enabled": false,
+          "min_interval": 10,
+          "stats": ["uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
+          "terminal_log": true,
+          "terminal_title": true
+        }
+      },
       {
         "type": "TransferPokemon"
       },
@@ -78,7 +98,6 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
     "logging_color": true,

diff --git a/configs/config.json.example b/configs/config.json.example
@@ -9,6 +9,16 @@
       {
         "type": "HandleSoftBan"
       },
+      {
+        "type": "SleepSchedule",
+        "config": {
+          "enabled": false,
+          "time": "22:54",
+          "duration":"7:46",
+          "time_random_offset": "00:24",
+          "duration_random_offset": "00:43"
+        }
+      },
       {
         "type": "CollectLevelUpReward"
       },
@@ -18,6 +28,16 @@
           "longer_eggs_first": true
         }
       },
+      {
+        "type": "UpdateLiveStats",
+        "config": {
+          "enabled": false,
+          "min_interval": 10,
+          "stats": ["uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
+          "terminal_log": true,
+          "terminal_title": true
+        }
+      },
       {
         "type": "TransferPokemon"
       },
@@ -93,7 +113,6 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
     "logging_color": true,

diff --git a/configs/config.json.map.example b/configs/config.json.map.example
@@ -9,6 +9,16 @@
       {
         "type": "HandleSoftBan"
       },
+      {
+        "type": "SleepSchedule",
+        "config": {
+          "enabled": false,
+          "time": "22:54",
+          "duration":"7:46",
+          "time_random_offset": "00:24",
+          "duration_random_offset": "00:43"
+        }
+      },
       {
         "type": "CollectLevelUpReward"
       },
@@ -18,6 +28,16 @@
           "longer_eggs_first": true
         }
       },
+      {
+        "type": "UpdateLiveStats",
+        "config": {
+          "enabled": false,
+          "min_interval": 10,
+          "stats": ["uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
+          "terminal_log": true,
+          "terminal_title": true
+        }
+      },
       {
         "type": "TransferPokemon"
       },
@@ -320,7 +340,6 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
     "logging_color": true,

diff --git a/configs/config.json.path.example b/configs/config.json.path.example
@@ -9,6 +9,16 @@
       {
         "type": "HandleSoftBan"
       },
+      {
+        "type": "SleepSchedule",
+        "config": {
+          "enabled": false,
+          "time": "22:54",
+          "duration":"7:46",
+          "time_random_offset": "00:24",
+          "duration_random_offset": "00:43"
+        }
+      },
       {
         "type": "CollectLevelUpReward"
       },
@@ -18,6 +28,16 @@
           "longer_eggs_first": true
         }
       },
+      {
+        "type": "UpdateLiveStats",
+        "config": {
+          "enabled": false,
+          "min_interval": 10,
+          "stats": ["uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
+          "terminal_log": true,
+          "terminal_title": true
+        }
+      },
       {
         "type": "TransferPokemon"
       },
@@ -80,7 +100,6 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
     "logging_color": true,

diff --git a/configs/config.json.pokemon.example b/configs/config.json.pokemon.example
@@ -9,6 +9,16 @@
       {
         "type": "HandleSoftBan"
       },
+      {
+        "type": "SleepSchedule",
+        "config": {
+          "enabled": false,
+          "time": "22:54",
+          "duration":"7:46",
+          "time_random_offset": "00:24",
+          "duration_random_offset": "00:43"
+        }
+      },
       {
         "type": "CollectLevelUpReward"
       },
@@ -18,6 +28,16 @@
           "longer_eggs_first": true
         }
       },
+      {
+        "type": "UpdateLiveStats",
+        "config": {
+          "enabled": false,
+          "min_interval": 10,
+          "stats": ["uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
+          "terminal_log": true,
+          "terminal_title": true
+        }
+      },
       {
         "type": "TransferPokemon"
       },
@@ -86,7 +106,6 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
     "logging_color": true,

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -3,18 +3,19 @@ services:
   bot1-pokego:
     build: .
     volumes:
-     - ./configs/config.json:/usr/src/app/configs/config.json
+     - ./configs:/usr/src/app/configs
+     - ./web:/usr/src/app/web
     stdin_open: true
     tty: true
   bot1-pokegoweb:
     image: python:2.7
     ports:
      - "8000:8000"
     volumes_from:
-     - bot1-pokego
+      - bot1-pokego
     volumes:
-     - ./configs/userdata.js:/usr/src/app/web/config/userdata.js
+      - ./configs:/usr/src/app/web/config
     working_dir: /usr/src/app/web
     command: bash -c "echo 'Serving HTTP on 0.0.0.0 port 8000' && python -m SimpleHTTPServer > /dev/null 2>&1"
     depends_on:
-     - bot1-pokego
+     - bot1-pokego
diff --git a/docs/docker.md b/docs/docker.md
@@ -1,17 +1,34 @@
-Start by downloading for your platform: [Mac](https://www.docker.com/products/docker#/mac), [Windows](https://www.docker.com/products/docker#/windows), or [Linux](https://www.docker.com/products/docker#/linux). Once you have Docker installed, simply create the various config.json files for your different accounts (e.g. `configs/config-account1.json`) and then create a Docker image for PokemonGo-Bot using the Dockerfile in this repo.
+Start by downloading for your platform: [Mac](https://www.docker.com/products/docker#/mac), [Windows](https://www.docker.com/products/docker#/windows), or [Linux](https://www.docker.com/products/docker#/linux). Once you have Docker installed, simply create the various config.json files for your different accounts (e.g. `configs/config-account1.json`) and then create a Docker image for PokemonGo-Bot using the Dockerfile in this [repo](https://hub.docker.com/r/svlentink/pokemongo-bot/).
+
+#Setup
+##Automatic setup
+Use this docker hub url: https://hub.docker.com/r/svlentink/pokemongo-bot/
+```
+docker pull svlentink/pokemongo-bot
+```
+
+##Manual setup
 ```
 cd PokemonGo-Bot
 docker build -t pokemongo-bot .
 ```
+
+#Run
+
 You can verify that the image was created with:
 ```
 docker images
 ```
+- In case of automatic setup, you'll see an image called: `svlentink/pokemongo-bot`
+- In case of manual setup, you'll see an image called: `pokemongo-bot`
 
 To run PokemonGo-Bot Docker image you've created, simple run:
 ```
-docker run --name=pokego-bot1 --rm -it -v $(pwd)/configs/config-account1.json:/usr/src/app/configs/config.json pokemongo-bot
+docker run --name=pokego-bot1 --rm -it -v $(pwd)/configs/config-account1.json:/usr/src/app/configs/config.json -v $(pwd)/data:/usr/src/app/data pokemongo-bot
 ```
+
+Replace `pokemongo-bot` with `svlentink/pokemongo-bot` in case you followed automatic setup.
+
 _Check the logs in real-time `docker logs -f pgobot`_
 
 If you want to run multiple accounts with the same Docker image, simply specify different config.json and names in the Docker run command.

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,7 +1,12 @@
 ### How do I start the application?
-After customizing your config.json files, cd to the PokemonGo-Bot folder and enter:
+After [installing] (https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md), in the root folder run the following command:
+### Linux
 ```
-$ python pokecli.py
+run.sh
+```
+### Windows
+```
+run.bat
 ```
 This will start the application.