Content generated with AI — it may contain mistakes.

ExyliaKillEffect/ReferenceUpdated in v1.10.0

Configuration

Where ExyliaKillEffect keeps its files, how to reload them, and every block of config.yml and messages.yml with its default.

Page 14 of 2216 min read
       - PLAYER    - MANNEQUIN    - ZOMBIE             

ExyliaKillEffect is set in plugins/ExyliaKillEffect/config.yml. The effects themselves are in effects.yml (Effects, Sequences), and every word a player reads is in lang/<code>/. After editing, run /killeffectsadmin reload: it re-reads this plugin's files only, not ExyliaLib's.

config.yml is written from a schema: comments are regenerated on every start, unknown keys are dropped, and a key you delete comes back with its default. Colour codes and {tags} in messages are explained in Colours, and editing a language in Messages and languages.

language#

yaml
language: default

Which language folder under plugins/ExyliaKillEffect/lang/ the menus and messages are read from. default follows the language in ExyliaLib's own config.yml, so one line there switches every Exylia plugin; en, es, pt, fr, ru or tr set this plugin alone. Each language is a complete folder you can edit:

plugins/ExyliaKillEffect/
  config.yml
  effects.yml
  lang/es/messages.yml
  lang/es/menus/effects.yml
  lang/es/menus/crate.yml
  lang/es/menus/crate_open.yml

English is the base the others are laid over, so a line not translated yet still arrives in English. A changed language takes effect on /killeffectsadmin reload.

Servers that ran 1.5.0 keep their edits

On the first start of 1.7.0 the old menus/ move to lang/custom/, the item names and lore, the weapon lines, the menu's wording, the visibility names and the placeholder answers config.yml used to hold move into lang/custom/messages.yml, and config.yml is pointed at it with language: custom. The old messages: block is not carried across: chat lines edited there start again from the defaults and have to be edited once more in messages.yml. Set language to default or a code to switch to the shipped translations.

disabled-worlds and random-worlds#

yaml
disabled-worlds: []
random-worlds: []

Both are top-level lists of world names, empty by default, matched ignoring case.

  • disabled-worlds: kill effects never play there.
  • random-worlds: every kill plays a random effect from the whole catalogue, whatever the killer owns or picked, even a killer with no effect at all. Useful for duel or arena worlds.

A world in both lists stays silent: disabled-worlds wins.

behaviour#

Where the effect a kill plays comes from, and what tokens do.

yaml
behaviour:
  mode: both
  consume-token: true
  consume-remover: true
  hide-without-permission: false
  defaults: []

mode is player (only what the player picked in /killeffect), weapon (only what is bound to the weapon) or both (the default: the weapon's own effect, then the player's choice for a weapon carrying none). See Modes and tokens.

Choosing an effect in the menu always needs its node or an unlock; a token, a bound weapon, a command and the API never do. See Permissions.

All behaviour keys
KeyDefaultWhat it does
modebothplayer, weapon or both.
consume-tokentrueWhether the token is spent when it is bound.
consume-removertrueWhether the remover is spent when it unbinds.
hide-without-permissionfalseWhether locked effects are hidden in the menu instead of shown locked.
defaults[]The effect a player plays while they have not picked one, by rank. Read top to bottom, the first line they qualify for wins; each line is permission (empty means everyone, keep it last) and cosmetic (an effect id, random for a random one they own, or none). Nothing is unlocked or saved: the menu marks it as the rank default, and a player who takes it off plays nothing. Ignored when mode is weapon. Example: - permission: group.vip / cosmetic: random, then - permission: '' / cosmetic: griddy.

effects#

Which kills play anything at all. By default only a player, a mannequin or a zombie dying plays an effect.

yaml
effects:
  all-mobs: false
  allowed-mobs:
    - PLAYER
    - MANNEQUIN
    - ZOMBIE
  ground-snap: 4.0
all-mobs on a farming server

all-mobs: true means every zombie in a grinder fires a whole sequence. Kill effects are usually meant for PvP: keep the list unless you want a production on every mob death. Either way one player starts at most three effects a second; a sweep through a farm plays the first three and drops the rest.

A player killed mid-jump or knocked off a ledge dies in the air, where a choreography that was drawn to land on a floor has nothing to land on. ground-snap looks that many blocks down for the ground under them and plays the effect there instead. 0 plays exactly where they died.

All effects keys
KeyDefaultWhat it does
all-mobsfalsetrue plays an effect on every kill, whatever died.
allowed-mobsPLAYER, MANNEQUIN, ZOMBIEWhich kills play an effect while all-mobs is off.
ground-snap4.0How far below the kill the floor is looked for, in blocks. 0 turns it off.

trial#

Now and then, a kill by a player carrying no effect plays one they do not own: a cosmetic sells best in the moment it is seen doing its job. It is on by default, at one kill in two hundred.

yaml
trial:
  enabled: true
  chance: 0.5

chance is the odds on each of their kills, in percent: 0.5 is one kill in two hundred. Only a player carrying nothing is ever given one, so it never overrides what somebody chose or won. When the effect has finished they are sent trial-played from messages.yml, which points them at /killeffect. Set enabled: false to turn it off.

token-item, remover-item and key-item#

yaml
token-item:
  material: FIREWORK_STAR
  glow: true
 
remover-item:
  material: SCRAPE_POTTERY_SHERD
  glow: true
 
key-item:
  material: TRIPWIRE_HOOK
  glow: true

material is only used when the effect sets no icon of its own: a token is normally drawn as the effect's own material. What each item is called and what its lore says is in messages.yml.

key-item is the key a player holds: right click a crate block with one and it opens. See The crate.

weapon-lore#

yaml
weapon-lore:
  enabled: true

Whether the lines under a bound weapon are drawn. They are drawn on packets only, so the item itself never carries them, and the lines themselves are weapon-lore in messages.yml.

yaml
menu:
  favourites-icon: "AMETHYST_SHARD"
  style: CLASSIC

style decides what /killeffect opens: CLASSIC is the inventory menu, SPATIAL is the 3D selector, laid out in spatial/effects.yml. /killeffect 3d and /killeffect classic open one or the other whatever this says. favourites-icon is the material the favourites tab is drawn as (AMETHYST_SHARD by default).

What the menu calls things is in messages.yml, and the inventory screen itself is menus/effects.yml; see The menu and Edit menus.

tiers#

The rarities effects are sorted into, and how often each one comes out of a crate. Add, rename or delete any of them: the key is the id effects.yml writes as tier. An effect naming a rarity that no longer exists falls back to the first one. Full reference on The crate.

yaml
tiers:
  common:
    name: "Common"
    material: GRAY_DYE
    color: "{muted}"
    chance: 60.0
    priority: 1
  rare: { name: "Rare", material: LIGHT_BLUE_DYE, color: "{info}", chance: 25.0, priority: 2 }
  epic: { name: "Epic", material: PINK_DYE, color: "{accent}", chance: 12.0, priority: 3 }
  legendary: { name: "Legendary", material: ORANGE_DYE, color: "{highlight}", chance: 3.0, priority: 4 }

chance is a weight, not a percentage: the shares shown in the menu are worked out from it, so deleting a rarity re-spreads its odds instead of leaving a gap. priority is where it sits in menus, lower first.

crate#

The crate turns a virtual key into a random effect. It is on by default and gives players no keys to start with.

yaml
crate:
  enabled: true
  start-keys: 0
  duplicate-refund: 1
  reward: UNLOCK
  blocks: []
  max-at-once: 4
  spin-frames: 34
  stagger-seconds: 2.0
  on-spin:
    sound:
      name: BLOCK_NOTE_BLOCK_HAT
      pitch: 1.6
  on-win:
    sound:
      name: ENTITY_PLAYER_LEVELUP
      pitch: 1.2
  on-duplicate:
    sound:
      name: BLOCK_NOTE_BLOCK_BASS
      pitch: 0.8
  opening: INVENTORY

Bind crate blocks in game with /killeffectsadmin crate block add rather than by hand: it writes the block you are looking at, and a bound block cannot be broken, blown up or pushed away.

All crate keys
KeyDefaultWhat it does
enabledtrueOff, the crate button says so instead of opening.
start-keys0Keys a player is given the first time they are seen.
duplicate-refund1Keys handed back for an effect already owned.
rewardUNLOCKWhat a crate hands over: UNLOCK (unlocked on the account), ITEM (only the token, so no opening is ever a duplicate) or BOTH. ITEM and BOTH want behaviour.mode set to weapon or both.
blocks[]The blocks that open the crate, each written server,world,x,y,z,yaw,pitch.
max-at-once4How many crates one player may open in one go, up to seven. A player holding exyliakilleffect.crate.max.<n> may open <n> instead, the highest one they hold.
spin-frames34How many faces the first reel runs through. Capped at 200.
stagger-seconds2.0How long after one reel stops the next one does. 0 stops them together.
openingINVENTORYHow an opening is shown. INVENTORY: the reels in menus/crate_open.yml. SPATIAL: a crate in the world in front of the player, its look set by spatial/crate.yml. See The crate.
on-spin / on-win / on-duplicatesoundsFull ExyliaLib effect blocks. on-spin plays on every falling tick; then once per reel as it lands, on-win for something new or on-duplicate for something already owned.

preview#

How a player watches an effect before owning it: from the menu, /killeffect preview or the API. It is ExyliaLib's preview block, nested here. Set the stage with /killeffectsadmin preview location; without one, a preview tells the player it is unavailable. mode is TELEPORT (the default: the player is moved to the stage and back) or MANNEQUIN (nobody moves; the effect is lent to the player to try on mannequins you place with /killeffectsadmin preview mannequin add).

All preview keys
KeyDefaultWhat it does
location""Where the player stands while a preview plays. Only the position is used: a preview always faces north.
distance5.0How far in front of the player the effect plays, in blocks.
settle-ticks / linger-ticks / max-ticks4 / 20 / 600The wait after the teleport, how long the stage is held afterwards, and the most a preview may last.
modeTELEPORTTELEPORT or MANNEQUIN. Switch it with /killeffectsadmin preview mode.
mannequin.locations[]Where the mannequins stand.
mannequin.trial-seconds30How long the effect is lent. A boss bar counts it down.
mannequin.radius12.0Walking further than this from every mannequin ends the loan early.
mannequin.vanish-on-hittrueWhether a struck mannequin disappears for that player while the effect plays, so a kill effect reads as a death.
mannequin.effect-scale1.0How large the effect plays on a mannequin.
mannequin.skins[others, viewer]Whose skin the falling body wears: others (another online player), viewer (the player trying it), defaults (vanilla's skins).

showcase#

Places that play kill effects on their own, 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. With nobody inside radius nothing plays, so an empty lobby costs nothing. Put one where you stand with /killeffectsadmin showcase add.

yaml
showcase:
  locations: []
  pause-seconds: 3.0
  radius: 24.0
  effects: []
All showcase keys
KeyDefaultWhat it does
locations[]Where effects play on a loop, each written server,world,x,y,z,yaw,pitch.
pause-seconds3.0The rest between one effect ending and the next starting.
radius24.0How close a player has to be for a showcase to play and to be seen, in blocks.
effects[]The effect ids a showcase picks from. Empty picks from every effect.

feedback#

yaml
feedback:
  on-bind:
    sound:
      name: BLOCK_ENCHANTMENT_TABLE_USE
      volume: 1.0
      pitch: 1.2
  on-unbind:
    sound:
      name: BLOCK_GRINDSTONE_USE

Full ExyliaLib effect blocks: title, action bar, boss bar, sound, particle and firework are all available on each. on-bind plays when an effect is bound to a weapon or chosen in the menu; on-unbind when one is taken off.

particles#

yaml
particles:
  default-visibility: "ALL"

The visibility a player starts with: ALL, NONE, SELF_ONLY or OTHERS_ONLY. What menus and placeholders call each mode is in messages.yml.

shop#

A locked effect can be bought straight from the menu with currency. The row draws its price and a left click asks the player to confirm before anything is charged. It is on by default but needs an economy to charge anything.

yaml
shop:
  enabled: true
  tier-prices:
    common: 500
    rare: 1500
    epic: 4000
    legendary: 10000

tier-prices is what an effect costs by rarity, in the default currency; a rarity left out is not for sale. A price is a number (500, 2.5k) or a block naming a currency: {amount: 50, currency: gems}. An effect in effects.yml can set its own price, which wins over its rarity's. The money is taken by ExyliaEconomy or Vault (Economy); with neither installed, or with the shop off, locked effects look exactly as they always have.

A bought effect is unlocked on the account, the same as one won from the crate: it outlives a rank and cannot be traded. A purchase that could not be handed over gives the money back. The confirmation and every answer it sends are ExyliaLib's own lines, under purchase in ExyliaLib's messages.yml, shared by every cosmetic plugin.

ownership#

Where what a player unlocks here counts, for networks with several servers.

yaml
ownership:
  scope: global
  global-currencies: []

scope is global (an unlock counts on every server, the default), server, default (this server's network group) or a group name. What was unlocked globally always counts. A purchase paid in one of the global-currencies is kept globally whatever the scope. Restart the server to apply a change. Storage is covered in Database. New in v1.10.0

messages.yml#

Every line the plugin sends, and every word an item or the menu draws, is in lang/<code>/messages.yml. prefix is {primary}&lE-KILLS {letters_black}•<reset> and every other message starts with %prefix%. Placeholders in messages: %effect%, %amount%, %id%, %visibility%, %player%, %location%, plus %prefix%.

Message keys
KeySent when
boundAn effect is bound to a weapon.
unboundAn effect is unbound and returned.
chosenAn effect is chosen in the menu.
clearedThe effect is taken off.
not-a-weaponThe item is not something an effect can be bound to.
wrong-weaponThe effect does not fit that weapon.
unknown-effectThe id names nothing the file declares.
already-boundThe weapon already carries an effect.
no-effectThe weapon carries none.
inventory-fullA remover needs a free slot.
no-permissionThe player does not own the effect.
empty-handA hand-held subcommand with nothing in hand.
given / given-remover / given-keyTokens, removers or crate keys were given.
rewards-claimedA player joins and the rewards that were waiting for them are handed over.
list-header / list-entry / list-empty/killeffectsadmin list.
visibility-setVisibility changed.
refreshedrefresh or validate finished.
menu-disabledThe menu was opened on a weapon server.
favourite-added / favourite-removed / favourites-cleared / favourites-empty / favourites-clear-promptThe shortlist.
random-chosenThe random choice was turned on.
player-resetStaff reset a player's choice: back to the default their rank gives, if any.
confirm-player-clear / confirm-crate-blocks-clear / confirm-showcases-clearThe confirmation before a clear.
crate-won / crate-duplicateA crate landed on something new, or on something already owned.
crate-no-keys / crate-busy / crate-empty / crate-disabledThe crate refused to open.
keys-received / keys-taken / keys-givenKeys changed hands.
unlock-granted / unlock-already / unlock-revokedunlocks subcommands.
crate-block-* / crate-blocks-*crate block subcommands.
preview-location-setThe preview stage was moved.
preview-unavailable / preview-unavailable-adminA preview was asked for before a stage was set.
preview-no-mannequin / preview-no-mannequin-adminA preview was asked for in mannequin mode with no mannequin placed.
preview-trial / preview-trial-barA mannequin trial started, and the boss bar counting it down. %seconds% is what is left.
preview-mode-set / preview-mannequin-* / preview-mannequins-clearedpreview mode and preview mannequin subcommands.
feature-lockedA feature the player's rank does not include: its permission node is denied.
trial-playedA trial effect finished playing.
showcase-* / showcases-*showcase subcommands.

Below the messages, the words drawn rather than sent:

KeyWhat it is
token-item, remover-item, key-itemEach item's name and lore. On the token, %effect% is the effect's name and %weapons% what it fits.
weapon-loreThe lines under a bound weapon. %effect% is the effect's name.
menuWhat the menu calls things: empty, tab-open, tab-closed, weapons-any, weapon-names, favourites-name, favourite-on, favourite-off, random-name, random-on, random-off.
spatialEvery word the 3D selector draws: its buttons, card, hints, tabs and guided tour, plus spot-* for the spatial subcommands.
particlesWhat each visibility mode is called: name-all, name-none, name-self-only, name-others-only.
placeholdersnone, what every %exyliakilleffect_...% placeholder answers when there is no value, and unknown, what one answers when it names something that no longer exists.

menu.weapon-names is how a weapon is written wherever %weapons% is drawn, keyed by family (sword, axe, trident, mace, bow, crossbow, melee, ranged) or by item id (netherite_sword). Anything missing is spelled from its id.

Something missing on this page? Tell us on Discord