Configuration
Where ExyliaHitEffect keeps its files, how to reload them, and every block of config.yml and messages.yml with its default.
ExyliaHitEffect is set in plugins/ExyliaHitEffect/config.yml. The effects themselves are in effects.yml (Effects, Sequences), and every word a player reads is in lang/<code>/. After editing, run /hiteffectsadmin reload: it re-reads this plugin's files only, not ExyliaLib's. You can also change any key from the SETTINGS button of /hiteffectsadmin without opening the file (Installation).
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. It holds how the plugin behaves; every
word a player reads is in lang/<code>/messages.yml, at the end of this page. Colour codes and
{tags} in messages are explained in Colours, and editing a language in
Messages and languages.
language#
language: defaultWhich folder under plugins/ExyliaHitEffect/lang/ the menus and messages are read from. default
follows the language set 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/ExyliaHitEffect/
config.yml
effects.yml
lang/es/messages.yml
lang/es/menus/effects.yml
lang/es/menus/crate.yml
lang/es/menus/crate_open.ymlEnglish is the base the others are laid over, so a line not translated yet still arrives in English.
A changed language takes effect on /hiteffectsadmin reload.
On the first start of 1.4.0 the old menus/ move to lang/custom/, the item names and lore, weapon
lines, menu wording, visibility names and placeholder answers config.yml used to hold move into
lang/custom/messages.yml, and config.yml is pointed at it with language: custom. The chat lines
under the old messages block of config.yml are not carried across: re-apply any you had edited in
messages.yml. Set language to default or a code to switch to the shipped translations.
behaviour#
behaviour:
mode: both
consume-token: true
consume-remover: true
hide-without-permission: false
defaults: []| Key | Default | What it does |
|---|---|---|
mode | both | player, weapon or both. See Modes and tokens. |
consume-token | true | Whether the token is spent when it is bound. |
consume-remover | true | Whether the remover is spent when it unbinds. |
hide-without-permission | false | Whether 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: CRIT_SPARK. |
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.
effects#
Which hits play anything at all.
effects:
all-mobs: false
allowed-mobs:
- PLAYER
- MANNEQUIN
- ZOMBIE
disabled-worlds: []disabled-worlds lists the worlds where hit effects never play. It is empty by default; names are
matched ignoring case.
all-mobs: true means every zombie in a grinder plays an effect on every blow that lands on it. Hit
effects are usually meant for PvP: keep the list unless you want sparks on every mob you punch.
Either way one player starts at most five effects a second; a sweep through a crowd plays the first
five and drops the rest.
token-item, remover-item and key-item#
token-item:
material: FIREWORK_STAR
glow: true
remover-item:
material: SCRAPE_POTTERY_SHERD
glow: true
key-item:
material: TRIPWIRE_HOOK
glow: truematerial 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#
weapon-lore:
enabled: trueWhether the lines under a bound weapon are drawn. They are drawn on packets only — the item itself
never carries them — and the lines themselves are weapon-lore in messages.yml.
menu#
menu:
favourites-icon: "AMETHYST_SHARD"
style: CLASSIC| Key | Default | What it does |
|---|---|---|
favourites-icon | AMETHYST_SHARD | The material the favourites tab is drawn as. |
style | CLASSIC | What /hiteffect opens. CLASSIC: the inventory menu. SPATIAL: the 3D selector, laid out in spatial/effects.yml. /hiteffect 3d always opens the 3D one, /hiteffect classic the inventory one. |
What the menu calls things is in messages.yml, and the inventory screen itself is
menus/effects.yml — see The menu.
tiers#
The rarities effects are sorted into, and how often each one comes out of a crate.
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 }The key is the rarity id effects.yml writes as tier. Add, rename or delete any of them — nothing
is hard-coded, and chance is a weight rather than a percentage. Full detail on
The crate.
crate#
crate:
enabled: true
start-keys: 0
duplicate-refund: 1
reward: UNLOCK
blocks: []
max-at-once: 4
spin-frames: 34
stagger-seconds: 2.0
opening: INVENTORY
on-spin:
sound:
name: BLOCK_NOTE_BLOCK_HAT
pitch: 1.6
on-win:
sound:
name: ENTITY_EXPERIENCE_ORB_PICKUP
volume: 0.7
pitch: 1.2
on-duplicate:
sound:
name: BLOCK_NOTE_BLOCK_BASS
pitch: 0.8| Key | Default | What it does |
|---|---|---|
enabled | true | Whether the crate opens at all. Off, its button says so. |
start-keys | 0 | Keys a player is given the first time they are seen. |
duplicate-refund | 1 | Keys handed back when a crate lands on something already owned. |
reward | UNLOCK | What a win hands over: UNLOCK, ITEM or BOTH. |
blocks | empty | Blocks that open the crate, as server,world,x,y,z,yaw,pitch. |
max-at-once | 4 | How many crates may be opened in one go. Capped at seven by the screen. A player holding exyliahiteffect.crate.multi.<n> may open <n> instead, the highest one. |
spin-frames | 34 | Faces the first reel runs through. Capped at 200, about eleven seconds. |
stagger-seconds | 2.0 | How long after one reel stops the next one does. 0 stops them together. |
opening | INVENTORY | How an opening is shown. INVENTORY: the reels fall down menus/crate_open.yml. SPATIAL: a crate in the world in front of the player, from spatial/crate.yml. See The crate. |
on-spin | note block hat | Played while the reels fall. |
on-win | experience orb | Played the moment a reel stops on something new, once per crate. |
on-duplicate | note block bass | Played instead when that reel stopped on something already owned. |
/hiteffectsadmin crate block add writes the block you are looking at. A bound block cannot be
broken, blown up or pushed away while it is on the list — which hand-editing this key does not give
you.
preview#
Where preview effects are shown. In the 3D selector and the crate preview, a hit effect replays every second so it reads as a stream of hits, not one hit and a pause. New in v1.7.0
preview:
location: ""
distance: 5.0
settle-ticks: 4
linger-ticks: 20
max-ticks: 600
mode: TELEPORT
mannequin:
locations: []
trial-seconds: 30
radius: 12.0
vanish-on-hit: false
effect-scale: 1.0
skins: [others, viewer]mode picks one of two ways. TELEPORT moves the player to the stage, plays the effect in front of
them where only they can see it, then puts them back exactly where they were; until location is set,
previews are unavailable and say so. Set it in game with /hiteffectsadmin preview location rather
than by hand. MANNEQUIN moves nobody: the player is lent the effect for trial-seconds and hits the
mannequins as often as they like, the effect playing on the mannequins only. Switch with
/hiteffectsadmin preview mode and place them with /hiteffectsadmin preview mannequin add.
| Key | Default | What it does |
|---|---|---|
location | empty | Where the player stands while a preview plays. |
distance | 5.0 | How far in front of them the effect plays, in blocks. |
settle-ticks | 4 | How long to wait after the teleport, so the client has the new position first. |
linger-ticks | 20 | How long the stage is held after the effect finishes. |
max-ticks | 600 | The longest a preview may last, whatever goes wrong. |
mode | TELEPORT | TELEPORT or MANNEQUIN. |
mannequin.locations | [] | Where the mannequins stand. Set them in game. |
mannequin.trial-seconds | 30 | How long a player is lent the effect they preview. |
mannequin.radius | 12.0 | Once a player has reached a mannequin, walking further than this from all of them ends the loan early, in blocks. |
mannequin.vanish-on-hit | false | Whether a struck mannequin disappears for that player while the effect plays. |
mannequin.effect-scale | 1.0 | How large the effect plays on a mannequin, as a multiple of its written size. |
mannequin.skins | [others, viewer] | Whose skin the mannequin wears, the first source that has one: others, viewer or defaults. |
Everyone on the stage is hidden from everyone else, and each effect is sent to one player, so a single location serves a full server.
showcase#
Places that play hit effects on their own, over and over, for whoever walks past: a lobby centrepiece rather than a fight. Two bodies stand either side of the spot, across the way you faced when you placed it, and one strikes the other three times, the effect landing on every blow. They wear the skins of the players standing nearby, so the crowd watching is the cast.
showcase:
locations: []
pause-seconds: 3.0
radius: 24.0
only: []| Key | Default | What it does |
|---|---|---|
locations | [] | Where effects play on a loop. Set them with /hiteffectsadmin showcase add. |
pause-seconds | 3.0 | The rest between one effect ending and the next starting. |
radius | 24.0 | How close a player has to be for a showcase to play and to be seen, in blocks. |
only | [] | The effect ids a showcase picks from. Empty picks from every effect. |
effect-scale | 1.0 | How large a showcase plays each effect, as a multiple of its written size. |
With nobody inside radius nothing plays, so an empty lobby costs nothing. A player whose visibility
is NONE or SELF_ONLY does not see showcases: they are nobody's own hit.
feedback#
feedback:
on-bind:
sound:
name: ENTITY_EXPERIENCE_ORB_PICKUP
volume: 0.7
pitch: 1.4
on-unbind:
sound:
name: ITEM_BUNDLE_REMOVE_ONE
volume: 0.7
pitch: 0.8Full 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.
particles#
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.
shop:
enabled: true
tier-prices:
common: 500
rare: 1500
epic: 4000
legendary: 10000| Key | Default | What it does |
|---|---|---|
enabled | true | Whether a locked effect can be bought from the menu. |
tier-prices | 500 / 1500 / 4000 / 10000 | 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; 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.
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. New in v1.7.0
messages.yml#
Every line the plugin sends, and every word an item or the menu draws, in
lang/<code>/messages.yml. prefix is {primary}&lE-HITS {letters_black}•<reset> and every other message starts
with %prefix%.
Message keys
| Key | Sent when |
|---|---|
bound | An effect is bound to a weapon. |
unbound | An effect is unbound and returned. |
chosen | An effect is chosen in the menu. |
cleared | The effect is taken off. |
not-a-weapon | The item is not something an effect can be bound to. |
wrong-weapon | The effect does not fit that weapon. |
unknown-effect | The id names nothing the file declares. |
already-bound | The weapon already carries an effect. |
no-effect | The weapon carries none. |
inventory-full | A remover needs a free slot. |
no-permission | The player does not own the effect. |
empty-hand | A hand-held subcommand with nothing in hand. |
given / given-remover / given-key | Tokens, removers or crate keys were given. |
rewards-claimed | A player joins and the rewards that were waiting for them are handed over. |
list-header / list-entry / list-empty | /hiteffectsadmin list. |
visibility-set | Visibility changed. |
refreshed | refresh or validate finished. |
menu-disabled | The menu was opened on a weapon server. |
favourite-added / favourite-removed / favourites-cleared / favourites-empty | The shortlist. |
random-chosen | The random choice was turned on. |
crate-won / crate-duplicate | A crate landed on something new, or on something already owned. |
crate-no-keys / crate-busy / crate-empty / crate-disabled | The crate refusing to open. |
keys-received / keys-taken / keys-given | Crate keys changed hands. |
unlock-granted / unlock-already / unlock-revoked | unlocks subcommands. |
feature-locked | A feature the player's rank does not include: its permission node is denied. |
crate-block-* / crate-blocks-* | crate block subcommands. |
preview-location-set | The preview stage was moved. |
preview-unavailable / preview-unavailable-admin | A preview asked for on a server with no stage. |
preview-mode-set | preview mode changed how previews are shown. |
preview-trial / preview-trial-bar | A mannequin preview started, and the boss bar counting it down. |
preview-no-mannequin / preview-no-mannequin-admin | A mannequin preview asked for with no mannequin placed. |
preview-mannequin-added / preview-mannequin-removed / preview-mannequin-missing / preview-mannequins-cleared | preview mannequin subcommands. |
showcase-* / showcases-* | showcase subcommands. |
confirm-player-clear / confirm-crate-blocks-clear / confirm-showcases-clear | An admin clear that asks for the command to be run again. |
favourites-clear-prompt | The confirmation before the favourites are emptied. |
player-reset | A player's choice was reset by an admin. |
Placeholders in messages: %effect%, %amount%, %id%, %visibility%, %player%, %keys%,
%location%, %mode%, %seconds%, plus %prefix%.
Below the messages, the words drawn rather than sent:
| Key | What it is |
|---|---|
token-item, remover-item, key-item | Each item's name and lore. On the token, %effect% is the effect's name and %weapons% what it fits. |
weapon-lore | The lines under a bound weapon. %effect% is the effect's name. |
menu | What 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. |
particles | What each visibility mode is called: name-all, name-none, name-self-only, name-others-only. |
spatial | Every word on the 3D selector: its buttons, hints, card lines, tabs and guided tour (under spatial.stage), plus the spatial place / remove / tour answers. |
placeholders | none, what every %exyliahiteffect_...% 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