Content generated with AI — it may contain mistakes.

Reference

Commands

What a player can do to their own effect, and the admin subcommands, grouped.

Player commands

/killeffect, with the aliases killeffects, deatheffect and deatheffects. Everything under it needs exyliakilleffect.command.killeffect.

CommandWhat it does
/killeffectOpens the menu, on the tab it was last left on.
/killeffect crateOpens the crate, the same screen the button in the menu opens. Aliases: crates, case.
/killeffect preview <effect>Plays an effect on the server's preview stage. Owning it is not required.
/killeffect visibility [mode]Sets who sees kill effects for them. With no mode it steps to the next one.
/killeffect randomPlays a different effect on every kill, or stops when it is already on. Alias: shuffle.
/killeffect favouritesOpens the menu straight onto the shortlist. Aliases: favorites, favs.
/killeffect favourite <effect>Stars an effect, or unstars it. Aliases: favorite, fav.
/killeffect favourites clearEmpties the shortlist.
/killeffect clearTakes the effect off.

Admin commands

/killeffectsadmin, alias /killeffectadmin. Everything under it needs exyliakilleffect.admin. Subcommands are grouped by what they act on: the items, the weapon in hand, a player, their keys, what they own, the crate, the showcases, the screens and the previews.

item — the items this plugin hands out

CommandWhat it does
item give <player> <effect> [1-64]Gives effect tokens.
item remover <player> [1-64]Gives effect removers.
item key <player> [1-64]Gives crate keys as items, to be right clicked on a crate block. Alias: item keys.

weapon — the weapon in the target's hand

CommandWhat it does
weapon bind <effect> [player]Binds an effect to the weapon in hand, replacing whatever it carried.
weapon unbind [player]Strips the effect from the weapon in hand, giving nothing back.

player — what somebody wears

CommandWhat it does
player set <player> <effect>Sets what a player wears.
player clear <player>Takes a player's effect off.
player favourites clear <player>Empties a player's shortlist.
player validate [player]Takes off an effect the target may no longer use. With no player, everyone online.

keys — what opens crates

CommandWhat it does
keys give <player> <amount>Adds crate keys to the player's row. Alias: keys add. The keys that can be held are item key.
keys take <player> <amount>Removes crate keys. Alias: keys remove.
keys set <player> <amount>Sets how many they hold.
keys check <player>Prints how many they hold. Alias: keys.

unlocks — what somebody owns

CommandWhat it does
unlocks grant <player> <effect>Hands an effect over outright, the way a crate does. Alias: unlocks give.
unlocks revoke <player> <effect>Takes one back. Alias: unlocks take.
unlocks clear <player>Takes everything they won back.

crate — the blocks that open it

CommandWhat it does
crate block addBinds the block you are looking at, so clicking it opens the crate.
crate block removeUnbinds the block you are looking at.
crate block listPrints every bound block.
crate block clearUnbinds all of them.

showcase — effects that play on a loop

CommandWhat it does
showcase addPlays kill effects on a loop where you stand, over and over.
showcase removeRemoves the showcase nearest you, up to five blocks away.
showcase listPrints every showcase.
showcase clearRemoves all of them.
CommandWhat it does
menu open <player>Opens the effects menu for someone.
menu crate <player>Opens the crate screen for someone, without spending anything.
preview play <effect> [player]Previews an effect, for yourself or for someone else.
preview locationSets the preview stage to where you stand. Only the position is taken.

The rest

CommandWhat it does
list [category]Prints every effect, or just one category's.
refresh [player]Redraws what a player is holding. With no player, everyone online.
reloadRe-reads this plugin's files.
A player does not have to be online

player, keys and unlocks take a name or a UUID and write straight to the player's row when they are offline, so a support ticket, a rank reward or a wiped season is settled the moment it is decided rather than the next time they log in. The exceptions are the ones that need a body to act on: the whole item group, weapon bind, weapon unbind, player validate, menu open, menu crate, preview play and refresh.

bind, set and give ignore permissions

They are admin verbs: a crate, a rank reward or a support ticket has already decided the player may have the effect. require-permission governs what a player can do, never what an admin or the API does.

What each one actually does

weapon bind

Acts on the target's main hand. An empty hand answers empty-hand. A weapon that already carries an effect has it replaced — the old one is dropped, not returned as a token. The weapon that does not fit the effect's weapons list is refused.

weapon unbind

Strips the value and hands nothing back, which is the difference from a remover item. For giving the token back, have the player use a remover.

player validate

Re-checks the target's choice against their permissions and takes it off if it no longer holds. The same check runs on join, on the next kill and on every menu open — player validate is how you make it immediate after changing a rank.

crate block add

Binds the block you are looking at, up to six blocks away, and writes it to config.yml rather than into the world — so it survives a schematic paste, a world edit and a rollback. While a block is bound it cannot be broken, blown up or pushed away, and clicking it no longer does what its material does: a crate drawn on a barrel must not open a barrel.

showcase add

Writes where you stand to config.yml, as a place that plays a random effect over and over for whoever walks past — a lobby centrepiece rather than a kill. The bodies wear the skins of the players standing nearby, so the crowd watching is the cast, and with nobody inside showcase.radius nothing plays at all: an empty lobby costs nothing. The rest between effects, the radius and which effects a showcase picks from are in Configuration.

preview location

Stores where previews play: where you stand. Only the position is taken — a preview always faces north, so every effect is seen from the side it was drawn for, and the north side of the stage is the one to leave open. Until one is set, /killeffect preview answers preview-unavailable rather than staging an effect on top of whoever asked to see it. Admins are told which command sets it.

refresh

Re-sends the player's inventory so the lines under a bound weapon are redrawn. It touches no file and plays no effect: it is the answer to a weapon whose line went stale.

reload

Runs one step, configs, which re-reads config.yml, effects.yml and the files in menus/, recompiles every sequence and reapplies the message prefix. Edits made to the menu file survive.

It deliberately does not reload ExyliaLib — recolouring every plugin on the server is what /exylialib reload is for.

A reload republishes the catalogue

Effects are recompiled before the new catalogue is published, so nothing plays a half-compiled sequence. But an effect whose key you renamed is a new effect: anyone wearing the old one loses it, and any weapon bound to it now carries an id the file no longer declares.

Something missing on this page? Tell us on Discord