Skip to content

Scan rules examples #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
notheowner wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Scan rules examples #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97e3781
Scan rule examples with usage of areas and scanner modes
notheowner Oct 28, 2025
9a94711
Bump browserslist
notheowner Oct 28, 2025
a56a7b0
table
notheowner Oct 28, 2025
788b358
oops
notheowner Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions pages/docs/golbat/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,59 @@ include_hundos_under_cap = false

**⭐ Advanced Option ⭐**

With Scan Rules you can modify the behavior globally for all areas or for specific areas using
With Scan Rules you can modify the behavior globally for all areas, for specific areas or specific scanner 'modes'.
These will be processed in order, first match applies - and allows disabling of processing certain types of game objects.

A global scan rule example:
```toml
[[scan_rules]]
wild_pokemon = false # disables Pokémon without iv from the gmo (waits for encounter)
nearby_pokemon = false # disables cell/pokestop Pokémon
```

Here the main area would not process nearby pokemon. Messages arriving in 'scout' mode would have everything processed; and the default would not process any pokemon (so outside main area not delivered by the scout service)
```toml
[[scan_rules]]
areas = ["MainArea"]
nearby_pokemon = false

[[scan_rules]]
context = ["Scout"]

[[scan_rules]]
pokemon = false
```

# insert example for a specific area
Example with the use of *context* for various scanner 'modes':
```toml
[[scan_rules]]
context = ["Quest"]

[[scan_rules]]
context = ["Fort"]
pokemon = false
nearby_pokemon = false
wild_pokemon = false

[[scan_rules]]
context = ["Invasion"]
pokemon = false
nearby_pokemon = false
wild_pokemon = false

[[scan_rules]]
context = ["Pokemon"]
nearby_pokemon = false
```
| Key | Description |
| :-- | :-- |
| `pokemon` | any pokemon processing (also disables spawnpoints) |
| `wild_pokemon` | process wild pokemon from GMO |
| `nearby_pokemon` | process nearby pokemon from GMO |
| `weather` | process weather in GMO |
| `gyms` | process gyms in GMO |
| `pokestop` | process pokestops in GMO |
| `cells` | process cell updates (disabling this also disables automatic fort clearance) |

## Sentry Section

Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,9 @@ busboy@1.6.0:
streamsearch "^1.1.0"

caniuse-lite@^1.0.30001406:
version "1.0.30001699"
resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001699.tgz"
integrity sha512-b+uH5BakXZ9Do9iK+CkDmctUSEqZl+SP056vc5usa0PL+ev5OHw003rZXcnjNDv3L8P5j6rwT6C0BPKSikW08w==
version "1.0.30001751"
resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001751.tgz"
integrity sha512-A0QJhug0Ly64Ii3eIqHu5X51ebln3k4yTUkY1j8drqpWHVreg/VLijN48cZ1bYPiqOQuqpkIKnzr/Ul8V+p6Cw==

ccount@^2.0.0:
version "2.0.1"
Expand Down