DeluxePouches | Animated Rewards 2.4.2
Turn simple reward pouches into cinematic reveal moments with animations, particles, and effects.
2.3.0
Compatibility
Changes
Every setting the plugin shipped but never read now does what the file says it does.
๐ Read This First
A chunk of config.yml and lang.yml used to be decoration. Changing those keys did nothing, so plenty of servers are carrying values that were never tested against real behaviour. Now that they are read, look over your config.yml once after upgrading.
The two that bite hardest are pouch cooldown, which is enforced from this release on, and the animations: block, which now sets how long each animation runs.
โฑ๏ธ Cooldowns Are Real Now
Pouch cooldown was loaded, printed in the menu lore as "Cooldown: 1.0s", and then never checked. Players were shown a limit that did not exist, and the cooldown-active and cooldown-complete messages never sent.
pouches:
starter:
cooldown: 20 # ticks, 20 = 1 second, 0 turns it off
- Counted per player and per pouch, so a cooldown on the starter pouch does not block the legendary one
- Opening a whole stack with shift-click counts as one opening, checked and started once for the stack
deluxepouches.bypass.cooldownskips it
Pouches with no cooldown: line fall back to 20 ticks, which is one second between openings. If you want no cooldown at all, set cooldown: 0 on the pouch.
๐๏ธ The Animations Block Does Something
Each animation reads duration in seconds and speed in ticks between updates.
animations:
spiral:
duration: 3
speed: 1
none:
delay: 7 # ticks before the rewards land, NONE has nothing to draw
The animation lasts the full duration whatever the speed is, it just takes fewer and larger steps, so speed is a performance knob rather than a length one. Values above 10 are capped.
The numbers shipped in 2.3.0 match how each animation behaved in 2.2.0, so a fresh install looks the same. An existing config.yml still carries the old example numbers, which were never read and do not match. To keep 2.2.0 timings, use default: 3, spiral: 3, pulse: 3, floating_orbs: 5, portal_rift: 3, envoy: 2, all with speed: 1.
๐ Reward Actionsactions: on a reward was parsed into an object nobody read. It runs now.
| Tag | What it does |
[message] &aText |
Message the opener |
[broadcastmessage] &aText |
Message everyone online |
[title] Main;Sub;1;3;1 |
Title and subtitle, then fade in, stay and fade out in seconds |
[actionbar] &aText |
Action bar above the hotbar |
[sound] ENTITY_PLAYER_LEVELUP |
Play a sound to the opener |
[command] warp crate |
Run as the player |
[consolecommand] eco give %player% 500 |
Run from console |
[vaultadd] 5000 |
Pay through Vault, needs Vault and an economy plugin |
rewards:
3:
chance: 10
actions:
- "[vaultadd] 50000"
- "[title] &6&lJACKPOT;&e$50,000;1;3;1"
- "[sound] ENTITY_PLAYER_LEVELUP"
{player}, %player%, {amount} and %amount% work in all of them, PlaceholderAPI placeholders too when that plugin is installed, and <center></center> centres a line. The older [console], [player], [broadcast] and bare command forms still work.[vaultadd] is the first thing in the plugin that uses the Vault hook. Until now Vault was detected, reported in /dp version, and never called once.
๐ฌ Messages, Titles and Action Bars
lang.ymlhastitles:andaction-bars:blocks, sent onpouch-openingandreward-received. An empty string turns one offprefixinconfig.ymlworks through a{prefix}token. The shipped messages use it in place of the old&6&l[!]markers, so settingprefix: ""strips the branding everywhere at oncesettings.message-delaythrottles the broadcast opening message per player, so opening a stack no longer floods chat. The opener always sees their own messageshelp-*andlist-*drive/dp helpand/dp list, and%deluxepouches_version%works in the help lines
๐งฐ A Configurable Menu, and Two New Commands
settings:
pouches-menu:
size: 45 # multiple of 9, from 9 to 54
fill-empty-slots: true
empty-slot-item: GRAY_STAINED_GLASS_PANE
show-preview: true
show-info: true
Navigation, the close button and the page indicator follow the configured height instead of assuming five rows.
Two new commands, behind permission nodes that had been declared since 2.0.0 with nothing behind them:
/dp create <id>saves the item in your hand as a new pouch, then reloads/dp edit <id> <setting> <value>changesanimation,effect,cooldown,reward-amountorpermission
โจ Effects and Holograms
effects.sound.openis the fallback opening sound for pouches with noopening-sound, andeffects.sound.rewardplays once the rewards land. The shipped values moved to modern names,BLOCK_CHEST_OPENandENTITY_PLAYER_LEVELUP. The oldCHEST_OPENandLEVEL_UPhad not resolved on any server since 1.21.3effects.particle.typeandcountset the particle every effect draws with, unless its own section names another.effects.guardian_beam.particle_typeandrangeare readhologram.enabledis a master switch,hologram.spacingreplaces a hardcoded value,hologram.visibility.rangehides the hologram past that many blocks, andhologram.animation.particle-trail,particle-typeandparticle-countdrive the trail
๐งน Removed
- The
placeholders:block inconfig.ymland theplaceholder-*keys inlang.yml. They were a reference list sitting in settings files pretending to be settings. The same list is comments inconfig.ymlnow, with%deluxepouches_time%added - The top level
gui:block, whose useful keys moved intosettings.pouches-menu - A duplicate explosion effect class that was unreachable and that no config key ever promised
๐ Also Fixed
[title]actions with no subtitle no longer throw- Effect colours no longer accumulate across openings
- Reloading
lang.ymlproperly drops keys you deleted
โฌ๏ธ Upgrading
Stop the server, drop the new jar in, and start it again. Both config files update themselves on first start.
- Check the
animations:block against the 2.2.0 timings above if you never touched it - Decide the
cooldownyou want on each pouch, or set0to keep 2.2.0 behaviour - If you had custom text in
lang.yml, add{prefix}where you want the prefix to appear - If you used the old top level
gui:block, move your values intosettings.pouches-menu
๐งช Compatibility
Minecraft 1.21 and newer on Paper, Java 21.
Read the documentation | Join the Discord
Enjoying the plugin? A โญ review goes a long way!
Statistics
Views
Purchases
Downloads
File size
Published
Updated