Merge pull request jekirl#190 from sftwninja/needy-farmables

Allow bot to stop catching pokemon and farm balls when inventory is depleted

Author: J-e-k

README.md

@@ -52,7 +52,13 @@ optional arguments:
      * `BIG_EGGS_FIRST` incubate big eggs (most km) first (default: true)
     * `RELEASE_DUPLICATES` The bot seems to have a bad habit of hoarding pokemon. Enabling this feature (disabled by default) will have the bot automatically transfer pokemon that are duplicates. To determine which pokemon to transfer when duplicates exist, the lvl's of the pokemon are compared. A pokemon's lvl is an arbitrary and configurable parameter that can either be representative of a pokemon's CP, IV, CPxIV, or CP+IV. The bot will transfer the lowest lvl pokemon, maintaining` MIN_SIMILAR_POKEMON` of each type. To be completely confident that the bot will not transfer your high lvl pokemon, when this feature is enabled only pokemon with a lvl below `RELEASE_DUPLICATES_MAX_LVL`. If you have multiple pokemon that are close to the same lvl the bot can be configured to not transfer them by using `RELEASE_DUPLICATES_SCALER`. The value of this config is multiplied by the highest lvl pokemon of a type and only those pokemon that are less than the scaled lvl are transfered.
      * EXAMPlES: If you set lvl to "IV" while having two Snorlaxs, one with stats CP:14 IV:95 and the other with CP:1800 IV:30 the bot will transfer the Snorlax with CP of 1800 and keep the CP 14 Snorlax because you have indicated you only care about a pokemon's IV. It must be fully understood why this happens to avoid unwanted transfer of pokemon. If not used correctly this feature can very easily transfer a large ammount of your pokemon so please make sure you fully understand it's mechanics before attempting use!
-
+    * `NEEDY_ITEM_FARMING` [Experimental] will cease trying to catch pokemon and roam around to collect more pokeballs when inventory is low
+     * `ENABLE` : `Boolean`, whether or not this feature is enabled
+     * `POKEBALL_FARM_THRESHOLD` : `Integer`, when the observed pokeball count drops on or below this number, skip catching pokemon and begin collecting.
+     * `POKEBALL_CONTINUE_THRESHOLD`: `Integer`, when the observed pokeball count reaches this amount, stop farming and go back to catching pokemon.
+     * `FARM_IGNORE_POKEBALL_COUNT`: `Boolean`, Whether to include this ball in counting. Same goes for `GREATBALL`, `ULTRABALL`, and `MASTERBALL`. Masterball is ignored by default.
+     * `FARM_OVERRIDE_STEP_SIZE`: `Integer`, When it goes into farming mode, the bot assumes this step size to potentially speed up resource gathering. _This might lead to softbans._ Setting to `-1` disables this feature. Disabled by default for safety.
+     * If `EXPERIMENTAL` OR `CATCH_POKEMON` are false, this configuration will disable itself.
 
 ## Requirements
  * Run `pip install -r requirements.txt`

config.json.example

@@ -31,6 +31,16 @@
         "ITEM_MAX_REVIVE": 10,
         "ITEM_RAZZ_BERRY": 10
       },
+      "NEEDY_ITEM_FARMING": {
+        "ENABLE": true,
+        "POKEBALL_CONTINUE_THRESHOLD": 50,
+        "POKEBALL_FARM_THRESHOLD": 10,
+        "FARM_IGNORE_POKEBALL_COUNT": false,
+        "FARM_IGNORE_GREATBALL_COUNT": false,
+        "FARM_IGNORE_ULTRABALL_COUNT": false,
+        "FARM_IGNORE_MASTERBALL_COUNT": true,
+        "FARM_OVERRIDE_STEP_SIZE": -1
+      },
       "POKEMON_EVOLUTION": {
         "PIDGEY": 12,
         "WEEDLE":12

pgoapi/pgoapi.py

@@ -75,6 +75,8 @@ def __init__(self, config, pokemon_names):
         self._heartbeat_number = 5
         self._firstRun = True
         self._last_egg_use_time = 0
+        self._farm_mode_triggered = False
+        self._orig_step_size = config.get("STEP_SIZE", 200)
 
         self.pokemon_caught = 0
         self.player = Player({})
@@ -97,6 +99,10 @@ def __init__(self, config, pokemon_names):
             self.POKEMON_EVOLUTION[getattr(Enums_pb2, k)] = v
             self.POKEMON_EVOLUTION_FAMILY[getattr(Enums_pb2, k)] = getattr(Enums_pb2, "FAMILY_" + k)
 
+        self.experimental = config.get("EXPERIMENTAL", False)
+
+        self.STEP_SIZE = self._orig_step_size
+
         self.KEEP_IV_OVER = config.get("KEEP_IV_OVER", 0)  # release anything under this
         self.KEEP_CP_OVER = config.get("KEEP_CP_OVER", 0)  # release anything under this
 
@@ -110,8 +116,17 @@ def __init__(self, config, pokemon_names):
         self.USE_DISPOSABLE_INCUBATORS = config.get("EGG_INCUBATION", {}).get("USE_DISPOSABLE_INCUBATORS", False)
         self.INCUBATE_BIG_EGGS_FIRST = config.get("EGG_INCUBATION", {}).get("BIG_EGGS_FIRST", True)
 
+        self.FARM_ITEMS_ENABLED = config.get("NEEDY_ITEM_FARMING", {}).get("ENABLE", True and self.experimental) # be concious of pokeball/item limits
+        self.POKEBALL_CONTINUE_THRESHOLD = config.get("NEEDY_ITEM_FARMING", {}).get("POKEBALL_CONTINUE_THRESHOLD", 50) # keep at least 10 pokeballs of any assortment, otherwise go farming
+        self.POKEBALL_FARM_THRESHOLD = config.get("NEEDY_ITEM_FARMING", {}).get("POKEBALL_FARM_THRESHOLD", 10) # at this point, go collect pokeballs
+        self.FARM_IGNORE_POKEBALL_COUNT = config.get("NEEDY_ITEM_FARMING", {}).get("FARM_IGNORE_POKEBALL_COUNT", False) # ignore pokeballs in the continue tally
+        self.FARM_IGNORE_GREATBALL_COUNT = config.get("NEEDY_ITEM_FARMING", {}).get("FARM_IGNORE_GREATBALL_COUNT", False) # ignore greatballs in the continue tally
+        self.FARM_IGNORE_ULTRABALL_COUNT = config.get("NEEDY_ITEM_FARMING", {}).get("FARM_IGNORE_ULTRABALL_COUNT", False) # ignore ultraballs in the continue tally
+        self.FARM_IGNORE_MASTERBALL_COUNT = config.get("NEEDY_ITEM_FARMING", {}).get("FARM_IGNORE_MASTERBALL_COUNT", True) # ignore masterballs in the continue tally
+        self.FARM_OVERRIDE_STEP_SIZE = config.get("NEEDY_ITEM_FARMING", {}).get("FARM_OVERRIDE_STEP_SIZE", -1) # should the step size be overriden when looking for more inventory, -1 to disable
+        # OVERRIDE STEP SIZE could be softbannable. No data to suggest either way.
+
         self.visited_forts = ExpiringDict(max_len=120, max_age_seconds=config.get("SKIP_VISITED_FORT_DURATION", 600))
-        self.experimental = config.get("EXPERIMENTAL", False)
         self.spin_all_forts = config.get("SPIN_ALL_FORTS", False)
         self.keep_pokemon_ids = map(lambda x: getattr(Enums_pb2, x), config.get("KEEP_POKEMON_NAMES", []))
         self.throw_pokemon_ids = map(lambda x: getattr(Enums_pb2, x), config.get("THROW_POKEMON_NAMES", []))
@@ -123,6 +138,19 @@ def __init__(self, config, pokemon_names):
         self.RELEASE_DUPLICATES_SCALER = config.get("RELEAES_DUPLICATES_SCALER", 1.0) # when comparing two pokemon's lvl, multiply larger by this
         self.DEFINE_POKEMON_LV = config.get("DEFINE_POKEMON_LV", "CP") # define a pokemon's lvl, options are CP, IV, CP*IV, CP+IV
 
+        # Sanity checking
+        self.FARM_ITEMS_ENABLED = self.FARM_ITEMS_ENABLED and self.experimental and self.should_catch_pokemon # Experimental, and we needn't do this if we're farming anyway
+        if ( self.FARM_ITEMS_ENABLED         
+           and self.FARM_IGNORE_POKEBALL_COUNT  
+           and self.FARM_IGNORE_GREATBALL_COUNT 
+           and self.FARM_IGNORE_ULTRABALL_COUNT 
+           and self.FARM_IGNORE_MASTERBALL_COUNT ):
+          self.FARM_ITEMS_ENABLED = False
+          self.log.warn("FARM_ITEMS has been disabled due to all Pokeball counts being ignored.")
+        elif   self.FARM_ITEMS_ENABLED and not (self.POKEBALL_FARM_THRESHOLD < self.POKEBALL_CONTINUE_THRESHOLD):
+          self.FARM_ITEMS_ENABLED = False
+          self.log.warn("FARM_ITEMS has been disabled due to farming threshold being below the continue. Set 'CATCH_POKEMON' to 'false' to enable captureless traveling.")
+
     def call(self):
         if not self._req_method_list:
             return False
@@ -256,6 +284,32 @@ def heartbeat(self):
             self.cleanup_pokemon(self.inventory.inventory_items)
         # Auto-use lucky-egg if applicable
             self.use_lucky_egg()
+
+            # Farm precon
+            if self.FARM_ITEMS_ENABLED:
+                pokeball_count = 0
+                if not self.FARM_IGNORE_POKEBALL_COUNT:
+                    pokeball_count += self.inventory.poke_balls
+                if not self.FARM_IGNORE_GREATBALL_COUNT:
+                    pokeball_count += self.inventory.great_balls
+                if not self.FARM_IGNORE_ULTRABALL_COUNT:
+                    pokeball_count += self.inventory.ultra_balls
+                if not self.FARM_IGNORE_MASTERBALL_COUNT:
+                    pokeball_count += self.inventory.master_balls
+                if self.POKEBALL_FARM_THRESHOLD > pokeball_count and not self._farm_mode_triggered:
+                    self.should_catch_pokemon = False
+                    self._farm_mode_triggered = True
+                    self.log.info("Player only has %s Pokeballs, farming for more...", pokeball_count)
+                    if self.FARM_OVERRIDE_STEP_SIZE != -1:
+                        self.STEP_SIZE = self.FARM_OVERRIDE_STEP_SIZE
+                        self.log.info("Player has changed speed to %s", self.STEP_SIZE)
+                elif self.POKEBALL_CONTINUE_THRESHOLD <= pokeball_count and self._farm_mode_triggered:
+                    self.should_catch_pokemon = True
+                    self._farm_mode_triggered = False
+                    self.log.info("Player has %s Pokeballs, continuing to catch more!", pokeball_count)
+                    if self.FARM_OVERRIDE_STEP_SIZE != -1:
+                        self.STEP_SIZE = self._orig_step_size
+                        self.log.info("Player has returned to normal speed of %s", self.STEP_SIZE)
         self._heartbeat_number += 1
         return res
 
@@ -283,7 +337,7 @@ def walk_to(self, loc, waypoints=[], directly=False):  # location in floats of c
                           self.experimental and self.spin_all_forts, waypoints)
         catch_attempt = 0
         base_travel_link = "https://www.google.com/maps/dir/%s,%s/" % (self._posf[0], self._posf[1])
-        step_size = self.config.get("STEP_SIZE", 200)
+        step_size = self.STEP_SIZE
         total_distance_traveled = 0
         total_distance = distance_in_meters(self._posf, loc)
         new_loc = (loc[0], loc[1], 0)