Configuration
A walk through config.yml, which keys matter, and how reloading and config updates work.
DeluxePouches keeps three files in plugins/DeluxePouches:
| File | Contents |
|---|---|
config.yml | Global settings, covered on this page |
pouches.yml | The pouches themselves, see Pouches |
lang.yml | Messages, see Messages |
After editing any of them, run /dp reload. No restart needed.
Global messages
opening-message: "&e%deluxepouches_player% &7has opened a &6%deluxepouches_pouch% &7pouch!"Used by any pouch that does not set its own opening-message or opening-messages.
See Placeholders for what you can put in it.
settings
settings:
broadcast-opening-message: false
message-delay: 20
debug-mode: false| Key | Default | What it does |
|---|---|---|
broadcast-opening-message | false | true sends the opening message to everyone online, not just the opener |
debug-mode | false | Extra console logging. /dp debug toggle flips it and saves it |
message-delay | 20 | Not read by the plugin |
settings.performance
settings:
performance:
limit-particles: true
max-particles: 150
max-firework-power: 2
max-colors: 5
animation-tick-rate: 2| Key | Default | What it does |
|---|---|---|
limit-particles | true | Master switch for the caps below. Also halves particle density in the spiral animation |
max-particles | 150 | Highest particle count any effect may use |
max-firework-power | 2 | Highest firework power |
max-colors | 5 | How many colours an effect may use |
animation-tick-rate | 2 | Ticks between spiral animation updates. Clamped between 1 and 5, higher is cheaper |
If pouches ever cost you frames, raise animation-tick-rate first.
settings.pouches-menu
settings:
pouches-menu:
gui-name: "&8✦ &6&lAvailable &e&lPouches &8✦"Only gui-name is read. See Pouch menu.
settings.worldguard
settings:
worldguard:
enabled: false
blacklisted-regions:
- "world;spawn"
- "world;pvp"| Key | Default | What it does |
|---|---|---|
enabled | false | Turn the region blacklist on. Needs WorldGuard installed |
blacklisted-regions | three examples | Regions where pouches cannot be opened |
Each entry is world;region: the world name, a semicolon, then the region id. Entries
without a semicolon are ignored. See Integrations.
effects
Defaults for each ending effect, keyed by the effect name in lowercase. Covered in full on Effects.
hologram
Defaults for the floating text. Covered in full on Holograms.
Keys that are not read
The shipped config.yml carries a few leftovers. They do nothing, and removing them
changes nothing:
| Key | Use this instead |
|---|---|
prefix | Write the prefix into the messages themselves in lang.yml |
settings.message-delay | Nothing, openings are not queued |
gui: (the top level block) | settings.pouches-menu.gui-name |
settings.pouches-menu.next-page, previous-page, show-preview, show-info, info-button-name, get-button-name | Nothing, the menu layout is fixed |
animations: | Nothing, animation timings are fixed in code |
effects.sound, effects.particle, effects.guardian_beam.particle_type | opening-sound on the pouch, and the effect keys on Effects |
hologram.enabled, hologram.spacing, hologram.visibility.range, hologram.animation.particle-* | The pouch's own hologram block |
placeholders: | Reference notes only, see Placeholders |
Config versions and updates
Each file has a version key at the top: config-version, pouches-version,
lang-version. When an update adds new settings, the plugin merges them into your file
on startup and keeps your values, so you rarely have to touch a fresh copy.
The merge restores the comments from the shipped file. Notes you added yourself in
config.yml or lang.yml can be lost on an update. pouches.yml keeps everything
you wrote, including pouches the plugin does not recognise.
Reloading
/dp reloadReloads all three files, rebuilds every pouch, and refreshes the menu. Pouches already in player inventories keep working, they are matched by the tag stored on the item.
If a pouch stops appearing after a reload, check the console. A pouch with a bad material or no rewards is logged by name and skipped, the rest still load.