Configuration Guide

Configuration Guide for good results

First off, "STEP_SIZE" , should be changed immediately especially if you want to run this bot on your main account or hatch eggs.

"STEP_SIZE" is in Meters Per Second (M/s), and the default is set to 100, That is 223 Mile Per Hour (MPH). Reducing this value to '10' or lower will greatly reduce your chance of being banned or soft banned by the games code. Sure it runs slower but play smart and safe is the best way to avoid detection.

Configuration settings Explained

"accounts": [ - Everything after this block is either general config settings or account settings, Each specific block of Account based settings will start with a { Followed by "auth_service" and end with a }. The settings between these brackets define everything for that account, and unless defined again will be used as default settings for every subsequent account. Accounts made in this order are defined by default as 0, 1, 2, Etc.... (this is a behind the scenes definition so placing your accounts in order in the configuration file is the only way to visually identify the account order at this time)

Example:

{
  "accounts": [
    {
      "auth_service": "google",
      "username": "Your_User_Name",
      "password": "Your_PASSWORD",
      "location": "Physical Address or Latitude,Longitude",
      "USE_GOOGLE": true,
      "GMAPS_API_KEY": "Google_Maps_API",
      "KEEP_CP_OVER": 500,
      "KEEP_IV_OVER": 80,
      "STEP_SIZE": 7,
      "EXPERIMENTAL": true,
      "SKIP_VISITED_FORT_DURATION": 600,
      "SPIN_ALL_FORTS": true,
      "STAY_WITHIN_PROXIMITY": 9999,
      "WANDER_STEPS": 50
      "AUTO_USE_LUCKY_EGG": false,
      "EGG_INCUBATION": {
        "ENABLE": true,
        "USE_DISPOSABLE_INCUBATORS": false,
        "BIG_EGGS_FIRST": true
      },
      "MIN_ITEMS": {
	"ITEM_POKE_BALL": 50,
	"ITEM_GREAT_BALL": 100,
        "ITEM_POTION": 0,
        "ITEM_SUPER_POTION": 0,
        "ITEM_HYPER_POTION": 30,
        "ITEM_MAX_POTION": 30,
        "ITEM_BLUK_BERRY": 20,
        "ITEM_NANAB_BERRY": 20,
        "ITEM_REVIVE": 10,
        "ITEM_MAX_REVIVE": 10,
        "ITEM_RAZZ_BERRY": 20
      },
      "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,
	"RATTATA": 25,
        "WEEDLE":12
      },
      "MIN_SIMILAR_POKEMON": 3,
      "CATCH_POKEMON": true,
      "KEEP_POKEMON_NAMES": ["MEWTWO"],
      "THROW_POKEMON_NAMES": ["PIDGEY"],
      "LIST_POKEMON_BEFORE_CLEANUP": false,
      "LIST_INVENTORY_BEFORE_CLEANUP": true,
      "MAX_CATCH_ATTEMPTS": 10,
      "RELEASE_DUPLICATES": false,
      "RELEASE_DUPLICATES_MAX_LV": 1000,
      "RELEASE_DUPLICATES_SCALER": 0.9,
      "DEFINE_POKEMON_LV": "CP"
    },
    {
      "auth_service": "ptc",
      "username": "someusername",
      "password": "password",
      "location": "University of Southern California, Los Angeles, CA",
      "USE_GOOGLE": false,
      "MIN_KEEP_IV": 70
    }
  ]
}

As seen above there are 2 accounts specified, One uses Google Auth, One uses PTC. The first account is designated "0" for the switch python pokecli.py -i 0 While the second account using PTC would be python pokecli.py -i 1. In the case for PTC it will grab the values from the google defined account unless a different set of values is placed under it.

Configuration (non-exhaustive)

USE_GOOGLE will enable google walking directions for navigation You will probably need to provide an api key in GMAPS_API_KEY to avoid rate limits

STEP_SIZE corresponds to how many meters you want to move at most between server calls, set this around 4-6 for walking or 100-200 for really, really fast driving

WANDER_STEPS will set the distance a pokestop can be away before and still allow us to wander off the walk path. This allows you to get pokestops that aren't close to the sidewalk/road. If you don't set it we won't wander off the path.

MIN_KEEP_IV is the minimum pokemon IV that you want to keep, note that the highest CP pokemon you have will always be kept regardless of its IV Setting this to 0 will never transfer anything

KEEP_CP_OVER Never transfer any pokemon above this CP Setting this to 0 will never transfer anything EXPERIMENTAL will set the flag to use exeperimental features

SKIP_VISITED_FORT_DURATION [Experimental] Avoid a fort for a given number of seconds Setting this to 500 means avoid a fort for 500 seconds before returning, (Should be higher than 300 to have any effect). This will let the bot explore a bigger area.

SPIN_ALL_FORTS [Experimental] will try to route using google maps(must have key) to all visible forts, if SKIP_VISITED_FORT_DURATION is set high enough, you may roam around forever.

KEEP_POKEMON_IDS IDs of pokemon you want the bot to hold regardless of IV/CP

CATCH_POKEMON Allows you to disabling catching pokemon if you just want to mine for the forts for pokeballs

EGG_INCUBATION

ENABLE enables automatic use of incubators (default: true)

USE_DISPOSABLE_INCUBATOR enables use of disposable (3-times use) incubators (default: false)

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. If EXPERIMENTAL OR CATCH_POKEMON are false, this configuration will disable itself.

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.