Skip to content

Commit

Permalink
Add Documentation (#4590)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexyaoyang authored Aug 22, 2016
1 parent 0dee471 commit 2244464
Showing 1 changed file with 30 additions and 14 deletions.
44 changes: 30 additions & 14 deletions docs/configuration_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
- [Valid names in templates](#valid-names-in-templates)
- [Sample usages](#sample-usages)
- [Sample configuration](#sample-configuration)
- [CatchPokemon `catch_simulation` Settings](#catchpokemon-catch_simulation-settings)
- [CatchPokemon Settings](#catchpokemon-settings)
- [Default Settings](#default-settings)
- [Settings Description](#settings-description)
- [`flee_count` and `flee_duration`](#flee_count-and-flee_duration)
- [Previous Behaviour](#previous-behaviour)
- [Previous `catch_simulation` Behaviour](#previous-catch_simulation-behaviour)
- [Sniping _(MoveToLocation)_](#sniping-_-movetolocation-_)
- [Description](#description)
- [Options](#options)
Expand Down Expand Up @@ -408,26 +408,39 @@ Key | Info
}
```

## CatchPokemon `catch_simulation` Settings
## CatchPokemon Settings
[[back to top](#table-of-contents)]

These settings determine how the bot will simulate the app by adding pauses to throw the ball and navigate menus. All times are in seconds. To configure these settings add them to the config in the CatchPokemon task.
These settings determine how the bot will catch pokemon. `catch_simulate` simulates the app by adding pauses to throw the ball and navigate menus. All times in `catch_simulation` are in seconds.

### Default Settings
[[back to top](#table-of-contents)]

The default settings are 'safe' settings intended to simulate human and app behaviour.

```
"catch_visible_pokemon": true,
"catch_lured_pokemon": true,
"min_ultraball_to_keep": 5,
"berry_threshold": 0.35,
"vip_berry_threshold": 0.9,
"catch_throw_parameters": {
"excellent_rate": 0.1,
"great_rate": 0.5,
"nice_rate": 0.3,
"normal_rate": 0.1,
"spin_success_rate" : 0.6,
"hit_rate": 0.75
},
"catch_simulation": {
"flee_count": 3,
"flee_duration": 2,
"catch_wait_min": 2,
"catch_wait_max": 6,
"berry_wait_min": 2,
"berry_wait_max": 3,
"changeball_wait_min": 2,
"changeball_wait_max": 3
"flee_count": 3,
"flee_duration": 2,
"catch_wait_min": 2,
"catch_wait_max": 6,
"berry_wait_min": 2,
"berry_wait_max": 3,
"changeball_wait_min": 2,
"changeball_wait_max": 3
}
```

Expand All @@ -436,6 +449,9 @@ The default settings are 'safe' settings intended to simulate human and app beha

Setting | Description
---- | ----
`min_ultraball_to_keep` | Allows the bot to use ultraballs on non-VIP pokemon as long as number of ultraballs is above this setting
`berry_threshold` | The ideal catch rate threshold before using a razz berry on normal pokemon (higher threshold means using razz berries more frequently, for example if we raise `berry_threshold` to 0.5, any pokemon that has an initial catch rate between 0 to 0.5 will initiate a berry throw)
`vip_berry_threshold` | The ideal catch rate threshold before using a razz berry on VIP pokemon
`flee_count` | The maximum number of times catching animation will play before the pokemon breaks free
`flee_duration` | The length of time for each animation
`catch_wait_min`| The minimum amount of time to throw the ball
Expand All @@ -450,10 +466,10 @@ Setting | Description

This part is app simulation and the default settings are advised. When we hit a pokemon in the app the animation will play randomly 1, 2 or 3 times for roughly 2 seconds each time. So we pause for a random number of animations up to `flee_count` of duration `flee_duration`

### Previous Behaviour
### Previous `catch_simulation` Behaviour
[[back to top](#table-of-contents)]

If you want to make your bot behave as it did prior to this update please use the following settings.
If you want to make your bot behave as it did prior to the catch_simulation update please use the following settings.

```
"catch_simulation": {
Expand Down

0 comments on commit 2244464

Please sign in to comment.