> 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/journey-fields.md).

# journey fields

These tables extract the packaged schema's documented fields. The current Java parser/validator is authoritative; older schema repeat/event lists may be narrower than the current code. See [Journey guide](file:///4985688/configuration/journey.md) and [limits](file:///4985688/operations/implementation-limits.md).

## Root

| Exact field      | Documented accepted value |
| ---------------- | ------------------------- |
| `schema-version` | integer                   |
| `enabled`        | boolean                   |
| `title`          | text                      |
| `subtitle`       | text                      |
| `theme`          | identifier                |
| `settings`       | suite-settings            |
| `modules`        | mapping-by-id             |

## Suite Settings

| Exact field                 | Documented accepted value |
| --------------------------- | ------------------------- |
| `allow-reward-commands`     | boolean                   |
| `leaderboard-limit`         | integer >= 1              |
| `maximum-aura-sources`      | integer >= 1              |
| `build-code-maximum-length` | integer >= 128            |
| `rotation-seed`             | text                      |

## Module Fields

| Exact field          | Documented accepted value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `kind`               | specialization\|prestige\|contract\|reputation\|partner-mastery\|type-mastery\|research\|streak\|evolution-mastery\|breeding-mastery\|synergy\|discovery\|transformation\|socket\|aura\|loadout\|build-sharing\|leaderboard\|journal\|analytics\|simulator\|revision-history\|template\|celebration\|title-badge\|route-planner\|comparison\|node-trial\|team-resonance\|convergence\|campaign\|season\|community-project\|field-attunement\|oath\|build-advisor\|mastery-codex\|objective-tracker\|balance-dashboard |
| `title`              | text                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `description`        | text                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `icon`               | item-id\|potion-alias\|effect-icon-alias                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `accent-color`       | auto\|quoted-hex-color                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `order`              | integer                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `enabled`            | boolean                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `maximum-selections` | integer >= 0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `selection-groups`   | mapping-by-id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `reset`              | never\|daily\|weekly\|monthly\|seasonal                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `settings`           | module-settings                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `entries`            | mapping-by-id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

## Selection Group Fields

| Exact field      | Documented accepted value |
| ---------------- | ------------------------- |
| `title`          | text                      |
| `maximum-points` | integer 1-64              |

## Module Settings

| Exact field                    | Documented accepted value        |
| ------------------------------ | -------------------------------- |
| `allow-removal`                | boolean                          |
| `announce`                     | boolean                          |
| `required-level`               | integer >= 1                     |
| `reset-level`                  | boolean                          |
| `reset-trees`                  | boolean                          |
| `refund-trees`                 | boolean                          |
| `reset-selections`             | boolean                          |
| `clear-history-on-reset`       | boolean                          |
| `season-id`                    | text                             |
| `rotation-count`               | integer >= 0                     |
| `rotation-period`              | daily\|weekly                    |
| `break-events`                 | comma-separated-event-ids        |
| `radius`                       | decimal > 0                      |
| `allow-apply`                  | boolean                          |
| `safe-area-only`               | boolean                          |
| `safe-area-radius`             | integer >= 1                     |
| `cooldown-seconds`             | integer >= 0                     |
| `cost-currency`                | configured-currency-id           |
| `cost`                         | integer >= 0                     |
| `require-opt-in`               | boolean                          |
| `privacy-entry`                | entry-id                         |
| `rows-per-board`               | integer 5-100                    |
| `include-levels`               | boolean                          |
| `include-lifetime-xp`          | boolean                          |
| `include-current-xp`           | boolean                          |
| `include-classes`              | boolean                          |
| `include-hidden-classes`       | boolean                          |
| `class-rank-by`                | level\|lifetime-xp\|current-xp   |
| `included-classes`             | all\|comma-separated-class-ids   |
| `excluded-classes`             | empty\|comma-separated-class-ids |
| `ui-enabled`                   | boolean                          |
| `ui-show-header`               | boolean                          |
| `ui-show-tabs`                 | boolean                          |
| `ui-show-podium`               | boolean                          |
| `ui-show-personal`             | boolean                          |
| `ui-show-ledger`               | boolean                          |
| `ui-show-footer`               | boolean                          |
| `ui-show-population`           | boolean                          |
| `ui-show-percentile`           | boolean                          |
| `ui-show-secondary-metric`     | boolean                          |
| `ui-show-privacy`              | boolean                          |
| `ui-show-level`                | boolean                          |
| `ui-show-prestige`             | boolean                          |
| `ui-show-messages`             | boolean                          |
| `ui-allow-board-switching`     | boolean                          |
| `ui-allow-ledger-scroll`       | boolean                          |
| `ui-allow-refresh`             | boolean                          |
| `ui-allow-journey`             | boolean                          |
| `ui-keyboard-shortcuts`        | boolean                          |
| `ui-background-enabled`        | boolean                          |
| `ui-background-constellations` | boolean                          |
| `ui-background-aurora`         | boolean                          |
| `ui-background-halo`           | boolean                          |
| `ui-background-floor`          | boolean                          |
| `ui-background-spotlights`     | boolean                          |
| `ui-show-podium-particles`     | boolean                          |
| `ui-show-podium-crown`         | boolean                          |
| `ui-opening-ceremony`          | boolean                          |
| `ui-animate-opening`           | boolean                          |
| `ui-animate-background`        | boolean                          |
| `ui-animate-tabs`              | boolean                          |
| `ui-animate-podium`            | boolean                          |
| `ui-animate-ledger`            | boolean                          |
| `sounds-enabled`               | boolean                          |
| `sound-open`                   | boolean                          |
| `sound-hover`                  | boolean                          |
| `sound-tab`                    | boolean                          |
| `sound-action`                 | boolean                          |
| `sound-refresh`                | boolean                          |
| `sound-error`                  | boolean                          |
| `starts-at`                    | ISO-8601-instant-or-UTC-date     |
| `ends-at`                      | ISO-8601-instant-or-UTC-date     |
| `progress-multiplier`          | decimal >= 0                     |
| `catch-up-after-percent`       | decimal 0-100                    |
| `catch-up-multiplier`          | decimal >= 1                     |
| `broadcast-completion`         | boolean                          |
| `recommended-score`            | integer 0-100                    |

## Entry Fields

| Exact field           | Documented accepted value                                                                                                                                                                                     |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `title`               | text                                                                                                                                                                                                          |
| `description`         | text                                                                                                                                                                                                          |
| `icon`                | item-id\|potion-alias\|effect-icon-alias                                                                                                                                                                      |
| `order`               | integer                                                                                                                                                                                                       |
| `enabled`             | boolean                                                                                                                                                                                                       |
| `hidden`              | boolean                                                                                                                                                                                                       |
| `selectable`          | boolean                                                                                                                                                                                                       |
| `selection-group`     | configured-selection-group-id                                                                                                                                                                                 |
| `selection-points`    | integer >= 1                                                                                                                                                                                                  |
| `event`               | capture\|defeat\|hatch\|evolve\|pokemon\_xp\|apricorn\|berry\|mob\_kill\|block\_break\|trade\|fish\|fossil\|heal\_team\|move\_learn\|ride\|capture\_failed\|battle\_lost\|dynamax\_raid\_win\|tera\_raid\_win |
| `target`              | integer >= 1                                                                                                                                                                                                  |
| `repeat`              | once\|repeatable\|daily\|weekly                                                                                                                                                                               |
| `maximum-completions` | integer >= 0                                                                                                                                                                                                  |
| `filters`             | scalar-or-list-mapping                                                                                                                                                                                        |
| `requires`            | list-of-entry-ids-or-module-colon-entry-ids                                                                                                                                                                   |
| `conflicts`           | list-of-entry-ids-or-module-colon-entry-ids                                                                                                                                                                   |
| `required-classes`    | list-of-class-ids                                                                                                                                                                                             |
| `required-nodes`      | list-of-tree-colon-node-ids                                                                                                                                                                                   |
| `minimum-level`       | integer >= 1                                                                                                                                                                                                  |
| `maximum-level`       | integer >= minimum-level                                                                                                                                                                                      |
| `minimum-prestige`    | integer >= 0                                                                                                                                                                                                  |
| `reward`              | reward-fields                                                                                                                                                                                                 |
| `effects`             | list-of-effect-mappings                                                                                                                                                                                       |
| `metadata`            | scalar-mapping                                                                                                                                                                                                |

## Reward Fields

| Exact field   | Documented accepted value              |
| ------------- | -------------------------------------- |
| `currency`    | configured-currency-id                 |
| `amount`      | integer >= 0                           |
| `currencies`  | currency-id-to-positive-amount-mapping |
| `experience`  | integer >= 0                           |
| `commands`    | list-of-server-commands                |
| `title`       | text                                   |
| `badge`       | text                                   |
| `celebration` | identifier                             |

## Effect Fields

| Exact field      | Documented accepted value                                                                                                                                                        |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key`            | registered-effect-key                                                                                                                                                            |
| `operation`      | add-flat\|add-percent-points\|multiply-base\|multiply-final\|set-min\|set-max\|override\|reroll\|keep-best\|weight-add\|weight-multiply\|unlock\|deny\|transform\|trigger-action |
| `values`         | decimal-or-list-by-rank                                                                                                                                                          |
| `stacking-group` | identifier                                                                                                                                                                       |
| `aggregation`    | sum\|product\|highest\|lowest\|first\|last\|average\|diminishing\|top-n\|exclusive                                                                                               |
| `cap`            | decimal                                                                                                                                                                          |
| `priority`       | integer                                                                                                                                                                          |
| `scope`          | identifier                                                                                                                                                                       |
| `filters`        | scalar-or-list-mapping                                                                                                                                                           |
| `when-missing`   | ignore\|disable-effect\|disable-node\|hide-node\|refund-node\|error                                                                                                              |

## Metadata Conventions

| Exact field              | Documented accepted value            |
| ------------------------ | ------------------------------------ |
| `discover-nodes`         | comma-separated-tree-colon-node-ids  |
| `break-events`           | comma-separated-event-ids            |
| `source`                 | module-colon-entry-id                |
| `admin-only`             | boolean                              |
| `mode`                   | text                                 |
| `trackable`              | boolean                              |
| `tree`                   | tree-id                              |
| `node`                   | node-id                              |
| `required-rank`          | integer >= 1                         |
| `minimum-contribution`   | integer >= 1                         |
| `branch-group`           | identifier                           |
| `minimum-party-size`     | integer 1-6                          |
| `maximum-party-size`     | integer 1-6                          |
| `minimum-unique-types`   | integer 0-18                         |
| `required-types`         | comma-separated-Pokemon-types        |
| `excluded-types`         | comma-separated-Pokemon-types        |
| `required-species`       | comma-separated-Pokemon-species      |
| `excluded-species`       | comma-separated-Pokemon-species      |
| `monotype`               | boolean                              |
| `unique-species`         | boolean                              |
| `all-healthy`            | boolean                              |
| `same-generation`        | boolean                              |
| `minimum-average-level`  | integer >= 0                         |
| `dimensions`             | comma-separated-dimension-ids        |
| `biomes`                 | comma-separated-biome-ids            |
| `weather`                | clear\|rain\|thunder                 |
| `time`                   | day\|night                           |
| `moon-phases`            | comma-separated-integers-0-through-7 |
| `minimum-y`              | integer                              |
| `maximum-y`              | integer                              |
| `maximum-spawn-distance` | integer >= 0                         |
| `recommended-classes`    | comma-separated-class-ids            |
| `recommended-types`      | comma-separated-Pokemon-types        |
| `recommended-species`    | comma-separated-Pokemon-species      |

## Styled Text Formats

| Exact field        | Documented accepted value                                                                                                                |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `legacy`           | "\&aGreen \&lBold \&rReset"                                                                                                              |
| `hex`              | "\&#55DDF0Cyan or <#55DDF0>Cyan"                                                                                                         |
| `gradient`         | "<gradient:#55DDF0:#B388FF:#FFD166>Trainer Journey"                                                                                      |
| `supported-fields` | suite-title\|suite-subtitle\|module-title\|module-description\|entry-title\|entry-description\|reward-title\|reward-badge\|locale-values |
