Add effects to a skin
Play a sound or particles when a skin goes on, while it is worn and when the whole set is complete.
Effects are what a skin does beyond looking different: a sound or title when it goes on, particles while it is worn, and a bonus when the whole set is on. You end with a skin that plays a sound when equipped and a particle around the body when the set is complete. Every part is optional.
Before you start#
You have a skin, see Create and edit skins. The forty shipped skins already carry effects, so you can copy from them in skins.yml.
Steps#
Open the skin
In skins.yml, find your skin and add an effects block under it.
Add a sound on equip
skins:
inferno:
effects:
on-equip:
sound:
name: ITEM_ARMOR_EQUIP_NETHERITE
volume: 0.8
pitch: 1.2Add a particle while the set is worn
skins:
inferno:
effects:
set:
ambient:
particle: 'FLAME|4|0.4|0.01'
interval: 0.25
radius: 32.0Reload
Run /armorskinsadmin reload.
Check that it works#
Put the skin on: you hear the sound. Wear every piece the skin fits and flames appear around your body; take one off and they stop. If you hear nothing, check the sound name (a Minecraft sound id such as ITEM_ARMOR_EQUIP_NETHERITE) and see Common problems.
Going further#
Titles, action bars and more on equip#
on-equip and on-unequip are standard ExyliaLib effects played to the wearer. Each can carry a title, action-bar, boss-bar, sound, particle and firework. The full reference is the ExyliaLib effects module.
on-equip plays when a piece is equipped or when its skin changes on the body. Joining, respawning, changing world, /armorskinsadmin refresh and /armorskinsadmin reload rebuild the visual silently, so a player logging in is not greeted by four titles. Swapping armour back and forth plays them at most once a second.
Particles on each piece#
ambient repeats at each worn piece, at that piece's own height, for as long as the piece is worn. particle is NAME|count|spread|speed, sound is NAME|volume|pitch, interval is seconds between repetitions (minimum 0.05, default 1.0) and radius is how many blocks around can see or hear it (default 32.0). Details below.
Set bonus#
effects.set fires when a player wears every piece the skin fits with that same skin: all four when pieces is empty, two for a skin with pieces: [helmet, chestplate].
| Key | What it is |
|---|---|
on-complete | An effect played once, the moment the set becomes complete. |
on-break | An effect played once, the moment it stops being complete. |
ambient | The same keys as the per-piece ambient, played around the player at a height of 1.0 while the set holds. |
The set is judged from the topmost skinned piece downwards: whatever skin sits in the first occupied slot is the only one that can complete. Three inferno pieces and an ocean helmet complete nothing.
Every shipped skin carries the full show: a sound as it goes on, a particle around the body while the set holds, an action bar line ✦ Full set » <NAME> when it closes and ✧ Set broken when it ends. Changing straight from one complete set to another plays the new on-complete but not the old on-break.
The sound of applying and removing#
Putting a skin on and taking it off with a skin item or remover play their own sound, set under effects.on-apply and effects.on-remove in config.yml (defaults ITEM_ARMOR_EQUIP_LEATHER and ITEM_BUNDLE_REMOVE_ONE, volume 0.7). They only fire on a successful drag in the inventory: a refused apply plays nothing, and neither does the API.
Effect sections and ambient keys
on-equip and on-unequip
Both are standard ExyliaLib effects, so each one may carry any combination of six sections. They are played to the wearer.
| Section | Keys |
|---|---|
title | text, subtitle, fade-in, stay, fade-out, countdown, time-style |
action-bar | text, duration, countdown, time-style |
boss-bar | text, colour, overlay, countdown, count-up, progress, time-style |
sound | name, volume, pitch, category |
particle | name, count, spread, speed |
firework | colours, fades, shape, flicker, trail |
A section that says nothing is left out of the file entirely, which is why the default skins.yml
shows no sound: block under on-equip. Write the section by hand and it is read from then on. The
full reference lives in the ExyliaLib effects module.
on-equip plays when a piece is equipped or when its skin changes on the body. Joining, respawning,
changing world, /armorskinsadmin refresh and /armorskinsadmin reload all rebuild the visual silently — a
player logging in is not greeted by four titles. Swapping armour back and forth plays them at most
once a second: a change inside that second redraws the piece without a sound.
ambient
Repeated for as long as the piece is worn.
| Key | Default | What it is |
|---|---|---|
particle | '' | NAME|count|spread|speed. Empty for none. |
sound | '' | NAME|volume|pitch. Empty for none. |
interval | 1.0 | Seconds between repetitions. Values below 0.05 are raised to it. |
radius | 32.0 | Blocks around the player that can see or hear it. Values below 1.0 are raised to it. |
Both lines are pipe-separated, and a namespaced key survives because the colon is never a separator:
minecraft:flame|10|0.4|0.01 is valid. The particle line also accepts the longer
NAME|count|dx|dy|dz|speed form when you want the spread to differ per axis.
Where it plays#
At the wearer's feet plus the height of the piece the skin is on, so four skinned pieces are four different heights:
| Piece | Height |
|---|---|
helmet | 1.7 |
chestplate | 1.2 |
leggings | 0.7 |
boots | 0.2 |
What it costs#
One repeating task per worn piece that declares an ambient, bound to the player's entity so Folia is happy and so it dies with them. It is cancelled the moment the piece comes off, the skin changes, or the player quits; nothing survives a plugin disable.
The floor exists so a typo cannot ask for less, not as an invitation. A particle once a second on a chestplate is what the defaults are shaped for.
Effects shipped on every skin
What the defaults ship#
Every shipped skin now carries the full show: a sound as it goes on, a particle around the body
while the set holds, an action bar line — ✦ Full set » <NAME> — when it closes and
✧ Set broken when it ends.
| Skin | Set ambient particle | Interval | on-equip sound | on-complete sound |
|---|---|---|---|---|
rainbow | NOTE|3|0.5|0 | 0.5 s | BLOCK_NOTE_BLOCK_CHIME | BLOCK_NOTE_BLOCK_BELL |
pastel | END_ROD|2|0.4|0 | 0.5 s | BLOCK_AMETHYST_BLOCK_CHIME | BLOCK_AMETHYST_BLOCK_CHIME |
inferno | FLAME|4|0.4|0.01 | 0.25 s | ITEM_FIRECHARGE_USE | ENTITY_BLAZE_SHOOT |
ocean | BUBBLE_POP|3|0.4|0 | 0.3 s | AMBIENT_UNDERWATER_ENTER | ENTITY_DOLPHIN_SPLASH |
heartbeat | HEART|1|0.3|0 | 1.2 s | ENTITY_WARDEN_HEARTBEAT | ENTITY_WARDEN_HEARTBEAT |
toxic | SNEEZE|2|0.4|0.02 | 0.4 s | ENTITY_CREEPER_HURT | ENTITY_CREEPER_PRIMED |
galaxy | END_ROD|2|0.5|0.01 | 0.4 s | BLOCK_AMETHYST_CLUSTER_PLACE | BLOCK_END_PORTAL_FRAME_FILL |
aurora | GLOW|3|0.5|0 | 0.4 s | BLOCK_AMETHYST_CLUSTER_PLACE | BLOCK_BEACON_ACTIVATE |
ember | SMALL_FLAME|3|0.4|0.01 | 0.4 s | BLOCK_FIRE_AMBIENT | ITEM_FIRECHARGE_USE |
voltage | ELECTRIC_SPARK|4|0.4|0.05 | 0.25 s | BLOCK_COPPER_BULB_TURN_ON | BLOCK_COPPER_BULB_TURN_ON |
tempest | CLOUD|3|0.5|0.02 | 0.4 s | ENTITY_BREEZE_WIND_BURST | ENTITY_BREEZE_SHOOT |
sakura | CHERRY_LEAVES|3|0.5|0 | 0.4 s | BLOCK_CHERRY_WOOD_PLACE | BLOCK_NOTE_BLOCK_CHIME |
shogun | CRIT|3|0.4|0.05 | 0.5 s | ITEM_ARMOR_EQUIP_NETHERITE | ENTITY_PLAYER_ATTACK_SWEEP |
dragonfire | LAVA|2|0.4|0 | 0.35 s | ENTITY_PHANTOM_FLAP | ENTITY_BLAZE_SHOOT |
void_dragon | DRAGON_BREATH|3|0.5|0.01 | 0.35 s | BLOCK_RESPAWN_ANCHOR_AMBIENT | BLOCK_END_PORTAL_FRAME_FILL |
frostbite | SNOWFLAKE|4|0.5|0.01 | 0.4 s | BLOCK_POWDER_SNOW_STEP | BLOCK_GLASS_BREAK |
neon | GLOW|3|0.4|0 | 0.3 s | BLOCK_BEACON_POWER_SELECT | BLOCK_BEACON_POWER_SELECT |
verdant | FALLING_SPORE_BLOSSOM|2|0.5|0 | 0.5 s | BLOCK_MOSS_PLACE | BLOCK_AZALEA_PLACE |
bloodmoon | CRIMSON_SPORE|4|0.5|0 | 0.4 s | ENTITY_WOLF_GROWL | ENTITY_WOLF_HOWL |
celestial | WAX_ON|3|0.5|0 | 0.4 s | BLOCK_AMETHYST_BLOCK_CHIME | BLOCK_AMETHYST_BLOCK_RESONATE |
thunderlord | FIREWORK|3|0.4|0.02 | 0.3 s | ITEM_TRIDENT_RIPTIDE_1 | ITEM_TRIDENT_RETURN |
phoenix | FALLING_LAVA|2|0.4|0 | 0.3 s | ENTITY_BLAZE_AMBIENT | ENTITY_BLAZE_SHOOT |
tidecaller | NAUTILUS|3|0.5|0.01 | 0.35 s | ENTITY_DOLPHIN_AMBIENT_WATER | BLOCK_CONDUIT_ACTIVATE |
starfall | ENCHANTED_HIT|4|0.5|0.02 | 0.3 s | ENTITY_EXPERIENCE_ORB_PICKUP | BLOCK_AMETHYST_BLOCK_CHIME |
magmacore | LANDING_LAVA|2|0.3|0 | 0.4 s | BLOCK_LAVA_AMBIENT | ENTITY_MAGMA_CUBE_JUMP |
glacier | ITEM_SNOWBALL|4|0.5|0.01 | 0.4 s | BLOCK_POWDER_SNOW_PLACE | ENTITY_PLAYER_HURT_FREEZE |
spectre | SOUL|3|0.5|0.01 | 0.4 s | ENTITY_PHANTOM_FLAP | ENTITY_VEX_CHARGE |
midas | WAX_OFF|3|0.4|0 | 0.4 s | ITEM_ARMOR_EQUIP_GOLD | BLOCK_NOTE_BLOCK_BELL |
prismatic | ENCHANT|5|0.5|0.02 | 0.3 s | BLOCK_AMETHYST_BLOCK_RESONATE | BLOCK_AMETHYST_BLOCK_CHIME |
nebula | REVERSE_PORTAL|4|0.5|0.01 | 0.4 s | BLOCK_AMETHYST_BLOCK_RESONATE | BLOCK_END_PORTAL_FRAME_FILL |
venom | WARPED_SPORE|4|0.5|0 | 0.35 s | ENTITY_SPIDER_AMBIENT | ENTITY_WITCH_CELEBRATE |
solarflare | FLAME|5|0.5|0.02 | 0.25 s | ENTITY_BLAZE_BURN | ITEM_FIRECHARGE_USE |
abyss | SQUID_INK|3|0.5|0 | 0.45 s | ENTITY_GUARDIAN_AMBIENT | BLOCK_CONDUIT_ACTIVATE |
runeforged | SOUL_FIRE_FLAME|3|0.4|0.01 | 0.4 s | BLOCK_ANVIL_USE | BLOCK_SMITHING_TABLE_USE |
blossomfall | SPORE_BLOSSOM_AIR|3|0.5|0 | 0.5 s | BLOCK_PINK_PETALS_PLACE | BLOCK_NOTE_BLOCK_FLUTE |
warden | SCULK_SOUL|3|0.5|0.01 | 0.5 s | BLOCK_SCULK_CATALYST_BLOOM | BLOCK_SCULK_CATALYST_BLOOM |
chrome | DUST_PLUME|3|0.4|0.01 | 0.4 s | ITEM_ARMOR_EQUIP_IRON | BLOCK_CHAIN_PLACE |
wildfire | ASH|6|0.5|0.02 | 0.3 s | ITEM_FLINTANDSTEEL_USE | ENTITY_BLAZE_SHOOT |
eclipse | OMINOUS_SPAWNING|3|0.5|0 | 0.45 s | BLOCK_RESPAWN_ANCHOR_CHARGE | BLOCK_RESPAWN_ANCHOR_SET_SPAWN |
arcane | PORTAL|5|0.5|0.01 | 0.35 s | BLOCK_ENCHANTMENT_TABLE_USE | ENTITY_EVOKER_CAST_SPELL |
Every one of them uses a radius of 32 blocks, an equip sound at volume 0.7 and a completion sound at
volume 0.7, pitch 1.4, category PLAYERS. Since 1.4 none of them uses a loud or dramatic sound
(thunder, dragons, fireworks, the totem). Since 1.4.1 a skins.yml written by an earlier version is
moved to them too, sound by sound: an equip or completion sound still exactly as 1.3 shipped it is
swapped, one the owner changed or tuned is kept. on-break is the same everywhere:
BLOCK_BEACON_DEACTIVATE at volume 0.7 with the broken-set line.
Changing straight from a complete inferno set to a complete ocean set plays ocean's
on-complete but not inferno's on-break — the break line is for a set that actually ended.
Something missing on this page? Tell us on Discord