> 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/stellardreams.md). # stellardreams [All effects and shared choice parameters](/stellarskills-docs/readme.md) ยท [Effect math and limitations](file:///configuration/effects.md) ## stellardreams.capture\_currency Dream capture skill currency. Soft dependency; disabled individually when its capability handshake is unavailable. | Property | Value | | --------------------------- | --------------------------------------- | | Exact key | `stellardreams.capture_currency` | | Hook descriptor | `dream_capture` | | Optional integration owner | `stellardreams` | | Runtime evidence | Optional bridge/source reference | | Source reference | PixelmonHooks.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. | | `species` | text; condition | No | `mew` | Optional species restriction. | | `dream_id` | text; condition | No | `oneiric_skylands` | Optional dream dimension 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. ## stellardreams.capture\_xp Dream capture Stellar XP. Soft dependency; disabled individually when its capability handshake is unavailable. | Property | Value | | --------------------------- | --------------------------------------------------------- | | Exact key | `stellardreams.capture_xp` | | Hook descriptor | `dream_capture` | | Optional integration owner | `stellardreams` | | Runtime evidence | Optional bridge/source reference | | Source reference | PixelmonHooks.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 | | ----------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `species` | text; condition | No | `mew` | Optional species restriction. | | `dream_id` | text; condition | No | `oneiric_skylands` | Optional dream dimension 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. ## stellardreams.encounter\_weight Dream encounter weight. Soft dependency; disabled individually when its capability handshake is unavailable. | Property | Value | | --------------------------- | ----------------------------------------------------------------------------------------- | | Exact key | `stellardreams.encounter_weight` | | Hook descriptor | `dream_encounter_weight` | | Optional integration owner | `stellardreams` | | Runtime evidence | Optional bridge/source reference | | Source reference | DreamsHooks.java | | Declared enabled-by-default | True | | Probability flag | False | | Allowed operations | `set_min`, `set_max`, `override`, `weight_add`, `weight_multiply` | | Value label | Encounter weight | | Value help | Use WEIGHT\_MULTIPLY 1.50 for 50% more selection weight, or OVERRIDE for an exact weight. | | Schema value example | `1.50` | ### Accepted filters/parameters | Exact field | Type / role | Required | Example / options | Plain-language help | | -------------- | ------------------ | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `dream_id` | text; condition | No | `oneiric_skylands` | Optional configured dream ID. | | `encounter_id` | text; condition | No | `rare_relic` | Optional configured encounter rule 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. ## stellardreams.entry\_chance Dream entry chance. Soft dependency; disabled individually when its capability handshake is unavailable. | Property | Value | | --------------------------- | ---------------------------------------------------------------------------------------------------------------- | | Exact key | `stellardreams.entry_chance` | | Hook descriptor | `dream_entry_roll` | | Optional integration owner | `stellardreams` | | Runtime evidence | Optional bridge/source reference | | Source reference | DreamsHooks.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 | Entry probability | | Value help | Use 0.10 for 10%, or ADD\_PERCENT\_POINTS with value 10. | | Schema value example | `0.10` | ### Accepted filters/parameters | Exact field | Type / role | Required | Example / options | Plain-language help | | ----------- | ------------------- | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `dimension` | resource; condition | No | `stellardreams:*` | Optional restriction; use a dream dimension namespace or stellardreams:\* for all dreams. | | `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. ## stellardreams.shiny\_chance Dream shiny chance. Soft dependency; disabled individually when its capability handshake is unavailable. | Property | Value | | --------------------------- | ---------------------------------------------------------------------------------------------------------------- | | Exact key | `stellardreams.shiny_chance` | | Hook descriptor | `dream_spawn` | | Optional integration owner | `stellardreams` | | 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 | | ----------- | ------------------- | -------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `dimension` | resource; condition | No | `stellardreams:oneiric_skylands` | Optional exact dream dimension. | | `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.