PokemonGoF · solderzzc · Aug 9, 2016 · Aug 7, 2016 · Aug 7, 2016 · Aug 7, 2016
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,15 +1,23 @@
-Please check configuration at http://jsonlint.com/ before posting an issue.
+## 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
@@ -125,3 +125,6 @@ include/
 
 # Pip check file
 pip-selfcheck.json
+
+# Some love for the vim users
+.*.sw*
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -51,6 +51,11 @@
  * matheussampaio
  * Abraxas000
  * lucasfevi
+ * pokepal
  * Moonlight-Angel
  * mjmadsen
  * nikofil
+ * bigkraig
+ * nikhil-pandey
+ * thebigjc
+ * JaapMoolenaar
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
 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)
 
 We use [Slack](https://slack.com) as a web chat. [Click here to join the chat!](https://pokemongo-bot.herokuapp.com)
@@ -12,8 +14,6 @@ You can count on the community in #help channel.
 - [Features](#features)
 - [Wiki](#wiki)
 - [Credits](#credits)
-- [Donation](#donation)
-
 
 ## Features
 - [x] GPS Location configuration
@@ -54,6 +54,7 @@ All information on [Getting Started](https://github.com/PokemonGoF/PokemonGo-Bot
   - [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)

diff --git a/configs/config.json.cluster.example b/configs/config.json.cluster.example
@@ -36,6 +36,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },

diff --git a/configs/config.json.example b/configs/config.json.example
@@ -36,6 +36,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },

diff --git a/configs/config.json.map.example b/configs/config.json.map.example
@@ -33,6 +33,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },
@@ -58,8 +59,11 @@
           "address": "http://localhost:5000",
           "max_distance": 500,
           "min_time": 60,
+          "min_ball": 50,
           "prioritize_vips": true,
-          "snipe": false,
+          "snipe": true,
+          "snipe_high_prio_only": true,
+          "snipe_high_prio_threshold": 400,
           "update_map": true,
           "mode": "priority",
           "catch": {

diff --git a/configs/config.json.path.example b/configs/config.json.path.example
@@ -36,6 +36,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },
@@ -59,6 +60,7 @@
         "type": "FollowPath",
         "config": {
           "path_mode": "loop",
+          "path_start_mode": "first",
           "path_file": "configs/path.example.json"
         }
       }

diff --git a/configs/config.json.pokemon.example b/configs/config.json.pokemon.example
@@ -36,6 +36,7 @@
       {
         "type": "RecycleItems",
         "config": {
+          "min_empty_space": 15,
           "item_filter": {
             "Pokeball":       { "keep" : 100 },
             "Potion":         { "keep" : 10 },

diff --git a/docs/plugins.md b/docs/plugins.md
@@ -0,0 +1,66 @@
+# PokemonGo-Bot Plugins
+Plugins are collections of tasks distributed outside of the main repo. Using plugins lets you use community built tasks that haven't been accepted into the core bot. Some tasks are better suited to not live in the main bot. An example might be a task that reports seen pokemon to a central server.
+
+## Using Plugins
+Plugins are used by adding some new information to your `config.json`.
+
+In your `config.json`, you can add a new array:
+
+```
+  ...
+  "plugins": [
+  ],
+  ...
+```
+
+In this array, you can put a Github URL that contains the revision you want to use. For example:
+
+```
+  ...
+  "plugins": [
+    "TheSavior/test-pgo-plugin#2d54eddde33061be9b329efae0cfb9bd58842655"
+  ],
+  ...
+```
+
+Once that is there, you can add to your `tasks` array the task you want to use from the plugin. Plugins can expose many tasks, check the plugin's documentation for what tasks can be used.
+
+```
+  ...
+  "tasks": [
+    {
+      "type": "test-pgo-plugin.PrintText"
+    }
+  ]
+  ..
+```
+
+Then start the bot. It will download the specified plugins and use them when requested in your `tasks` list.
+
+## Developing Plugins
+The plugins array can be given a full path to a folder containing a plugin as well as the github url format. When developing a plugin, use a directory outside the root of the bot and add it to your plugins array. Unlike the github url format, it won't be copied to the bot when it is started up, it will be loaded directly from the specified directory.
+
+Plugins have access to any of the things that the tasks in the official repo have access to.
+
+### Example
+I recommend looking at this plugin for an example of how to write a plugin: https://github.com/TheSavior/test-pgo-plugin
+
+### API Versioning
+We may at some point need to make a backwards incompatible change to the plugin BaseTask. We will avoid this as much as possible, but in the event that occurs, this is how incompatibilities are detected:
+
+The `BaseTask` class specifies:
+
+```
+class BaseTask(object):
+  TASK_API_VERSION = 1
+```
+
+When we need to make a backwards incompatible change, we will increment that number. Plugins have the following:
+
+```
+class PrintText(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+```
+
+If a user tries to use a plugin that has a `SUPPORTED_TASK_API_VERSION` that does not match the current bot's `TASK_API_VERSION`, an exception will be raised.
+
diff --git a/install.sh b/install.sh
@@ -1,19 +1,62 @@
 #!/usr/bin/env bash
-
-# Setup Python virtualenv
-echo "Setting up Python virtualenv..."
-eval "virtualenv ."
-eval "source bin/activate"
-echo "Python virtualenv setup successfully."
-
-# Install pip requirements
-echo "Installing pip requirements..."
-eval "pip install -r requirements.txt"
-echo "Installed pip requirements."
-echo "Installing and updating git submodules..."
-
-# Install git submodules
-eval "cd ./web && git submodule init && cd .."
-eval "git submodule update"
-echo "Done."
-echo "Please create and setup configs/config.json. Then, run 'python pokecli.py --config ./configs/config.json' or './run.sh' on Mac/Linux"
+pokebotpath=$(pwd)
+cd $pokebotpath
+if [ -f /etc/debian_version ]
+then
+echo "You are on Debian/Ubuntu"
+sudo apt-get update
+sudo apt-get -y install python python-pip python-dev build-essential git python-protobuf virtualenv 
+elif [ -f /etc/redhat-release ]
+then
+echo "You are on CentOS/RedHat"
+sudo yum -y install epel-release
+sudo yum -y install python-pip
+elif [ "$(uname -s)" == "Darwin" ]
+then
+echo "You are on Mac os"
+sudo brew update 
+sudo brew install --devel protobuf
+else
+echo "Nothing happend."
+fi
+pip install virtualenv
+cd $pokebotpath
+git pull
+git submodule init
+git submodule foreach git pull origin master
+virtualenv .
+source bin/activate
+pip install -r requirements.txt
+echo "Start to make encrypt.so"
+wget http://pgoapi.com/pgoencrypt.tar.gz
+tar -xf pgoencrypt.tar.gz 
+cd pgoencrypt/src/ 
+make
+mv libencrypt.so $pokebotpath/encrypt.so
+cd ../..
+rm -rf pgoencrypt.tar.gz
+rm -rf pgoencrypt
+echo "Install complete."
+cd $pokebotpath
+read -p "1.google 2.ptc 
+" auth
+read -p "Input username 
+" username
+read -p "Input password 
+" -s password
+read -p "
+Input location 
+" location
+read -p "Input gmapkey 
+" gmapkey
+cp configs/config.json.example configs/config.json
+if [ "$auth" = "2" ]
+then
+sed -i "s/google/ptc/g" configs/config.json
+fi
+sed -i "s/YOUR_USERNAME/$username/g" configs/config.json
+sed -i "s/YOUR_PASSWORD/$password/g" configs/config.json
+sed -i "s/SOME_LOCATION/$location/g" configs/config.json
+sed -i "s/GOOGLE_MAPS_API_KEY/$gmapkey/g" configs/config.json
+echo "Edit configs/config.json to modify any other config. Use run.sh to run."
+exit 0