> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/pinnapass/getting-started/configuration.md).

# Configuration

Every file reloads with `/pinnapass reload` (config, messages, tiers, quests, Infinite Pass pool and menus). Only the plugin hooks need a restart (a plugin installed later is hooked on the next start).

## config.yml

| Section                     | What it holds                                                                                                                                                                                                              |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `storage`                   | where passes are kept (`h2` file or a shared `mysql` database) and the seconds between saves of changed players (also saved on quit, purchases and claims), see [Storage & MySQL](/p/pinnapass/getting-started/storage.md) |
| `menus`                     | the menu ids opened by `/pass`, `/pass quests`, `/pass infinite`, and the click cooldown                                                                                                                                   |
| `economy`                   | the purchase currency (`vault`, `playerpoints`, `levels`, `pinnaprison:<id>`, `edtools:<id>`, `eddungeons:<id>`, `none`) and its shown name                                                                                |
| `season`                    | name, length, auto-next and what a new season resets, see [Seasons](/p/pinnapass/the-pass/seasons.md)                                                                                                                      |
| `tiers`                     | number of tiers, XP formula, tiers per menu page, see [Tiers & Rewards](/p/pinnapass/the-pass/tiers.md)                                                                                                                    |
| `passes`                    | the Gold and Diamond passes: enabled, name, cost, permission, which tiers are Diamond                                                                                                                                      |
| `multiplier`, `boosters`    | the bought XP multiplier and permission boosters, see [XP](/p/pinnapass/the-pass/xp.md)                                                                                                                                    |
| `xp.activities`             | pass XP per activity, with filters                                                                                                                                                                                         |
| `xp.vanilla-mine-blocks`    | whether vanilla breaks count as `mine-blocks` (`auto`, `true`, `false`)                                                                                                                                                    |
| `hooks.pinnaprison.sources` | which PinnaPrison break sources count as `mine-blocks`                                                                                                                                                                     |
| `quests`                    | time zone, reward rule and the quest categories, see [Quests](/p/pinnapass/quests/quests.md)                                                                                                                               |
| `infinite`                  | the Infinite Pass, see [Infinite Pass](/p/pinnapass/the-pass/infinite.md)                                                                                                                                                  |
| `notifications`             | action bar, boss bar, titles and sounds, see [Notifications](/p/pinnapass/reference/notifications.md)                                                                                                                      |
| `activity`                  | worlds and game modes that don't count, anti-abuse rules, poll intervals                                                                                                                                                   |
| `rewards.aliases`           | your own reward words, e.g. `keys: 'crates key give {player} {1} {2}'`                                                                                                                                                     |

### Anti-abuse (`activity`)

| Key                        | Default                 |                                                                                            |
| -------------------------- | ----------------------- | ------------------------------------------------------------------------------------------ |
| `disabled-worlds`          | `[]`                    | nothing counts in these worlds                                                             |
| `ignore-gamemodes`         | `[CREATIVE, SPECTATOR]` | nothing counts in these game modes                                                         |
| `ignore-placed-blocks`     | `true`                  | breaking a block a player placed isn't a broken block (crops still count when fully grown) |
| `placed-blocks-memory`     | `200000`                | how many placed blocks are remembered (memory only)                                        |
| `ignore-spawner-mobs`      | `true`                  | mobs from spawners aren't kills                                                            |
| `chat-cooldown-seconds`    | `10`                    | a chat message counts at most this often                                                   |
| `stats-interval-seconds`   | `10`                    | how often distances are checked (from the player statistics, no move listener)             |
| `afk-minutes`              | `5`                     | playtime stops counting after this many minutes without moving or looking around           |
| `money-poll-seconds`       | `10`                    | Vault balance checks for money quests                                                      |
| `placeholder-poll-seconds` | `30`                    | PlaceholderAPI reads of placeholder quests                                                 |

## messages.yml

Every chat message, the action bar / boss bar / title texts, labels (owned, not owned, status), time units and the `{bar}` style. A message can be a list of lines; `''` turns it off. Colours: `&` codes, `&#RRGGBB`, `<#RRGGBB>` and `<gradient:#RRGGBB:#RRGGBB>text</gradient>`.

## Other files

| File           |                                                    |
| -------------- | -------------------------------------------------- |
| `tiers.yml`    | [Tiers & Rewards](/p/pinnapass/the-pass/tiers.md)  |
| `quests.yml`   | [Quests](/p/pinnapass/quests/quests.md)            |
| `infinite.yml` | [Infinite Pass](/p/pinnapass/the-pass/infinite.md) |
| `guis/*.yml`   | [Menus](/p/pinnapass/reference/menus.md)           |

## Reward lines

Tiers, quests and Infinite Pass levels share one reward format: `<word>:<value>`, or a plain console command.

| Line                                                                                                                                            | Gives                                                                         |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `console:<command>` / a plain command                                                                                                           | runs from the console (`{player}`, `{uuid}`, `{tier}`, `{level}`)             |
| `player:<command>`                                                                                                                              | the player runs it                                                            |
| `message:<text>`, `broadcast:<text>`, `title:<title>;<subtitle>`, `sound:<sound> [vol] [pitch]`                                                 | texts and sounds                                                              |
| `item:<MATERIAL> [amount] [name]`                                                                                                               | a plain item (inventory first, the rest dropped or to PinnaMailbox)           |
| `money:<amount>`                                                                                                                                | Vault money                                                                   |
| `points:<amount>`                                                                                                                               | PlayerPoints                                                                  |
| `xp:<amount>`                                                                                                                                   | pass XP (no multipliers)                                                      |
| `levels:<n>`, `exp:<n>`                                                                                                                         | vanilla experience levels / points                                            |
| `boost:<multiplier> <seconds>`                                                                                                                  | a personal pass XP boost                                                      |
| `edtools:<currency> <n>`, `eddungeons:<currency> <n>`                                                                                           | EdTools / EdDungeons currencies                                               |
| `currency:<id> <n>`, `token-blocks:<n>`, `gem-blocks:<n>`, `greed-blocks:<enchant> <n>`, `drill:`, `bomb:`, `booster-item:`, `crystal:<id> <n>` | PinnaPrison                                                                   |
| `<alias>:<args>`                                                                                                                                | an alias of `rewards.aliases` (`{1}`, `{2}`... are the words after the colon) |

Tiers can also give full items with `items:` (name, lore, enchantments...), see [Tiers & Rewards](/p/pinnapass/the-pass/tiers.md).
