Customise the menu
Rename the buttons, hide what players do not own, and understand the favourites tab of the emote menu.
You end up with the /emote window looking and reading the way you want: your own button names, locked emotes hidden or shown, and the favourites tab explained to your players. This is the classic chest menu (what /emote opens with menu.style: CLASSIC, the default, and what /emote classic always opens). The same catalogue can also stand in the world: see The 3D selector.
Before you start#
You need the plugin installed and one emote granted, see Your first emote. For colours and gradients in names, see Colours; for how language folders work, see Messages and languages; for how ExyliaLib menu files are built in general, see Menus.
Steps#
Open the menu file
In plugins/ExyliaEmotes/lang/<code>/menus/, open emotes.yml, where <code> is your server language (en, es). It holds the whole 54-slot window.
Change a button
Find the button, for example crate (named Crate in English, Caja in Spanish), and edit its name: and lore:. Colour tags such as {highlight} work.
Reload
Run /emotesadmin reload. It re-reads config.yml, messages.yml, emotes.yml and the menus.
Check that it works#
Run /emote. The window opens with your new wording. The tabs are down the left, the emotes in the middle, and the buttons Your emotes (top, slot 3), Filter (slot 4), Crate (slot 5) and Close (bottom). If it does not change, check the console for a menu error and see Common problems.
Going further#
What a click does#
A click on an emote row does something different depending on the click and on what the player owns.
| Click | Emote the player owns | Duet | Locked emote |
|---|---|---|---|
| Left | Closes the window and performs it. | Nothing: the row says to use /emote play <id> <player>. | Buys it, after a confirmation, if it has a price. Otherwise nothing. |
| Right | Previews it. | Previews it. | Previews it. |
| Shift | Stars or unstars it. | Stars or unstars it. | Stars or unstars it. |
A preview plays the emote on the server's preview stage and reopens the menu afterwards. Until you run /emotesadmin preview location where you want the stage, it answers that the preview is unavailable.
Hide emotes players do not own#
Owned emotes are always drawn first, then the locked ones. In config.yml, behaviour.hide-without-permission: true removes the locked ones from the grid, except on the favourites tab. behaviour.require-permission: false locks nothing, so everybody owns everything. The Filter button also lets each player switch a tab between every emote and only their own.
The favourites tab#
The first tab is each player's own shortlist. Starring is free and needs no ownership, so it works as a wish list too. Emotes stay in the order they were starred, and locked ones still show here even if you hide them elsewhere. To empty it, shift-click the tab while it is open (it asks first) or run /emote favourites clear. Its name is menu.favourites-name in messages.yml and its icon is menu.favourites-icon in config.yml.
The native screen#
Where ExyliaLib's screen menu style applies, /emote, the crate and the reels open as one native screen (screens/emotes.html, screens/theme.css) instead of the chest. Put your own rules in custom.css and change words in lang/<code>/screens/emotes.yml. A screen file that cannot be read keeps the chest menu. /exylialib screens check lists what is wrong.
A star, a key handed over or an unlock from an admin redraws the emote screen if the player has it open.
Technical details: sections, templates, placeholders, actions, wording
The two lists#
| Section | Slots | What it holds |
|---|---|---|
categories | 9,18,27,36 | The tabs down the left, paged with the buttons at slots 0 and 45. |
grid | 11-16,20-25,29-34,38-43 | The open tab's emotes, paged at slots 47 and 52. |
The fixed buttons: Your emotes at slot 3 (how many they own and have starred, and how to stop
one), Crate at 5, Filter at 4, Close at 49.
The menu opens on the tab the player last left it on, or the first tab when that one is gone. A tab is only drawn for a category that has at least one emote.
Templates#
Each list picks a template per row. item_template is the plain state and must stay first.
| Section | Template | Used when |
|---|---|---|
categories | item_template | Another tab is open. |
open_template | This is the tab being looked at. | |
favourites_template | The shortlist tab, while another tab is open. | |
favourites_open_template | The shortlist tab while it is open — the only one carrying the "empty the list" action. | |
grid | item_template | A solo emote the player owns. |
duet_template | A duet the player owns. It has no left-click action: a row has nobody to name. | |
locked_template | An emote they do not own. | |
purchasable_template | An emote they do not own that the shop sells. Draws %price% and buys on left click. | |
empty_template | Drawn 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.
| Placeholder | Where | What it draws |
|---|---|---|
%category_id% | categories | The tab's id — favourites on the shortlist tab. |
%category_name% | categories | The tab's display name. |
%category_material% | categories | The material its icon is drawn with. |
%category_total% | categories | How many emotes the tab holds; on the shortlist, how many are starred. |
%category_owned% | categories | How many of those the player owns. |
%category_status% | categories | menu.tab-open or menu.tab-closed. |
%emote_id% | grid | The emote's id. |
%emote_name% | grid | Its display name, with its colours. |
%emote_material% | grid | The material it is drawn with. |
%emote_description% | grid | Its description from emotes.yml. |
%emote_kind% | grid | menu.kind-solo or menu.kind-duet. |
%emote_favourite% | grid | menu.favourite-on or menu.favourite-off. |
%emote_tier% | grid | The rarity's name, in the rarity's colour. |
%emote_tier_id% | grid | The rarity's id. |
%emote_tier_color% | grid | That colour on its own. |
%price% | purchasable_template | What the emote costs. |
%favourites_count% | Anywhere | How many emotes they have starred. |
%owned_count% | Anywhere | How many emotes they may perform, by permission or unlock. |
%keys% | Anywhere | Crate keys they hold. |
%unlocked_count% | Anywhere | How many emotes they have won from the crate. |
%catalogue_count% | Anywhere | How many emotes the server declares. |
Actions#
| Action | What it does |
|---|---|
emote:open | Opens the screen. |
emote:category <id> | Switches tab. favourites is a valid id. |
emote:play <id> | Closes the window and performs the emote. A duet answers needs-partner. |
emote:favourite <id> | Stars or unstars. |
emote:favourites_clear | Asks for confirmation, then empties the shortlist. |
emote:buy <id> | Asks the player to confirm, charges the price and unlocks the emote. |
emote:preview <id> | Previews an emote and reopens the menu afterwards. |
emote:crate | Opens the crate. |
emote:crate_open <amount> | Spends that many keys and drops that many reels. Used by lang/<code>/menus/crate.yml. |
Wording#
The few strings one template draws for every row live in messages.yml, so each language has its own:
menu:
tab-open: "{success}✔ You are here"
tab-closed: "{info}{icon:click} Click to open"
favourites-name: "Favourites"
favourite-on: "{highlight}★ In your favourites"
favourite-off: "{muted}☆ Not in your favourites"
kind-solo: "Solo"
kind-duet: "With a friend"Starring, a key handed over, an unlock granted by an admin — every change to a player's favourites, keys or unlocks redraws the emote screen if they have it open.
Something missing on this page? Tell us on Discord