Content generated with AI — it may contain mistakes.

ExyliaKillEffect/GuidesUpdated in v1.9.1

Choose how players pick an effect

Open the effect menu and let players favourite, filter, randomise and buy kill effects.

Page 6 of 228 min read

/killeffect opens one 54-slot window where players wear, preview, star and buy kill effects. This page is how they use it, and how you change what it offers.

Before you start#

Players need exyliakilleffect.command.killeffect (everyone has it by default). The menu changes the effect that follows the player. It never binds an effect to a weapon: that is what the token is for, see Modes and tokens. With behaviour.mode: weapon the menu does not open and tells the player it is disabled on this server.

Steps#

Open it

Run /killeffect. The window is titled KILL EFFECTS. The tabs down the left are the categories, the first one is the player's Favourites, and the open tab's effects fill the grid.

Wear an effect

Left-click an effect. Left-click it again, or click Your effect (top, the nether star), to take it off. Players can only wear effects they own, see Permissions.

Preview it

Right-click an effect to watch it on the preview stage, owned or not. The stage must be set first, see Your first kill effect.

Star it

Shift-click an effect to add it to Favourites, or to remove it. Starring is free: it needs no ownership.

Use the side buttons

Filter (hopper, top) switches between every effect and only the ones the player owns. Random effect (ender pearl, bottom) plays a different effect from the ones they own on every kill. Particle visibility (eye of ender, bottom) cycles whose kill particles they see. Crate (ender chest, top) opens the crate.

Check that it works#

Wear an effect, kill a zombie and watch it play where it fell. Reopen /killeffect: the effect you wear glows and says "This is the one playing", and Your effect names it. A locked effect says "You do not own this effect yet" until you give the player its permission.

Going further#

Let players buy effects#

With shop.enabled: true (the default) and an economy installed, a locked effect that has a price shows it, and a left-click asks the player to confirm, charges them and unlocks it. Set prices per rarity with shop.tier-prices in config.yml, or per effect with price in the catalogue. Players without exyliakilleffect.buy see no price. Currencies come from Economy. Settings: Configuration.

Hide what players cannot use#

By default locked effects are drawn after the owned ones, so what a player can use is never behind a page of locked rows. Set behaviour.hide-without-permission: true in config.yml to drop the locked ones from the grid. The Favourites tab still shows them.

Open the 3D selector instead#

Set menu.style: SPATIAL in config.yml and /killeffect opens the 3D selector. /killeffect classic still opens this window and /killeffect 3d the selector. Players on a client older than 1.21.4 always get this window.

Turn buttons off for a rank#

Each button needs its own permission, all on by default: exyliakilleffect.crate, exyliakilleffect.random, exyliakilleffect.visibility, exyliakilleffect.favourites, exyliakilleffect.preview and exyliakilleffect.buy. Deny one to the default group and give it to a rank to make it a perk. A player without it is told their rank does not include that feature.

Change the layout and the wording#

The layout is lang/<code>/menus/effects.yml, edited like any Exylia menu. Words that one template draws for every row (tab labels, favourites, random, filter, weapon names) are in lang/<code>/messages.yml under menu:, see Messages and languages and Colours.

Technical details: slots, templates, placeholders, actions
SectionSlotsWhat it holds
categories9,18,27,36The tabs, paged with the buttons at slots 0 and 45.
grid11-16,20-25,29-34,38-43The open category's effects, paged at slots 47 and 52.

Fixed buttons: current (Your effect) slot 3, filter slot 4, crate slot 5, particles slot 48, close slot 49, random slot 50.

Clicks on an effect row: left wears it (or takes it off when it is the one worn, or buys it when it is for sale), right previews it, shift-click stars it.

The Favourites tab is not a category in effects.yml; it is different for every player. It is named by menu.favourites-name in messages.yml and drawn with menu.favourites-icon in config.yml (default AMETHYST_SHARD). Starred effects keep the order they were starred in. Shift-click the tab while it is open (it asks to confirm), or run /killeffect favourites clear, to empty it. An empty tab draws empty_template; an owned-only filter that leaves nothing draws none_owned_template.

An effect that a player plays because their rank gives it (see behaviour.defaults in Configuration) carries menu.default-marker.

Where ExyliaLib's screen menu style applies, /killeffect opens one native screen instead of the chest: screens/effects.html with screens/theme.css (words in lang/<code>/screens/effects.yml). The effect under the cursor plays live in a window on it. A screen file that cannot be read keeps the chest menu, and /exylialib screens check lists what is wrong.

Every change to a player's choice (their click, a command, an admin, a lapsed rank) redraws any window they have open.

Templates#

Each list picks a template per row. item_template is the plain state and must stay first.

SectionTemplateUsed when
categoriesitem_templateAnother tab is open.
open_templateThis is the tab being looked at.
favourites_templateThe shortlist tab, while another tab is open.
favourites_open_templateThe shortlist tab while it is open — the only one carrying the "empty the list" action.
griditem_templateAn effect the player owns.
selected_templateThe effect currently worn.
locked_templateAn effect they do not own.
purchasable_templateAn effect they do not own that the shop sells, while an economy can take its price.
empty_templateDrawn on the favourites tab when nothing is starred.

Placeholders#

These are the menu's own tokens, filled in while the screen is drawn. They are not PlaceholderAPI placeholders and only work inside this file.

PlaceholderWhereWhat it draws
%category_id%categoriesThe tab's id — favourites on the shortlist tab.
%category_name%categoriesThe tab's display name.
%category_material%categoriesThe material its icon is drawn with.
%category_total%categoriesHow many effects the tab holds.
%category_owned%categoriesHow many of those the player owns.
%category_status%categoriesmenu.tab-open or menu.tab-closed, depending on whether this is the tab being looked at.
%effect_id%gridThe effect's id.
%effect_name%gridIts display name, with its colours.
%effect_material%gridThe material it is drawn with.
%effect_description%gridIts description from effects.yml.
%effect_weapons%gridWhat it may be bound to, in words.
%effect_favourite%gridmenu.favourite-on or menu.favourite-off, depending on whether it is starred.
%effect_tier%gridThe rarity's name, in the rarity's colour.
%effect_tier_id%gridThe rarity's id.
%effect_tier_color%gridThat colour on its own.
%effect_price%gridWhat it sells for, with its currency. Empty when it is not for sale.
%current_effect%AnywhereThe effect the player is wearing, menu.random-name on random, or menu.empty.
%random_status%Anywheremenu.random-on or menu.random-off.
%favourites_count%AnywhereHow many effects they have starred.
%keys%AnywhereCrate keys they hold.
%unlocked_count%AnywhereHow many effects they have won from the crate.
%catalogue_count%AnywhereHow many effects the server declares.
%particle_visibility%AnywhereThe player's current visibility mode, named as particles.name-* says.
%visibility_all%AnywhereThe name of the "everyone" mode, for a button that offers it.
%visibility_none%AnywhereThe name of the "nobody" mode.
%visibility_self_only%AnywhereThe name of the "only me" mode.
%visibility_others_only%AnywhereThe name of the "only others" mode.

Actions#

ActionWhat it does
killeffect:openOpens the screen.
killeffect:category <id>Switches tab. favourites is a valid id.
killeffect:choose <id>Wears an effect, or takes it off when it is already worn.
killeffect:clearTakes the effect off.
killeffect:favourite <id>Stars or unstars.
killeffect:favourites_clearEmpties the shortlist.
killeffect:buy <id>Asks the player to confirm, then buys a locked effect the shop sells.
killeffect:preview <id>Previews an effect and reopens the menu afterwards.
killeffect:visibilitySteps the viewer's visibility on by one.
killeffect:randomTurns the random choice on, or off when it is already on.
killeffect:crateOpens the crate.
killeffect:crate_open <amount>Spends that many keys and drops that many reels. Used by menus/crate.yml.

Something missing on this page? Tell us on Discord