Merge branch 'dev' into nickname_locale

* dev: (143 commits) small fix in VOLUME in Dockerfile (PokemonGoF#3779) Pokemon optimizer enhancements (PokemonGoF#3743) added action_delay when recycling items (PokemonGoF#3799) Fix incorrect variable name in pokemon_catch_worker that makes bot unusable (PokemonGoF#3780) Clean old catch parameters (PokemonGoF#3776) Revert PokemonGoF#3500 Fix error when MoveToFort called from handle_soft_ban.py (PokemonGoF#3772) Writing the location file to fix the web ui (PokemonGoF#3767) Update installation.md (PokemonGoF#3764) Added Procfile to deploy to Heroku (PokemonGoF#3719) Rewrite NicknamePokemon for new Inventory sysem + a lot of new keys for 'nickname_template' option (PokemonGoF#3756) Update use ultraball with constraint (PokemonGoF#3760) Cache recent forts (for forts.max_circle_size) (PokemonGoF#3556) Update configuration_files.md (PokemonGoF#3742) Add and Remove pokemon from the inventory cache when catch, release and evolve (PokemonGoF#3738) Use Ultraball If No Other Balls (With Constraint) (PokemonGoF#3421) Modify pokemon_catch_worker.py to use Inventory class and fix PokemonGoF#3411 (PokemonGoF#3496) Update docker.md Heaps of updates to docs and other small errors in running the bot. (PokemonGoF#3593) Fixed EventManager handlers to be list instead of tuple (PokemonGoF#3734) Config/encrypt fix (PokemonGoF#3707) ...
mhdasding · Aug 13, 2016 · 66bc80b · 66bc80b
2 parents e603836 + d4200e9
commit 66bc80b
Show file tree

Hide file tree

Showing 80 changed files with 9,711 additions and 3,315 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,13 +1,23 @@
+## Stop! Before you create this issue (you can delete this section when opening the issue):
+1. Have you validated that your config.json is valid JSON? Use http://jsonlint.com/ to check.
+2. Have you searched to see if there are other issues for the same issue? If so, comment on that issue instead.
+3. Are you running `master`? We work on the `dev` branch and then add that functionality to `master`. Your issue may be fixed on `dev` and there is no need for this issue, just wait and it will eventually be merged to `master`.
+
 ### Expected Behavior
 
 
 ### Actual Behavior
 
 
+### Your config.json (remove your credentials and any other private info)
+```
+your config here
+```
+
 ### Steps to Reproduce
 
 
 ### Other Information
-OS: 
+OS:
 Git Commit: (run 'git log -n 1 --pretty=format:"%H"' and paste it here)
 Python Version: (run 'python -V' and paste it here)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,15 @@
-Short Description: 
+# Please Note (you may remove this section before opening your PR):
+We receive lots of PRs and it is hard to give proper review to PRs. Please make it easy on us by following these guidelines:
 
-Fixes:
-- 
-- 
-- 
+1. We do not accept changes to `master`. Please make sure your pull request is aimed at `dev`.
+2. If you changed a bunch of files (that aren't config files) or multiple workers to implement your feature, it probably won't get proper attention. Please split it up into multiple, smaller, more focused, and iterative PRs if you can.
+3. If you are adding a config value to something, make sure you update the appropriate `config.json` example files.
+
+
+## Short Description:
+
+## Fixes (provide links to github issues if you can):
+-
+-
+-
 
diff --git a/.gitignore b/.gitignore
@@ -35,6 +35,9 @@ var/
 .pydevproject
 .settings/
 
+# Cloud9 Users
+.c9/
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
@@ -86,6 +89,8 @@ celerybeat-schedule
 # virtualenv
 venv/
 ENV/
+local/
+share/
 
 # Spyder project settings
 .spyderproject
@@ -95,6 +100,7 @@ ENV/
 
 # PyCharm IDE settings
 .idea/
+*.iml
 
 # Personal load details
 src/
@@ -113,10 +119,14 @@ configs/*
 !configs/config.json.map.example
 !configs/path.example.json
 !config.json.cluster.example
+!config.json.optimizer.example
 
 # Virtualenv folders
 bin/
 include/
 
 # Pip check file
 pip-selfcheck.json
+
+# Some love for the vim users
+.*.sw*
diff --git a/.mention-bot b/.mention-bot
@@ -0,0 +1,3 @@
+{
+  "userBlacklist": ["tejado"]
+}
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -51,4 +51,21 @@
  * matheussampaio
  * Abraxas000
  * lucasfevi
+ * pokepal
  * Moonlight-Angel
+ * mjmadsen
+ * nikofil
+ * bigkraig
+ * nikhil-pandey
+ * thebigjc
+ * JaapMoolenaar
+ * eevee-github
+ * g0vanish
+ * cmezh
+ * Nivong
+ * kestel
+ * simonsmh
+ * joaodragao
+ * extink
+ * Quantra
+ * pmquan
diff --git a/Dockerfile b/Dockerfile
@@ -1,20 +1,26 @@
-FROM python:2.7-onbuild
+FROM python:2.7
+
+WORKDIR /usr/src/app
+VOLUME ["/usr/src/app/configs", "/usr/src/app/web"]
 
 ARG timezone=Etc/UTC
 RUN echo $timezone > /etc/timezone \
     && ln -sfn /usr/share/zoneinfo/$timezone /etc/localtime \
     && dpkg-reconfigure -f noninteractive tzdata
 
-RUN apt-get update \
-    && apt-get install -y python-protobuf
 RUN cd /tmp && wget "http://pgoapi.com/pgoencrypt.tar.gz" \
     && tar zxvf pgoencrypt.tar.gz \
     && cd pgoencrypt/src \
     && make \
-    && cp libencrypt.so /usr/src/app/encrypt.so
-
-VOLUME ["/usr/src/app/web"]
+    && cp libencrypt.so /usr/src/app/encrypt.so \
+    && cd /tmp \
+    && rm -rf /tmp/pgoencrypt*
 
 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/Procfile b/Procfile
@@ -0,0 +1 @@
+worker: python pokecli.py $EXTRA_ARGS
diff --git a/README.md b/README.md
@@ -1,20 +1,15 @@
-
 # 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`.
-
 
-## Where to get the dll/so ?
-You need grab them from internet.
+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)
+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)
-- [Donation](#donation)
-
 
 ## Features
 - [x] GPS Location configuration
@@ -28,9 +23,9 @@ We use [Slack](https://slack.com) as a web chat. [Click here to join the chat!](
 - [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
 
@@ -46,28 +41,16 @@ 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)
-- [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
+- [U6 Group](http://pgoapi.com) for the U6
 - [Mila432](https://github.com/Mila432/Pokemon_Go_API) for the login secrets
 - [elliottcarlson](https://github.com/elliottcarlson) for the Google Auth PR
 - [AeonLucid](https://github.com/AeonLucid/POGOProtos) for improved protos
 - [AHAAAAAAA](https://github.com/AHAAAAAAA/PokemonGo-Map) for parts of the s2sphere stuff
 
 
-[![Analytics](https://ga-beacon.appspot.com/UA-81468120-1/welcome-page-dev)](https://github.com/igrigorik/ga-beacon)
+[![Analytics](https://ga-beacon.appspot.com/UA-81468120-1/welcome-page-master)](https://github.com/igrigorik/ga-beacon)
diff --git a/configs/config.json.cluster.example b/configs/config.json.cluster.example
@@ -4,10 +4,21 @@
     "password": "YOUR_PASSWORD",
     "location": "SOME_LOCATION",
     "gmapkey": "GOOGLE_MAPS_API_KEY",
+    "encrypt_location": "",
     "tasks": [
       {
         "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"
       },
@@ -17,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"
       },
@@ -35,6 +56,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },
@@ -76,9 +98,10 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
+    "min_ultraball_to_keep": 10,
+    "logging_color": true,
     "catch": {
       "any": {"catch_above_cp": 0, "catch_above_iv": 0, "logic": "or"},
       "// Example of always catching Rattata:": {},

diff --git a/configs/config.json.example b/configs/config.json.example
@@ -4,10 +4,21 @@
     "password": "YOUR_PASSWORD",
     "location": "SOME_LOCATION",
     "gmapkey": "GOOGLE_MAPS_API_KEY",
+    "encrypt_location": "",
     "tasks": [
       {
         "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"
       },
@@ -17,9 +28,26 @@
           "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"
       },
+      {
+        "type": "NicknamePokemon",
+        "config": {
+          "enabled": false,
+          "nickname_template": "{iv_pct}_{iv_ads}"
+        }
+      },
       {
         "type": "EvolvePokemon",
         "config": {
@@ -35,6 +63,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },
@@ -72,7 +101,8 @@
     "map_object_cache_time": 5,
     "forts": {
       "avoid_circles": true,
-      "max_circle_size": 50
+      "max_circle_size": 50,
+      "cache_recent_forts": true
     },
     "websocket_server": false,
     "walk": 4.16,
@@ -84,14 +114,22 @@
     "location_cache": true,
     "distance_unit": "km",
     "reconnecting_timeout": 15,
-    "evolve_captured": "NONE",
     "catch_randomize_reticle_factor": 1.0,
     "catch_randomize_spin_factor": 1.0,
+    "min_ultraball_to_keep": 10,
+    "logging_color": true,
     "catch": {
       "any": {"catch_above_cp": 0, "catch_above_iv": 0, "logic": "or"},
       "// Example of always catching Rattata:": {},
       "// Rattata": { "always_catch" : true }
     },
+    "catch_throw_parameters": {
+      "excellent_rate": 0.1,
+      "great_rate": 0.5,
+      "nice_rate": 0.3,
+      "normal_rate": 0.1,
+      "spin_success_rate" : 0.6
+    },
     "release": {
       "any": {"release_below_cp": 0, "release_below_iv": 0, "logic": "or"},
       "// Example of always releasing Rattata:": {},