Content generated with AI — it may contain mistakes.

ExyliaKillEffect/GuidesUpdated in v1.9.1

Choose menu, weapon or both

Decide whether kill effects follow the player, live on weapons or both, and how tokens and removers work.

Page 5 of 225 min read

Choose whether a kill effect follows the player, sits on a weapon or both, then bind your first one to a sword with a token.

The three modes#

behaviour.mode decides where the effect comes from:

ModeWhere it comes fromWhat it implies
playerOnly what the player picked in /killeffect.It follows the player and plays whatever they kill with. Tokens do nothing.
weaponOnly what is bound to the weapon.It is traded, dropped and lost with the weapon. The menu refuses to open and says so.
bothThe weapon's own effect, and the player's choice for a weapon carrying none.The default.

In both the weapon wins: a bound weapon plays its own effect, and the menu choice only covers weapons carrying none.

config.yml
yaml
behaviour:
  mode: both
  consume-token: true
  consume-remover: true
  hide-without-permission: false

Bind an effect to a weapon#

Pick a mode

In config.yml set behaviour.mode to weapon or both, then run /killeffectsadmin reload. With player, tokens do nothing.

Get a token

Run /killeffectsadmin item give <player> <effect> [amount]. Each token carries one effect; its lore lists the weapons it fits.

Drag it onto a weapon

In your own inventory pick the token up with the cursor and click it onto a sword, axe, trident, mace, bow or crossbow. The weapon now plays that effect on its kills.

Take it off again

Run /killeffectsadmin item remover <player> and drag the remover onto the bound weapon the same way. The effect comes back as a token.

Check that it works#

QuestionHow to answer it
Is the effect bound?The weapon shows a Kill Effect: line under its own lore (needs weapon-lore.enabled).
Does it play?Kill with that weapon. In both mode the weapon wins over the menu choice.
Was the token spent?It leaves your cursor when behaviour.consume-token is true (the default).

Going further#

  • Stop the token being used up. Set behaviour.consume-token or behaviour.consume-remover to false.
  • Sell tokens from the crate. Set crate.reward to ITEM or BOTH, see Set up the crate.
  • Limit an effect to some weapons. Declare weapons on it, see Effects.
  • Hide what a player cannot use. Set behaviour.hide-without-permission: true.
  • Reword the weapon lines. See Messages and languages and Colours.
Technical details: token, remover, weapon lines, permissions

The token#

An item that carries one effect. It is used by dragging it onto a weapon in your own inventory: pick the token up with the cursor and click it onto the weapon.

RuleDetail
Weapons onlySwords, axes, tridents, maces, bows and crossbows. Anything else is ignored and the click carries on normally.
One at a timeA weapon that already carries an effect is refused — take the first one off with a remover.
FittingAn effect declaring weapons is refused on a weapon it does not list.
No permissionHolding the token is the proof. It is bought, traded and lost like any other item, so binding it asks for no node.
Consumedconsume-token decides whether it is spent. Off, the token is reusable.

What is written onto the weapon is one value: exyliakilleffect:effect, the effect id. Nothing else on the item changes.

A token is not the item it is drawn as

Tokens and removers are inert: drawn as an ender pearl one cannot be thrown, drawn as food it cannot be eaten. Whatever it looks like, it can only be dropped onto a weapon.

The remover#

Dragged the same way onto a bound weapon. The effect comes off and comes back as a token in the inventory of whoever removed it.

RuleDetail
A free slot firstWith a full inventory nothing happens at all: the weapon is only written once the token is known to fit.
Unknown effectsA weapon carrying an id the file no longer declares is refused rather than turned into nothing.
Consumedconsume-remover decides whether the remover is spent.

Nothing this plugin hands over lands on the floor. A token, a remover or a key given by a command or won from the crate that does not fit waits in the reward queue, and is handed over the next time the player joins.

The lines under a bound weapon#

lang/<code>/messages.yml
yaml
weapon-lore:
  - "{secondary}Kill Effect:"
  - " {letters_black}▎ {highlight}%effect%"

weapon-lore.enabled in config.yml turns them on and off.

They travel on packets only and are never written to the item. Consequences worth knowing:

  • A shop, a crate or any plugin reading that weapon finds exactly the lore it had.
  • Renaming an effect updates every weapon on the server at once.
  • Turning weapon-lore.enabled off hides the lines without touching a single item.

Permission, and what happens when it lapses#

SwitchWhat it does
hide-without-permissionWhether an effect the player may not use is hidden in the menu instead of shown locked.

A choice the player can no longer justify is taken off, not quietly skipped: it is dropped on the next kill, on the next menu open, on join, and on /killeffectsadmin player validate. A starred effect is never dropped — a shortlist is what somebody is saving up for as much as what they already have.

Something missing on this page? Tell us on Discord