Content generated with AI — it may contain mistakes.

ExyliaHitEffect/GuidesUpdated in v1.6.1

Edit the effect catalogue

Rename, reprice, restrict or remove any of the 90 effects, and add your own.

Page 4 of 215 min read

ExyliaHitEffect ships 90 effects in six categories, fifteen each. You can change any of them, or add your own, by editing one file and reloading.

Before you start#

Know which file you edit. The catalogue is plugins/ExyliaHitEffect/lang/<code>/effects.yml, where <code> is your server's language (see Messages and languages). Every language has its own copy, so edit the one your server uses. It is hand-written, so your comments and layout survive a reload, and it is read exactly as written.

Steps#

Open the file

Open lang/<code>/effects.yml. Find the effect under hit_effects, for example CRIT_SPARK.

Change what you want

Edit name (menus and placeholders show it), description, material (the icon), category, tier (its rarity) or price. See the keys below.

Reload

Run /hiteffectsadmin reload. Errors are written to the console with the key that caused them. The rest of the file still loads.

Look at it

Run /hiteffect preview <id>: it plays the effect on the preview stage, then puts you back. See Your first hit effect to set the stage.

Check that it works#

Run /hiteffectsadmin list: your effect appears. Open /hiteffect: it sits in its category with the name and icon you set.

Going further#

Add your own effect#

Add a new key under hit_effects with a category that exists, an effects list, then reload and preview. Keep it under six tenths of a second, ten displays at most, quiet and about a block wide. The full step syntax is in Sequences. Then grant it with exyliahiteffect.effect.<id in lowercase> or the whole category, see Permissions.

A hit effect is not a kill effect

The same syntax draws both, and it is tempting to paste a ten-second production here. On a busy arena that plays once per blow, per player, on every client in range.

Limit an effect to some weapons#

Add weapons to the effect, for example weapons: [ NETHERITE_SWORD, AXE ]. It only matters while behaviour.mode reads weapons (weapon or both, see Modes and tokens). An effect without weapons fits any weapon, and none of the shipped effects declares it. A token is refused on a weapon its effect does not list.

Sell an effect#

Set price on the effect: a number in the default currency, or {amount: 50, currency: gems}. It wins over the rarity's price in shop.tier-prices. See Configuration and the ExyliaLib economy.

Hide or remove an effect#

Delete its entry from hit_effects. To keep it but stop players using it, simply do not grant its permission: operators still own every effect through exyliahiteffect.effect.*.

The effect id is the permission

CRIT_SPARK is exyliahiteffect.effect.crit_spark. Renaming the key renames the permission, and everybody who had the old one loses the effect. Ids are lowercased, so case does not matter.

Technical details
lang/<code>/effects.yml
yaml
categories:
  impact:
    material: NETHERITE_SWORD
    name: 'Impact'
    priority: 1
 
hit_effects:
  CRIT_SPARK:
    category: impact
    tier: common
    name: "<gradient:#FFE9A8:#D1A53F><bold>CRIT SPARK</bold></gradient>"
    material: GOLDEN_SWORD
    description: "Eight splinters of gold, {highlight}gone in a third<nl>of a second{neutral}."
    priority: 1
    effects:
      - '[SOUND] ENTITY_PLAYER_ATTACK_CRIT;0.7;1.4'
      - '[PARTICLE] CRIT;count:12;offset:0.3,0.3,0.3;speed:0.15'
KeyWhat it does
categoryWhich tab it appears under. Must be declared under categories.
tierHow rare it is. Must be declared under tiers in config.yml. Omit it and the effect is common.
nameWhat menus and placeholders call it. Colours, MiniMessage and gradients work.
materialThe item the row is drawn with. Defaults to BARRIER.
descriptionA list is one line per entry; a single string breaks on <nl>.
priorityWhere it sits in its tab; lower comes first. Defaults to 999.
effectsThe steps drawn on whoever was hit.
weaponsOptional. What the effect may be bound to.
priceOptional. What it sells for in the menu.

A category takes material, name and priority. A rarity is declared in config.yml, see The crate. A missing categories section, an effect naming an undeclared category, an entry with no effects and a weapons token that is neither an item nor a family are each reported in the console.

weapons accepts item names and families, matched on the item's name:

FamilyMatches
ANYAnything at all.
SWORDEvery _SWORD.
AXEEvery _AXE (a pickaxe is not one).
TRIDENT, MACE, BOW, CROSSBOWJust that item.
MELEESwords, axes, tridents and maces.
RANGEDBows, crossbows and tridents.

The effect is drawn anchored a block above the victim, so it lands on the body; (0,0,0) in a step is that point.

The shipped catalogue#

Impact — NETHERITE_SWORD

Steel, plate and shock.

CRIT_SPARK SHATTER SHOCKWAVE CLEAVE HAMMERFALL RIVET PLATE_CRACK RECOIL SPLINTER CHIP IRON_BURST PULSE GUARD_BREAK PIERCE SLAM

Crimson — REDSTONE

Blood and bone.

SPLATTER ARTERIAL DRIP RUPTURE BONE_SNAP CRIMSON_RING HAEMORRHAGE MEAT_HOOK BLOOD_MOON SCARLET_LACE VISCERAL CRIMSON_NAIL IRON_TASTE RED_HARVEST CLOT

Ember — BLAZE_POWDER

Sparks, scald and soot.

CINDER MAGMA_CRACK FLASHPOINT EMBER_RING SCALD BLAZE_MARK BACKDRAFT SOOT BRAND FIREFLY PYRE QUENCH SEAR ASH_PUFF FORGE

Sculk — SCULK_SHRIEKER

The deep dark.

SHRIEK SONIC_TAP CATALYST SENSOR DEEP_ECHO WARDEN_MARK SOUL_TUG DARKNESS VEIN_CRAWL RESONATE BLIND_SPOT DECAY ANCIENT_CITY SILENCE SCULK_BLOOM

Prism — AMETHYST_SHARD

Crystal, frost and light.

SHARD FROSTBITE PRISM_SPLIT HALO REFRACT STARLET RUNE MIRROR SNAP_FREEZE LUMEN_TAP AURORA_TOUCH FACET ZENITH_TAP GLASSFALL SOLAR_TICK

Goofy — SLIME_BALL

Jokes.

BONK SEEING_STARS RUBBER_DUCK BUBBLE_POP SLAPSTICK OOF CONFETTI BANANA SQUEAK ANGRY_BEE CARTOON_ANVIL PIE SAD_TRUMPET CHICKEN ROLL_CREDITS

Something missing on this page? Tell us on Discord