Choose menu, weapon or both
Decide whether kill effects follow the player, live on weapons or both, and how tokens and removers work.
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:
| Mode | Where it comes from | What it implies |
|---|---|---|
player | Only what the player picked in /killeffect. | It follows the player and plays whatever they kill with. Tokens do nothing. |
weapon | Only what is bound to the weapon. | It is traded, dropped and lost with the weapon. The menu refuses to open and says so. |
both | The 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.
behaviour:
mode: both
consume-token: true
consume-remover: true
hide-without-permission: falseBind 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#
| Question | How 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-tokenorbehaviour.consume-removertofalse. - Sell tokens from the crate. Set
crate.rewardtoITEMorBOTH, see Set up the crate. - Limit an effect to some weapons. Declare
weaponson 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.
| Rule | Detail |
|---|---|
| Weapons only | Swords, axes, tridents, maces, bows and crossbows. Anything else is ignored and the click carries on normally. |
| One at a time | A weapon that already carries an effect is refused — take the first one off with a remover. |
| Fitting | An effect declaring weapons is refused on a weapon it does not list. |
| No permission | Holding the token is the proof. It is bought, traded and lost like any other item, so binding it asks for no node. |
| Consumed | consume-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.
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.
| Rule | Detail |
|---|---|
| A free slot first | With a full inventory nothing happens at all: the weapon is only written once the token is known to fit. |
| Unknown effects | A weapon carrying an id the file no longer declares is refused rather than turned into nothing. |
| Consumed | consume-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#
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.enabledoff hides the lines without touching a single item.
Permission, and what happens when it lapses#
| Switch | What it does |
|---|---|
hide-without-permission | Whether 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