Content generated with AI — it may contain mistakes.

ExyliaArrows/GuidesUpdated in v1.7.1

Customise the menu

Change the classic /arrows menu: tabs, grid, buttons and favourites, in menus/effects.yml.

Page 6 of 228 min read

/arrows opens a window of 54 slots titled ARROW EFFECTS: category tabs down the left, the effects of the open tab in a grid, and buttons along the top and bottom. By the end of this page you know what each button does and how to change the layout, hide locked effects or sell them.

This is the classic menu, which /arrows opens while menu.style is CLASSIC (the default). With SPATIAL it opens the 3D selector instead, and a player whose client is older than 1.21.4 still gets this screen.

It refuses to open in bow mode

With behaviour.mode: bow nothing on this screen would ever be read, so the menu says it is disabled instead of opening a window that changes nothing. See Bind effects to bows.

What players see#

  • Tabs. The first tab is always the player's Favourites, then one tab per category.
  • Grid. The effects of the open tab. Effects the player may use come first, then the locked ones.
  • Top row. Your effect (click to take the effect off), Filter (switches between every effect and only the ones the player owns) and Crate (opens the crate).
  • Bottom row. Particle visibility (steps through who they see), Close and Random effect (every shot plays a different effect from the ones they own).
Click on an effectWhat it does
LeftWears the effect, or takes it off if it is already worn. On a locked effect that is for sale, buys it.
RightPreviews it: the player is moved to the preview stage, the effect plays for them alone and they are put back where they were. Locked effects can be previewed too.
ShiftStars it as a favourite, or removes the star.

Before you start#

Set the preview stage with /arrowsadmin preview location, or right-click will say previews are not set up. See Your first effect.

Steps#

Open the menu file

Open plugins/ExyliaArrows/lang/<code>/menus/effects.yml, where <code> is your language in config.yml. The file is yours to restyle.

Change what you want

Edit titles, icons, the names of the buttons or the slots in the lists below. Each button is an entry with a slot, a material, a name and actions.

Reload

Run /arrowsadmin reload, then /arrows.

Check that it works#

Open /arrows. Your change is on screen. If an entry is wrong, the console says which. A release only adds what is missing in your file; when it has to change the layout it raises menu-version at the top of the file, replaces it and keeps your previous one beside it.

Going further#

Hide locked effects#

Set behaviour.hide-without-permission: true in config.yml. Locked effects disappear from the grid, except on the favourites tab.

Sell locked effects#

With shop.enabled on and an economy plugin installed, a locked effect that has a price is drawn with its price. A left click asks the player to confirm, charges them and unlocks it for good, and the menu comes back with the row now theirs. A player without exyliarrows.buy sees the row locked, with no price. Set the prices in Configuration and see Set up the crate and the shop.

Favourites#

The favourites tab is the player's shortlist, drawn as menu.favourites-icon in config.yml and named menu.favourites-name in messages.yml.

  • Starring is free: owning an effect is not required to star it, so a star does not vanish the day a rank lapses.
  • Effects stay in the order they were starred.
  • A locked effect is drawn on this tab even on a server that hides locked effects elsewhere.
  • A player empties the list with Shift-click on the open tab (it asks to confirm first) or /arrows favourites clear.

Change the wording#

The few strings one template draws for every row live in messages.yml, under menu:

lang/<code>/messages.yml
yaml
menu:
  empty: "{muted}Nothing"
  tab-open: "{success}✔ You are here"
  tab-closed: "{info}{icon:click} Click to open"
  bows-any: "Any bow"
  favourites-name: "Favourites"
  favourite-on: "{highlight}★ In your favourites"
  favourite-off: "{muted}☆ Not in your favourites"
  random-name: "{highlight}Random"
  random-on: "{success}✔ Every shot is a surprise"
  random-off: "{accent}{icon:click} Click to surprise yourself"
  default-marker: "{muted}Default for your rank"
  filter-all: "{info}Every effect"
  filter-owned: "{success}Only the ones you own"

Colours and messages work as everywhere else in Exylia, see Colours and Messages.

The window follows the choice

Every way a player's choice can change (their own click, a command, an admin, or a rank that ran out) redraws the windows they have open. Nothing has to be closed and reopened.

Slots, templates, placeholders and actions
SectionSlotsWhat it holds
categories9,18,27,36The tabs down the left, 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: Your effect at slot 3, Filter at 4, Crate at 5, Particle visibility at 48, Close at 49, Random effect at 50. none_owned_template is what a tab shows when the filter leaves it empty, and empty_template is drawn on the favourites tab when nothing is starred. The Crate button opens menus/crate.yml.

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_bows%gridWhat it may be bound to, in words.
%effect_tier_id%gridIts rarity's id.
%effect_tier%gridThe rarity's name, in the rarity's colour.
%effect_tier_color%gridThat colour on its own.
%price%purchasable_templateWhat it sells for, with its currency.
%effect_favourite%gridmenu.favourite-on or menu.favourite-off, depending on whether it is starred.
%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 unlocked, from the crate or the shop.
%catalogue_count%AnywhereHow many effects the server declares.
%particle_visibility%AnywhereThe player's current visibility mode, named as particles.name-* in messages.yml 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
arrows:openOpens the screen.
arrows:category <id>Switches tab. favourites is a valid id.
arrows:choose <id>Wears an effect, or takes it off when it is already worn.
arrows:clearTakes the effect off.
arrows:randomTurns the random choice on, or off when it is already on.
arrows:favourite <id>Stars or unstars.
arrows:favourites_clearEmpties the shortlist.
arrows:preview <id>Previews an effect and reopens the menu afterwards.
arrows:visibilitySteps the viewer's visibility on by one.
arrows:buy <id>Asks the player to confirm, then buys a locked effect the shop sells.

An effect a player plays only because their rank gives it (behaviour.defaults) is drawn as the one worn, marked with menu.default-marker, and never as locked or for sale. Clicking it takes it off.

Where the server's menu style is SCREEN (ExyliaLib's screens.yml), /arrows opens the same selector as a native screen (screens/effects.html, one with the crate and its reels) with a live window flying the trail under the cursor. A screen that fails to load falls back to this chest menu.

Something missing on this page? Tell us on Discord