Installation
Requirements, the install steps, what the first run creates, and the optional plugins you can add.
Requirements
| Requirement | Notes |
|---|---|
| Paper 1.21 or newer | Paper forks such as Purpur work too. Plain Spigot does not. |
| Java 21 or newer | The jar will not load on Java 17. |
| A purchase | See Download. The licence is checked on startup. |
| Internet on the server | Needed on the first start for the licence check and for the config library the server downloads. |
No other plugin is required. Vault, WorldGuard, PlaceholderAPI, Nexo and ItemsAdder are optional, see Integrations.
Install
Stop the server
Shut it down fully. Do not use a plugin manager to hot load the jar, the plugin sets itself up during startup.
Drop in the jar
Put the DeluxePouches jar into your server's plugins/ folder. If you are updating,
delete the old DeluxePouches jar first, but keep the DeluxePouches folder so your
configs survive.
Start the server
On the first start the plugin creates its folder, checks the licence, and downloads a small config library from Maven Central. Both need the server to reach the internet.
Check the console
You are looking for a Loaded N pouches line and the hook lines telling you which
optional plugins were found. The two example pouches for Nexo and ItemsAdder are
skipped unless those plugins are installed, so the count is lower than the number of
entries in the file. If the plugin disabled itself, read FAQ.
Open a pouch
In game, run /dp gui, click one of the example pouches to get it, then right-click
it in your hand. An animation should play and rewards should arrive.
What the first run creates
| File | What it holds |
|---|---|
config.yml | Global settings: prefix, performance caps, menu name, region blacklist, effect defaults, hologram defaults. See Configuration. |
pouches.yml | Every pouch on the server: its item, rewards, animation and effect. See Pouches. |
lang.yml | Every message the plugin sends. See Messages. |
ArrowStats/config.yml and bStats/config.yml | Anonymous usage statistics, shared by every plugin on the server that uses them. Both have an enabled flag you can turn off. |
Pouches used to live inside config.yml. If you are coming from an older setup the
plugin moves them into pouches.yml for you on the first start and logs that it did.
Updating
Swap the jar
Delete the old jar, drop in the new one. Leave the DeluxePouches folder alone.
Start and let the configs update
Each config file carries a version number. When a release adds new settings, the plugin merges them into your file on startup and keeps your values. Comments in the shipped file are restored, so if you left notes of your own, keep a copy.
Optional integrations
| Plugin | What it adds |
|---|---|
| WorldGuard | Block pouch opening inside named regions. |
| PlaceholderAPI | Use placeholders from other plugins inside pouch messages and holograms. |
| Nexo or ItemsAdder | Use their custom items as pouch items or as rewards. |
| Vault | Detected and reported, though money rewards are handed out through your economy plugin's own command. |
Removing the plugin
Delete the jar and the DeluxePouches folder. Pouches already handed to players stop
working, they become plain items with the old name and lore.