Buddy Pokemon task

configs/config.json.cluster.example

@@ -38,6 +38,21 @@
           "level_limit": -1
         }
       },
+      {
+        "type": "BuddyPokemon",
+        "config": {
+          "enabled": true,
+          "buddy_list": "dratini, magikarp",
+          "best_in_family": true,
+          "// candy_limit = 0 means no limit, so it will never change current buddy": {},
+          "candy_limit": 0,
+          "// force_first_change = true will always change buddy at start removing current one": {},
+          "force_first_change": false,
+          "buddy_change_wait_min": 3,
+          "buddy_change_wait_max": 5,
+          "min_interval": 120
+        }
+      },
       {
         "type": "IncubateEggs",
         "config": {

configs/config.json.example

@@ -75,6 +75,21 @@
           "level_limit": -1
         }
       },
+      {
+        "type": "BuddyPokemon",
+        "config": {
+          "enabled": true,
+          "buddy_list": "dratini, magikarp",
+          "best_in_family": true,
+          "// candy_limit = 0 means no limit, so it will never change current buddy": {},
+          "candy_limit": 0,
+          "// force_first_change = true will always change buddy at start removing current one": {},
+          "force_first_change": false,
+          "buddy_change_wait_min": 3,
+          "buddy_change_wait_max": 5,
+          "min_interval": 120
+        }
+      },
       {
         "type": "IncubateEggs",
         "config": {

configs/config.json.map.example

@@ -38,6 +38,21 @@
           "level_limit": -1
         }
       },
+      {
+        "type": "BuddyPokemon",
+        "config": {
+          "enabled": true,
+          "buddy_list": "dratini, magikarp",
+          "best_in_family": true,
+          "// candy_limit = 0 means no limit, so it will never change current buddy": {},
+          "candy_limit": 0,
+          "// force_first_change = true will always change buddy at start removing current one": {},
+          "force_first_change": false,
+          "buddy_change_wait_min": 3,
+          "buddy_change_wait_max": 5,
+          "min_interval": 120
+        }
+      },
       {
         "type": "IncubateEggs",
         "config": {

configs/config.json.path.example

@@ -38,6 +38,21 @@
           "level_limit": -1
         }
       },
+      {
+        "type": "BuddyPokemon",
+        "config": {
+          "enabled": true,
+          "buddy_list": "dratini, magikarp",
+          "best_in_family": true,
+          "// candy_limit = 0 means no limit, so it will never change current buddy": {},
+          "candy_limit": 0,
+          "// force_first_change = true will always change buddy at start removing current one": {},
+          "force_first_change": false,
+          "buddy_change_wait_min": 3,
+          "buddy_change_wait_max": 5,
+          "min_interval": 120
+        }
+      },
       {
         "type": "IncubateEggs",
         "config": {

configs/config.json.pokemon.example

@@ -38,6 +38,21 @@
           "level_limit": -1
         }
       },
+      {
+        "type": "BuddyPokemon",
+        "config": {
+          "enabled": true,
+          "buddy_list": "dratini, magikarp",
+          "best_in_family": true,
+          "// candy_limit = 0 means no limit, so it will never change current buddy": {},
+          "candy_limit": 0,
+          "// force_first_change = true will always change buddy at start removing current one": {},
+          "force_first_change": false,
+          "buddy_change_wait_min": 3,
+          "buddy_change_wait_max": 5,
+          "min_interval": 120
+        }
+      },
       {
         "type": "IncubateEggs",
         "config": {

docs/configuration_files.md

@@ -54,6 +54,7 @@
 - [Telegram Task](#telegram-task)
 - [Discord Task](#discord-task)
 - [CompleteTutorial](#completetutorial)
+- [BuddyPokemon](#buddypokemon)
 
 #Configuration files
 
@@ -1216,11 +1217,53 @@ Available `team` :
 [[back to top](#table-of-contents)]
 ```json
 {
-	"type": "CompleteTutorial",
-	"config": {
-	"enabled": true,
-		"nickname": "PokemonGoF",
-		"team": 2
-	}
+  "type": "CompleteTutorial",
+  "config": {
+  "enabled": true,
+    "nickname": "PokemonGoF",
+    "team": 2
+  }
+}
+```
+
+## BuddyPokemon
+[[back to top](#table-of-contents)]
+
+### Description
+[[back to top](#table-of-contents)]
+
+Makes use of the Pokemon Buddy system.
+It's able to switch the buddy automatically given an list of pokemon that should be using this feature.
+Periodically logs the status of the buddy walking.
+After setting a buddy it's not possible to remove it, only change it. So if a buddy is already selected and no buddy list is given, it will still run with the buddy already selected.
+
+### Options
+[[back to top](#table-of-contents)]
+
+* `buddy_list`: `Default: []`. List of pokemon names that will be used as buddy. If '[]' or 'none', will not use or change buddy.
+* `best_in_family`: `Default: True`. If True, picks best Pokemon in the family (sorted by cp).
+* `candy_limit`: `Default: 0`. Set the candy limit to be rewarded per buddy, when reaching this limit the bot will change the buddy to the next in the list. When candy_limit = 0 or only one buddy in list, it has no limit and never changes buddy.
+* `force_first_change`: `Default: False`. If True, will try to change buddy at bot start according to the buddy list. If False, will use the buddy already set until candy_limit is reached and then use the buddy list.
+* `buddy_change_wait_min`: `Default: 3`. Minimum time (in seconds) that the buddy change takes.
+* `buddy_change_wait_max`: `Default: 5`. Maximum time (in seconds) that the buddy change takes.
+* `min_interval`: `Default: 120`. Time (in seconds) to periodically log the buddy walk status.
+
+### Sample configuration
+[[back to top](#table-of-contents)]
+```json
+{
+  "type": "BuddyPokemon",
+    "config": {
+      "enabled": true,
+        "buddy_list": "dratini, magikarp",
+        "best_in_family": true,
+        "// candy_limit = 0 means no limit, so it will never change current buddy": {},
+        "candy_limit": 0,
+        "// force_first_change = true will always change buddy at start removing current one": {},
+        "force_first_change": false,
+        "buddy_change_wait_min": 3,
+        "buddy_change_wait_max": 5,
+        "min_interval": 120
+  }
 }
 ```

pokemongo_bot/__init__.py

@@ -689,6 +689,29 @@ def _register_events(self):
             'use_incense',
             parameters=('type', 'incense_count')
         )
+        # BuddyPokemon
+        self.event_manager.register_event(
+            'buddy_update',
+            parameters=('name')
+        )
+        self.event_manager.register_event(
+            'buddy_update_fail',
+            parameters=('name', 'error')
+        )
+        self.event_manager.register_event(
+            'buddy_candy_earned',
+            parameters=('candy', 'family', 'quantity', 'candy_earned', 'candy_limit')
+        )
+        self.event_manager.register_event('buddy_candy_fail')
+        self.event_manager.register_event(
+            'buddy_next_reward',
+            parameters=('name', 'km_walked', 'km_total')
+        )
+        self.event_manager.register_event('buddy_keep_active')
+        self.event_manager.register_event(
+            'buddy_not_available',
+            parameters=('name')
+        )
 
         # Sniper
         self.event_manager.register_event('sniper_log', parameters=('message', 'message'))

pokemongo_bot/cell_workers/__init__.py

@@ -30,3 +30,4 @@
 from .use_incense import UseIncense
 from .camp_fort import CampFort
 from .discord_task import DiscordTask
+from .buddy_pokemon import BuddyPokemon