Content generated with AI — it may contain mistakes.

ExyliaHitEffect/Getting startedUpdated in v1.6.1

Introduction

ExyliaHitEffect plays one of 90 display-driven effects on whoever you hit. In ten minutes your players wear one.

Page 1 of 214 min read

ExyliaHitEffect plays an effect on whoever was struck, on every blow, drawn with real items and blocks that fly and settle. In about ten minutes you will have your players wearing one of 90 effects from a menu, a rank able to use a whole category, and an effect bound to a weapon.

What you will have in 10 minutes#

  1. The plugin installed with its two required jars: Install ExyliaHitEffect.
  2. An effect worn from /hiteffect and played on a hit, with one rank allowed a category: Your first hit effect.
  3. Optionally, effects won from a crate, bought in the menu, or carried on weapons through tokens.

Two ways to own an effect#

WayWhose it isWhich server it suits
The menuThe player's: they pick one in /hiteffect and it plays whatever they hit with.Practice, PvP
A weaponThe weapon's: a token dropped onto a weapon travels with it through chests, trades and deaths.Survival, economy

A player owns an effect by permission, by winning it in the crate, or by buying it in the menu. behaviour.mode (player, weapon or both) decides which is read. The menu is an inventory window or a 3D selector where an effect is tried on a mannequin before it is worn.

Requirements#

RequirementDetail
ServerPaper 1.21.1 or newer; Folia 1.21.4 or newer. The 3D selector and the 3D crate opening need a 1.21.4 client, and older clients get the inventory screens.
Requiredpacketevents
RecommendedExyliaLib (a soft depend: the loader installs it)
OptionalPlaceholderAPI; ExyliaEconomy or Vault for the menu's shop
DatabaseAlways. The choice, the visibility and the favourites live in one table, the crate keys and unlocks in ExyliaLib's.
LanguagesEnglish, Spanish, Portuguese, French, Russian and Turkish ship with it.
How it works

Built to a budget#

A kill effect plays once and can afford to be a production. A hit effect plays on every blow of every fight on the server, so the budget is the design:

RuleWhy
Under six tenths of a secondAn effect still playing when the next hit lands is two effects on top of each other.
Ten displays at the very mostThree players trading blows is thirty of them on screen at once.
Quiet — volume 0.4 to 0.9This is a sound a player hears a thousand times an evening, not once.
Small — about a blockThe anchor is the victim's chest, not their feet. Anything larger reads as a kill effect that went off by mistake.

Every shipped effect is written to those numbers. Anything you add should be too.

The categories#

CategoryIconWhat is in it
impactNETHERITE_SWORDSteel, plate and shock.
crimsonREDSTONEBlood, bone and the red end of a fight.
emberBLAZE_POWDERSparks, scald and soot.
sculkSCULK_SHRIEKERThe deep dark: shriek, echo and decay.
prismAMETHYST_SHARDCrystal, frost and light.
goofySLIME_BALLJokes. Rubber ducks, pies and a sad trumpet.

Fifteen effects each. The whole list is in Effects.

Arrows carry their own answer#

An arrow outlives the state of the hand that fired it — a player switches to a sword while it is still in the air. So the effect is decided and stamped onto the arrow as it leaves the bow, and that is what plays when it lands. A projectile this plugin never saw launched still belongs to its shooter and falls back to whatever they are holding.

Which hits count#

A hit only plays an effect when the victim's type is allowed — effects.all-mobs, or the effects.allowed-mobs list. Cancelled hits play nothing: a blow another plugin refused does not throw sparks.

Visibility is the observer's#

ModeWhat they see
ALLEvery effect, theirs and everybody else's.
NONENone at all.
SELF_ONLYOnly their own hits.
OTHERS_ONLYOnly other people's.

What a weapon carries#

Binding writes one value onto the weapon — exyliahiteffect:effect, the effect id. The lines a player reads under a bound weapon are drawn on the way to the client and are never written to the item, so a shop, a crate or any other plugin reading that weapon finds exactly what it had.

Something missing on this page? Tell us on Discord