Configuration
Where ExyliaArrows keeps its files, what owners change most (language, worlds, trails, crate, shop) and every key of config.yml with its default.
Most of ExyliaArrows is set in plugins/ExyliaArrows/config.yml. What the effects look like is in effects.yml (Sequences), and every word a player reads is in lang/<code>/. After a change, run /arrowsadmin 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.
plugins/ExyliaArrows/
config.yml behaviour and limits (this page)
effects.yml the effects themselves
lang/<code>/messages.yml every message, item name and menu word
lang/<code>/effects.yml translated effect names and descriptions
lang/<code>/menus/ effects.yml, crate.yml, crate_open.yml
spatial/ the 3D selector and the 3D crate openinglanguage#
Which folder under lang/ the menus and messages are read from. The default, default, follows the language in ExyliaLib's own config.yml, so one line there switches every Exylia plugin. Set en, es, pt, fr, ru or tr to change this plugin alone. 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 /arrowsadmin reload. See Messages and languages for editing a language.
On the first start of 1.4.0 or newer the old menus/ move to lang/custom/, every message, item name and lore, menu word and placeholder answer that config.yml used to hold moves into lang/custom/messages.yml, and config.yml is pointed at it with language: custom, so nothing a server edited is lost. Set language to default or a code to switch to the shipped translations.
disabled-worlds#
Worlds where arrow effects never play: no launch, no trail and no impact. Names are matched ignoring case. The default is an empty list.
disabled-worlds:
- lobbyTo switch effects off in one area instead of a whole world, deny the WorldGuard flag arrows-effects in a region.
behaviour#
Where the effect of a shot comes from, and what tokens do.
behaviour:
mode: both
consume-token: true
consume-remover: true
hide-without-permission: false
defaults: []mode is player (what the player picked in /arrows), bow (what is bound to the bow) or both (the bow's own effect, and the player's choice for a bow with none). See Bind effects to bows.
Default effects by rank#
defaults is the effect a player plays while they have not picked one, by rank:
behaviour:
defaults:
- permission: group.vip
cosmetic: random
- permission: ''
cosmetic: ember_trailRead top to bottom: the first line the player qualifies for wins, and an empty permission means everyone, so keep that line last. cosmetic is an effect id, random (a random effect they own) or none (that group gets nothing). Nothing is unlocked or saved: the menu draws it as the effect playing, marked as their rank's default, and it is checked on every shot. A player who picks something plays that instead; one who takes the effect off in the menu or with /arrows clear plays nothing. Ignored when mode is bow.
Choosing an effect in the menu always needs its node or an unlock; a token, a bound bow, a command and the API never do. See Permissions.
All behaviour keys
| Key | Default | What it does |
|---|---|---|
mode | both | player, bow or both. |
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. |
projectiles#
Which launched projectiles carry an effect at all. By default only arrows, spectral arrows and tridents do, unless the effect names its own projectiles.
projectiles:
all-types: false
default-allowed-types:
- ARROW
- SPECTRAL_ARROW
- TRIDENTall-types: true makes every launched projectile carry the effect, including the snowballs, eggs, potions and fishing hooks a player can throw every tick. default-allowed-types is read only while all-types is false and the effect names no projectiles of its own. These are the defaults a fresh install writes; a server that already had the file keeps what it had.
Whatever is allowed, one player's launch flash plays at most once every 150 ms: a multishot crossbow fires three shots in the same tick, and one flash for the volley is all anyone can see.
trail#
How many trails may draw at once, and for how long.
trail:
default-interval: 1
max-duration: 10
max-active: 200
max-active-per-player: 10Shots over max-active still play their launch and impact; they simply leave no trail. Set a limit to 0 to remove it.
A trail is a repeating task and a burst of packets per tick. A full lobby firing crossbows is the case the ceiling exists for, and losing a trail is a great deal less visible than losing the tick rate.
All trail keys
| Key | Default | What it does |
|---|---|---|
default-interval | 1 | Ticks between trail steps for an effect that sets no trail-interval. |
max-duration | 10 | Seconds a trail may live before it is cancelled, so an arrow lost in an unloaded chunk does not draw forever. |
max-active | 200 | How many trails may be drawing at once on the whole server. 0 removes the limit. |
max-active-per-player | 10 | How many of those one player may have drawing at once. 0 removes it. |
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 Set up the crate and the shop.
bow-lore#
bow-lore:
enabled: trueWhether the lines under a bound bow are drawn. They are drawn on packets only, so the item itself never carries them. The lines are bow-lore in messages.yml.
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, and each rarity is also a permission node, exyliarrows.tier.<id>. An effect naming a rarity that no longer exists falls back to the first one.
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: 4chance is a weight, not a percentage: the shares are worked out from the weights, so deleting a rarity re-spreads its odds. See Set up the crate and the shop.
All tier keys
| Key | Default | What it does |
|---|---|---|
name | per rarity | What menus and placeholders call it. |
material | per rarity | Still read from the file, but the crate lives in ExyliaLib since 1.4.0 and is not given it. |
color | per rarity | The colour its name and its effects are written in. See Colours. |
chance | 60, 25, 12, 3 | A weight. |
priority | 1 to 4 | Where it sits in menus; lower comes first. |
crate#
The crate: one virtual key, one random effect. Keys are held on the player's own account, so they cannot be dropped or lost to a full inventory.
crate:
enabled: true
start-keys: 0
duplicate-refund: 1
reward: UNLOCK
blocks: []
max-at-once: 4
opening: INVENTORYreward is what a crate hands over: UNLOCK keeps the effect on the account, ITEM hands over only its token, BOTH does both. ITEM and BOTH want behaviour.mode set to bow or both. Bind crate blocks with /arrowsadmin crate block add rather than by hand. opening is INVENTORY (the reels fall down a menu) or SPATIAL (a crate in the world in front of the player), see The opening in 3D.
All crate keys
| Key | Default | What it does |
|---|---|---|
enabled | true | Whether the crate can be opened at all. Off, its button says so instead of opening. |
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 an effect they already own. |
reward | UNLOCK | UNLOCK, ITEM or BOTH. |
blocks | empty | The blocks that open the crate when clicked, as server,world,x,y,z,yaw,pitch. A bound block cannot be broken, blown up or pushed away while it is listed. |
max-at-once | 4 | How many crates may be opened in one go. The opening screen fits seven. A player holding exyliarrows.crate.multi.<n> may open <n> instead, the highest one they hold. |
spin-frames | 34 | How many faces the first reel runs through before it stops. Capped at 200, about eleven seconds. |
stagger-seconds | 2.0 | How long after one reel stops the next one does. 0 stops them together. |
on-spin, on-win, on-duplicate | one sound each | Full ExyliaLib effect blocks (title, action bar, boss bar, sound, particle, firework). on-spin plays every tick a reel is falling; on-win and on-duplicate play once per reel, as it lands. |
opening | INVENTORY | INVENTORY or SPATIAL. Sneaking skips to the end and hands the prize over at once. |
Default sounds: on-spin is BLOCK_NOTE_BLOCK_HAT (volume 0.6, pitch 1.6), on-win is ENTITY_PLAYER_LEVELUP (0.7, 1.2), on-duplicate is BLOCK_NOTE_BLOCK_BASS (0.7, 0.8).
preview#
Where /arrows preview and the menu's right click play an effect. The player is moved to the stage, the effect plays in front of them where only they can see it, and they are put back exactly where they were.
preview:
location: ""There is no sensible default, because a guess puts the player inside terrain. Stand where previews should play and run /arrowsadmin preview location. Until then, /arrows preview and the menu's right click say so instead of playing anything.
All preview keys
| Key | Default | What it does |
|---|---|---|
location | empty | Where the player stands, as server,world,x,y,z,yaw,pitch. |
distance | 5.0 | How far in front of them the effect plays, in blocks. |
settle-ticks | 4 | How long to wait after the move, so the client has the new position before the first particle. |
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. |
The tick keys also read a written duration such as 1s or 500ms. The section also holds mode (default TELEPORT) and a mannequin block, which ExyliaLib shares between cosmetic plugins; ExyliaArrows has no command to place mannequins, so leave them as they are.
menu#
menu:
favourites-icon: "AMETHYST_SHARD"
style: CLASSICstyle is what /arrows opens: CLASSIC is the inventory menu, SPATIAL is the 3D selector, laid out in spatial/effects.yml. /arrows 3d always opens the 3D one. favourites-icon is the material the favourites tab is drawn as. What the menu calls things is in messages.yml, and the screens themselves are menus/effects.yml, menus/crate.yml and menus/crate_open.yml under lang/<code>/. See The menu and Edit menus.
feedback#
feedback:
on-bind:
sound:
name: ENTITY_EXPERIENCE_ORB_PICKUP
volume: 0.7
pitch: 1.2
on-unbind:
sound:
name: ITEM_BUNDLE_REMOVE_ONE
volume: 0.7
pitch: 1.0Full 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 bow or chosen in the menu, on-unbind when one is taken off.
Since 1.7.0 the routine sounds are shorter and quieter. A server still on the old defaults is moved to the new ones on update; a sound you chose yourself is left as it is.
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.
showcase#
Places that play arrow effects on their own, over and over, for whoever walks past: a lobby centrepiece rather than a shot. Two bodies wearing the skins of players standing nearby face each other nine blocks apart, one draws a bow and the other takes the arrow, twice a turn. The launch plays at the bow, the trail along the arc and the impact where it lands.
showcase:
locations: []Set locations in game with /arrowsadmin showcase add, facing where the crowd will be: the pair stands to your left and right so the arc is seen side on. Only effects that fly on an arrow and draw a trail or an impact are picked. There is no real arrow and nobody is hit: the flight is simulated and drawn on packets, and the lines that act on a real player ([COMMAND], [POTION], [TITLE], [ACTION_BAR], [MESSAGE], [CAMERA]) are cut from what a showcase plays. With nobody inside radius nothing plays, so an empty lobby costs nothing.
All showcase keys
| Key | Default | What it does |
|---|---|---|
locations | [] | Where showcases stand, as server,world,x,y,z,yaw,pitch. |
pause-seconds | 3.0 | The rest between one turn 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 each effect plays: every offset, movement, body and particle spread that many times its written size. |
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. A player without exyliarrows.buy sees no price, in the classic menu or the 3D selector.
shop:
enabled: true
tier-prices:
common: 500
rare: 1500
epic: 4000
legendary: 10000tier-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; with neither installed, or with the shop off, locked effects look exactly as they always have. See Economy.
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.8.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-ARROWS {letters_black}•<reset> and every other message starts with %prefix%. Colour codes and {tags} are explained in Colours.
Message keys
| Key | Sent when |
|---|---|
bound | An effect is bound to a bow. |
unbound | An effect is unbound and returned. |
chosen | An effect is chosen in the menu. |
cleared | The effect is taken off. |
not-a-bow | The item is not something an effect can be bound to. |
wrong-bow | The effect does not fit that bow. |
unknown-effect | The id names nothing the file declares. |
already-bound | The bow already carries an effect. |
no-effect | The bow carries none. |
inventory-full | A remover needs a free slot. |
no-permission | The player does not own the effect. |
feature-locked | Their rank does not include a feature: its node is denied. |
empty-hand | A hand-held subcommand with nothing in hand. |
given, given-remover, given-key | Tokens, removers or crate keys were given. |
rewards-claimed | Items that did not fit were waiting and have been handed over on join. |
list-header, list-entry, list-empty | /arrowsadmin list. |
visibility-set | Visibility changed. |
refreshed | refresh or validate finished. |
menu-disabled | The menu was opened on a bow server. |
favourite-added, favourite-removed, favourites-cleared, favourites-empty | The shortlist. |
random-chosen | Every shot was set to draw a different effect. |
crate-won, crate-duplicate, crate-no-keys | A crate landed on something new, on something owned, or could not be paid for. |
crate-busy, crate-empty, crate-disabled | A crate is already falling, has nothing to hand over, or is turned off. |
keys-received, keys-taken, keys-given | Keys changed hands. |
unlock-granted, unlock-already, unlock-revoked | /arrowsadmin unlocks. |
crate-block-*, crate-blocks-* | /arrowsadmin crate block. |
preview-location-set, preview-unavailable, preview-unavailable-admin | The preview stage. |
showcase-*, showcases-* | /arrowsadmin showcase. |
favourites-clear-prompt, confirm-* | The confirmation before clearing favourites, a player's effect, crate blocks or showcases. |
player-reset | Told to a player when staff reset their choice: back to the default their rank gives, if any. |
Placeholders in messages: %effect%, %amount%, %id%, %visibility%, %keys%, %player%, %location%, 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 %bows% what it fits. |
bow-lore | The lines under a bound bow. %effect% is the effect's name. |
menu | What the menu calls things: empty, tab-open, tab-closed, bows-any, bow-names, favourites-name, favourite-on, favourite-off, random-name, random-on, random-off, default-marker, filter-all, filter-owned. |
particles | What each visibility mode is called: name-all, name-none, name-self-only, name-others-only. |
spatial | Every word the 3D selector draws: its buttons, the effect card, the hint line, the tabs, the guided tour and the spot-* lines of /arrowsadmin spatial. The layout file only places them. |
placeholders | none, what every %exyliarrows_...% placeholder answers when there is no value, and unknown, what one answers when it names something that no longer exists. |
menu.bow-names is how a bow is written wherever %bows% is drawn, keyed by family (bow, crossbow, trident, ranged) or by item id. Anything missing is spelled from its id.
Something missing on this page? Tell us on Discord