> For the complete documentation index, see [llms.txt](https://stellarskills.gitbook.io/stellarskills-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://stellarskills.gitbook.io/stellarskills-docs/safari.md).

# safari

[All effects and shared choice parameters](/stellarskills-docs/readme.md) · [Effect math and limitations](file:///configuration/effects.md)

## safari.capture\_currency

Safari capture skill currency. Soft dependency; disabled individually when its capability handshake is unavailable.

| Property                    | Value                                   |
| --------------------------- | --------------------------------------- |
| Exact key                   | `safari.capture_currency`               |
| Hook descriptor             | `safari_capture`                        |
| Optional integration owner  | `stellar_safari`                        |
| Runtime evidence            | Optional bridge/source reference        |
| Source reference            | SafariHooks.java                        |
| Declared enabled-by-default | True                                    |
| Probability flag            | False                                   |
| Allowed operations          | `add_flat`                              |
| Value label                 | Currency amount                         |
| Value help                  | Whole-number currency reward per event. |
| Schema value example        | `1`                                     |

### Accepted filters/parameters

| Exact field | Type / role         | Required | Example / options                                                                 | Plain-language help                                                                                   |
| ----------- | ------------------- | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `currency`  | currency; parameter | Yes      | `skill_points`                                                                    | Configured StellarSkills currency ID.                                                                 |
| `zone_id`   | text; condition     | No       | `verdant_reserve`                                                                 | Optional Safari zone ID.                                                                              |
| `species`   | text; condition     | No       | `pikachu`                                                                         | Optional species restriction.                                                                         |
| `display`   | text; parameter     | No       | `Custom player-facing text; supports {value}, {percent}, {item}, and {currency}.` | Overrides the generated benefit line. Use this to conceal server-only IDs and implementation details. |
| `hidden`    | boolean; parameter  | No       | `false`; choices: false, true                                                     | When true, this effect remains active but is omitted from player benefit/profile text.                |

Also accepts the six [shared choice parameters](/stellarskills-docs/readme.md) for supported skill-node bundles. Field examples are placeholders, not guaranteed live registry IDs or complete recipes.

## safari.capture\_limit\_bonus

Safari capture limit bonus. Soft dependency; disabled individually when its capability handshake is unavailable.

| Property                    | Value                                                                                                                      |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Exact key                   | `safari.capture_limit_bonus`                                                                                               |
| Hook descriptor             | `safari_capture`                                                                                                           |
| Optional integration owner  | `stellar_safari`                                                                                                           |
| Runtime evidence            | Optional bridge/source reference                                                                                           |
| Source reference            | SafariHooks.java                                                                                                           |
| Declared enabled-by-default | True                                                                                                                       |
| Probability flag            | False                                                                                                                      |
| Allowed operations          | `add_flat`, `add_percent_points`, `multiply_base`, `multiply_final`, `set_min`, `set_max`, `override`, `deny`, `transform` |
| Value label                 | Additional captures                                                                                                        |
| Value help                  | Use ADD\_FLAT 5 to grant five extra captures. Zero means unlimited only when the zone itself is unlimited.                 |
| Schema value example        | `5`                                                                                                                        |

### Accepted filters/parameters

| Exact field | Type / role        | Required | Example / options                                                                 | Plain-language help                                                                                   |
| ----------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `zone_id`   | text; condition    | No       | `verdant_reserve`                                                                 | Optional Safari zone ID.                                                                              |
| `display`   | text; parameter    | No       | `Custom player-facing text; supports {value}, {percent}, {item}, and {currency}.` | Overrides the generated benefit line. Use this to conceal server-only IDs and implementation details. |
| `hidden`    | boolean; parameter | No       | `false`; choices: false, true                                                     | When true, this effect remains active but is omitted from player benefit/profile text.                |

Also accepts the six [shared choice parameters](/stellarskills-docs/readme.md) for supported skill-node bundles. Field examples are placeholders, not guaranteed live registry IDs or complete recipes.

## safari.capture\_xp

Safari capture Stellar XP. Soft dependency; disabled individually when its capability handshake is unavailable.

| Property                    | Value                                                     |
| --------------------------- | --------------------------------------------------------- |
| Exact key                   | `safari.capture_xp`                                       |
| Hook descriptor             | `safari_capture`                                          |
| Optional integration owner  | `stellar_safari`                                          |
| Runtime evidence            | Optional bridge/source reference                          |
| Source reference            | SafariHooks.java                                          |
| Declared enabled-by-default | True                                                      |
| Probability flag            | False                                                     |
| Allowed operations          | `add_flat`                                                |
| Value label                 | XP amount                                                 |
| Value help                  | Whole-number reward; rank values may increase the amount. |
| Schema value example        | `25`                                                      |

### Accepted filters/parameters

| Exact field | Type / role        | Required | Example / options                                                                 | Plain-language help                                                                                   |
| ----------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `zone_id`   | text; condition    | No       | `verdant_reserve`                                                                 | Optional Safari zone ID.                                                                              |
| `species`   | text; condition    | No       | `pikachu`                                                                         | Optional species restriction.                                                                         |
| `display`   | text; parameter    | No       | `Custom player-facing text; supports {value}, {percent}, {item}, and {currency}.` | Overrides the generated benefit line. Use this to conceal server-only IDs and implementation details. |
| `hidden`    | boolean; parameter | No       | `false`; choices: false, true                                                     | When true, this effect remains active but is omitted from player benefit/profile text.                |

Also accepts the six [shared choice parameters](/stellarskills-docs/readme.md) for supported skill-node bundles. Field examples are placeholders, not guaranteed live registry IDs or complete recipes.

## safari.duration\_multiplier

Safari duration. Soft dependency; disabled individually when its capability handshake is unavailable.

| Property                    | Value                                                                                                                      |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Exact key                   | `safari.duration_multiplier`                                                                                               |
| Hook descriptor             | `safari_join`                                                                                                              |
| Optional integration owner  | `stellar_safari`                                                                                                           |
| Runtime evidence            | Optional bridge/source reference                                                                                           |
| Source reference            | SafariHooks.java                                                                                                           |
| Declared enabled-by-default | True                                                                                                                       |
| Probability flag            | False                                                                                                                      |
| Allowed operations          | `add_flat`, `add_percent_points`, `multiply_base`, `multiply_final`, `set_min`, `set_max`, `override`, `deny`, `transform` |
| Value label                 | Duration multiplier                                                                                                        |
| Value help                  | Use MULTIPLY\_FINAL 1.25 for 25% more time. The server caps duration at seven days.                                        |
| Schema value example        | `1.25`                                                                                                                     |

### Accepted filters/parameters

| Exact field | Type / role        | Required | Example / options                                                                 | Plain-language help                                                                                   |
| ----------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `zone_id`   | text; condition    | No       | `verdant_reserve`                                                                 | Optional Safari zone ID.                                                                              |
| `mode`      | enum; condition    | No       | `private`; choices: private, party, public                                        | Optional mode restriction.                                                                            |
| `display`   | text; parameter    | No       | `Custom player-facing text; supports {value}, {percent}, {item}, and {currency}.` | Overrides the generated benefit line. Use this to conceal server-only IDs and implementation details. |
| `hidden`    | boolean; parameter | No       | `false`; choices: false, true                                                     | When true, this effect remains active but is omitted from player benefit/profile text.                |

Also accepts the six [shared choice parameters](/stellarskills-docs/readme.md) for supported skill-node bundles. Field examples are placeholders, not guaranteed live registry IDs or complete recipes.

## safari.entry\_cost\_multiplier

Safari entry cost. Soft dependency; disabled individually when its capability handshake is unavailable.

| Property                    | Value                                                                                                                      |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Exact key                   | `safari.entry_cost_multiplier`                                                                                             |
| Hook descriptor             | `safari_join`                                                                                                              |
| Optional integration owner  | `stellar_safari`                                                                                                           |
| Runtime evidence            | Optional bridge/source reference                                                                                           |
| Source reference            | SafariHooks.java                                                                                                           |
| Declared enabled-by-default | True                                                                                                                       |
| Probability flag            | False                                                                                                                      |
| Allowed operations          | `add_flat`, `add_percent_points`, `multiply_base`, `multiply_final`, `set_min`, `set_max`, `override`, `deny`, `transform` |
| Value label                 | Cost multiplier                                                                                                            |
| Value help                  | Use MULTIPLY\_FINAL 0.75 for 25% cheaper entry. Costs are clamped server-side.                                             |
| Schema value example        | `0.75`                                                                                                                     |

### Accepted filters/parameters

| Exact field | Type / role        | Required | Example / options                                                                 | Plain-language help                                                                                   |
| ----------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `zone_id`   | text; condition    | No       | `verdant_reserve`                                                                 | Optional Safari zone ID.                                                                              |
| `mode`      | enum; condition    | No       | `private`; choices: private, party, public                                        | Optional mode restriction.                                                                            |
| `display`   | text; parameter    | No       | `Custom player-facing text; supports {value}, {percent}, {item}, and {currency}.` | Overrides the generated benefit line. Use this to conceal server-only IDs and implementation details. |
| `hidden`    | boolean; parameter | No       | `false`; choices: false, true                                                     | When true, this effect remains active but is omitted from player benefit/profile text.                |

Also accepts the six [shared choice parameters](/stellarskills-docs/readme.md) for supported skill-node bundles. Field examples are placeholders, not guaranteed live registry IDs or complete recipes.

## safari.shiny\_chance

Safari shiny chance. Soft dependency; disabled individually when its capability handshake is unavailable.

| Property                    | Value                                                                                                            |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| Exact key                   | `safari.shiny_chance`                                                                                            |
| Hook descriptor             | `safari_spawn`                                                                                                   |
| Optional integration owner  | `stellar_safari`                                                                                                 |
| Runtime evidence            | Optional bridge/source reference                                                                                 |
| Source reference            | PixelmonHooks.java                                                                                               |
| Declared enabled-by-default | True                                                                                                             |
| Probability flag            | True                                                                                                             |
| Allowed operations          | `add_percent_points`, `multiply_base`, `multiply_final`, `set_min`, `set_max`, `override`, `reroll`, `keep_best` |
| Value label                 | Shiny probability                                                                                                |
| Value help                  | Use 0.01 for 1%, or ADD\_PERCENT\_POINTS with value 1.                                                           |
| Schema value example        | `0.01`                                                                                                           |

### Accepted filters/parameters

| Exact field | Type / role        | Required | Example / options                                                                 | Plain-language help                                                                                   |
| ----------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `zone_id`   | text; condition    | No       | `verdant_reserve`                                                                 | Optional Safari zone ID.                                                                              |
| `display`   | text; parameter    | No       | `Custom player-facing text; supports {value}, {percent}, {item}, and {currency}.` | Overrides the generated benefit line. Use this to conceal server-only IDs and implementation details. |
| `hidden`    | boolean; parameter | No       | `false`; choices: false, true                                                     | When true, this effect remains active but is omitted from player benefit/profile text.                |

Also accepts the six [shared choice parameters](/stellarskills-docs/readme.md) for supported skill-node bundles. Field examples are placeholders, not guaranteed live registry IDs or complete recipes.