Content generated with AI — it may contain mistakes.

ExyliaArrows/ReferenceUpdated in v1.8.0

Configuration

Where ExyliaArrows keeps its files, what owners change most (language, worlds, trails, crate, shop) and every key of config.yml with its default.

Page 14 of 2216 min read
  - lobby       - ARROW    - SPECTRAL_ARROW    - TRIDENT              

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 opening

language#

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.

Servers that ran 1.3.0 keep their edits

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.

yaml
disabled-worlds:
  - lobby

To 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.

yaml
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:

yaml
behaviour:
  defaults:
    - permission: group.vip
      cosmetic: random
    - permission: ''
      cosmetic: ember_trail

Read 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
KeyDefaultWhat it does
modebothplayer, bow 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.

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.

yaml
projectiles:
  all-types: false
  default-allowed-types:
    - ARROW
    - SPECTRAL_ARROW
    - TRIDENT

all-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.

yaml
trail:
  default-interval: 1
  max-duration: 10
  max-active: 200
  max-active-per-player: 10

Shots over max-active still play their launch and impact; they simply leave no trail. Set a limit to 0 to remove it.

max-active is what a crossbow volley is for

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
KeyDefaultWhat it does
default-interval1Ticks between trail steps for an effect that sets no trail-interval.
max-duration10Seconds a trail may live before it is cancelled, so an arrow lost in an unloaded chunk does not draw forever.
max-active200How many trails may be drawing at once on the whole server. 0 removes the limit.
max-active-per-player10How many of those one player may have drawing at once. 0 removes it.

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 Set up the crate and the shop.

bow-lore#

yaml
bow-lore:
  enabled: true

Whether 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.

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 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
KeyDefaultWhat it does
nameper rarityWhat menus and placeholders call it.
materialper rarityStill read from the file, but the crate lives in ExyliaLib since 1.4.0 and is not given it.
colorper rarityThe colour its name and its effects are written in. See Colours.
chance60, 25, 12, 3A weight.
priority1 to 4Where 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.

yaml
crate:
  enabled: true
  start-keys: 0
  duplicate-refund: 1
  reward: UNLOCK
  blocks: []
  max-at-once: 4
  opening: INVENTORY

reward 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
KeyDefaultWhat it does
enabledtrueWhether the crate can be opened at all. Off, its button says so instead of opening.
start-keys0Keys a player is given the first time they are seen.
duplicate-refund1Keys handed back when a crate lands on an effect they already own.
rewardUNLOCKUNLOCK, ITEM or BOTH.
blocksemptyThe 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-once4How 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-frames34How many faces the first reel runs through before it stops. Capped at 200, about eleven seconds.
stagger-seconds2.0How long after one reel stops the next one does. 0 stops them together.
on-spin, on-win, on-duplicateone sound eachFull 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.
openingINVENTORYINVENTORY 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.

yaml
preview:
  location: ""
Previews are unavailable until a stage is set

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
KeyDefaultWhat it does
locationemptyWhere the player stands, as server,world,x,y,z,yaw,pitch.
distance5.0How far in front of them the effect plays, in blocks.
settle-ticks4How long to wait after the move, so the client has the new position before the first particle.
linger-ticks20How long the stage is held after the effect finishes.
max-ticks600The 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.

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

style 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#

yaml
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.0

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 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#

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.

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.

yaml
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
KeyDefaultWhat it does
locations[]Where showcases stand, as server,world,x,y,z,yaw,pitch.
pause-seconds3.0The rest between one turn ending and the next starting.
radius24.0How 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-scale1.0How 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.

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; 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.

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. 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
KeySent when
boundAn effect is bound to a bow.
unboundAn effect is unbound and returned.
chosenAn effect is chosen in the menu.
clearedThe effect is taken off.
not-a-bowThe item is not something an effect can be bound to.
wrong-bowThe effect does not fit that bow.
unknown-effectThe id names nothing the file declares.
already-boundThe bow already carries an effect.
no-effectThe bow carries none.
inventory-fullA remover needs a free slot.
no-permissionThe player does not own the effect.
feature-lockedTheir rank does not include a feature: its node is denied.
empty-handA hand-held subcommand with nothing in hand.
given, given-remover, given-keyTokens, removers or crate keys were given.
rewards-claimedItems that did not fit were waiting and have been handed over on join.
list-header, list-entry, list-empty/arrowsadmin list.
visibility-setVisibility changed.
refreshedrefresh or validate finished.
menu-disabledThe menu was opened on a bow server.
favourite-added, favourite-removed, favourites-cleared, favourites-emptyThe shortlist.
random-chosenEvery shot was set to draw a different effect.
crate-won, crate-duplicate, crate-no-keysA crate landed on something new, on something owned, or could not be paid for.
crate-busy, crate-empty, crate-disabledA crate is already falling, has nothing to hand over, or is turned off.
keys-received, keys-taken, keys-givenKeys changed hands.
unlock-granted, unlock-already, unlock-revoked/arrowsadmin unlocks.
crate-block-*, crate-blocks-*/arrowsadmin crate block.
preview-location-set, preview-unavailable, preview-unavailable-adminThe preview stage.
showcase-*, showcases-*/arrowsadmin showcase.
favourites-clear-prompt, confirm-*The confirmation before clearing favourites, a player's effect, crate blocks or showcases.
player-resetTold 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:

KeyWhat it is
token-item, remover-item, key-itemEach item's name and lore. On the token, %effect% is the effect's name and %bows% what it fits.
bow-loreThe lines under a bound bow. %effect% is the effect's name.
menuWhat 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.
particlesWhat each visibility mode is called: name-all, name-none, name-self-only, name-others-only.
spatialEvery 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.
placeholdersnone, 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