Content generated with AI — it may contain mistakes.

ExyliaArmorSkin/GuidesUpdated in v1.4.1

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.

Page 8 of 219 min read

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.yml
yaml
skins:
  inferno:
    effects:
      on-equip:
        sound:
          name: ITEM_ARMOR_EQUIP_NETHERITE
          volume: 0.8
          pitch: 1.2

Add a particle while the set is worn

skins.yml
yaml
skins:
  inferno:
    effects:
      set:
        ambient:
          particle: 'FLAME|4|0.4|0.01'
          interval: 0.25
          radius: 32.0

Reload

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.

They fire on a real equip, not on every redraw

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].

KeyWhat it is
on-completeAn effect played once, the moment the set becomes complete.
on-breakAn effect played once, the moment it stops being complete.
ambientThe 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.

SectionKeys
titletext, subtitle, fade-in, stay, fade-out, countdown, time-style
action-bartext, duration, countdown, time-style
boss-bartext, colour, overlay, countdown, count-up, progress, time-style
soundname, volume, pitch, category
particlename, count, spread, speed
fireworkcolours, 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.

They fire on a real equip, not on every redraw

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.

KeyDefaultWhat it is
particle''NAME|count|spread|speed. Empty for none.
sound''NAME|volume|pitch. Empty for none.
interval1.0Seconds between repetitions. Values below 0.05 are raised to it.
radius32.0Blocks 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:

PieceHeight
helmet1.7
chestplate1.2
leggings0.7
boots0.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.

An interval of 0.05 is a task every tick, per piece, per player

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.

SkinSet ambient particleIntervalon-equip soundon-complete sound
rainbowNOTE|3|0.5|00.5 sBLOCK_NOTE_BLOCK_CHIMEBLOCK_NOTE_BLOCK_BELL
pastelEND_ROD|2|0.4|00.5 sBLOCK_AMETHYST_BLOCK_CHIMEBLOCK_AMETHYST_BLOCK_CHIME
infernoFLAME|4|0.4|0.010.25 sITEM_FIRECHARGE_USEENTITY_BLAZE_SHOOT
oceanBUBBLE_POP|3|0.4|00.3 sAMBIENT_UNDERWATER_ENTERENTITY_DOLPHIN_SPLASH
heartbeatHEART|1|0.3|01.2 sENTITY_WARDEN_HEARTBEATENTITY_WARDEN_HEARTBEAT
toxicSNEEZE|2|0.4|0.020.4 sENTITY_CREEPER_HURTENTITY_CREEPER_PRIMED
galaxyEND_ROD|2|0.5|0.010.4 sBLOCK_AMETHYST_CLUSTER_PLACEBLOCK_END_PORTAL_FRAME_FILL
auroraGLOW|3|0.5|00.4 sBLOCK_AMETHYST_CLUSTER_PLACEBLOCK_BEACON_ACTIVATE
emberSMALL_FLAME|3|0.4|0.010.4 sBLOCK_FIRE_AMBIENTITEM_FIRECHARGE_USE
voltageELECTRIC_SPARK|4|0.4|0.050.25 sBLOCK_COPPER_BULB_TURN_ONBLOCK_COPPER_BULB_TURN_ON
tempestCLOUD|3|0.5|0.020.4 sENTITY_BREEZE_WIND_BURSTENTITY_BREEZE_SHOOT
sakuraCHERRY_LEAVES|3|0.5|00.4 sBLOCK_CHERRY_WOOD_PLACEBLOCK_NOTE_BLOCK_CHIME
shogunCRIT|3|0.4|0.050.5 sITEM_ARMOR_EQUIP_NETHERITEENTITY_PLAYER_ATTACK_SWEEP
dragonfireLAVA|2|0.4|00.35 sENTITY_PHANTOM_FLAPENTITY_BLAZE_SHOOT
void_dragonDRAGON_BREATH|3|0.5|0.010.35 sBLOCK_RESPAWN_ANCHOR_AMBIENTBLOCK_END_PORTAL_FRAME_FILL
frostbiteSNOWFLAKE|4|0.5|0.010.4 sBLOCK_POWDER_SNOW_STEPBLOCK_GLASS_BREAK
neonGLOW|3|0.4|00.3 sBLOCK_BEACON_POWER_SELECTBLOCK_BEACON_POWER_SELECT
verdantFALLING_SPORE_BLOSSOM|2|0.5|00.5 sBLOCK_MOSS_PLACEBLOCK_AZALEA_PLACE
bloodmoonCRIMSON_SPORE|4|0.5|00.4 sENTITY_WOLF_GROWLENTITY_WOLF_HOWL
celestialWAX_ON|3|0.5|00.4 sBLOCK_AMETHYST_BLOCK_CHIMEBLOCK_AMETHYST_BLOCK_RESONATE
thunderlordFIREWORK|3|0.4|0.020.3 sITEM_TRIDENT_RIPTIDE_1ITEM_TRIDENT_RETURN
phoenixFALLING_LAVA|2|0.4|00.3 sENTITY_BLAZE_AMBIENTENTITY_BLAZE_SHOOT
tidecallerNAUTILUS|3|0.5|0.010.35 sENTITY_DOLPHIN_AMBIENT_WATERBLOCK_CONDUIT_ACTIVATE
starfallENCHANTED_HIT|4|0.5|0.020.3 sENTITY_EXPERIENCE_ORB_PICKUPBLOCK_AMETHYST_BLOCK_CHIME
magmacoreLANDING_LAVA|2|0.3|00.4 sBLOCK_LAVA_AMBIENTENTITY_MAGMA_CUBE_JUMP
glacierITEM_SNOWBALL|4|0.5|0.010.4 sBLOCK_POWDER_SNOW_PLACEENTITY_PLAYER_HURT_FREEZE
spectreSOUL|3|0.5|0.010.4 sENTITY_PHANTOM_FLAPENTITY_VEX_CHARGE
midasWAX_OFF|3|0.4|00.4 sITEM_ARMOR_EQUIP_GOLDBLOCK_NOTE_BLOCK_BELL
prismaticENCHANT|5|0.5|0.020.3 sBLOCK_AMETHYST_BLOCK_RESONATEBLOCK_AMETHYST_BLOCK_CHIME
nebulaREVERSE_PORTAL|4|0.5|0.010.4 sBLOCK_AMETHYST_BLOCK_RESONATEBLOCK_END_PORTAL_FRAME_FILL
venomWARPED_SPORE|4|0.5|00.35 sENTITY_SPIDER_AMBIENTENTITY_WITCH_CELEBRATE
solarflareFLAME|5|0.5|0.020.25 sENTITY_BLAZE_BURNITEM_FIRECHARGE_USE
abyssSQUID_INK|3|0.5|00.45 sENTITY_GUARDIAN_AMBIENTBLOCK_CONDUIT_ACTIVATE
runeforgedSOUL_FIRE_FLAME|3|0.4|0.010.4 sBLOCK_ANVIL_USEBLOCK_SMITHING_TABLE_USE
blossomfallSPORE_BLOSSOM_AIR|3|0.5|00.5 sBLOCK_PINK_PETALS_PLACEBLOCK_NOTE_BLOCK_FLUTE
wardenSCULK_SOUL|3|0.5|0.010.5 sBLOCK_SCULK_CATALYST_BLOOMBLOCK_SCULK_CATALYST_BLOOM
chromeDUST_PLUME|3|0.4|0.010.4 sITEM_ARMOR_EQUIP_IRONBLOCK_CHAIN_PLACE
wildfireASH|6|0.5|0.020.3 sITEM_FLINTANDSTEEL_USEENTITY_BLAZE_SHOOT
eclipseOMINOUS_SPAWNING|3|0.5|00.45 sBLOCK_RESPAWN_ANCHOR_CHARGEBLOCK_RESPAWN_ANCHOR_SET_SPAWN
arcanePORTAL|5|0.5|0.010.35 sBLOCK_ENCHANTMENT_TABLE_USEENTITY_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.

Swapping one complete set for another is silent

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