Configuration
Every block of config.yml and every line of messages.yml, with their defaults.
Most of what you change in ExyliaEmotes is a handful of lines in config.yml. This page says where each file is, how to apply a change, and then lists every key with its default.
Where the files are#
Everything is in plugins/ExyliaEmotes/:
config.yml: the settings on this page.lang/<code>/messages.yml: every line the plugin sends. Colours and placeholders: Colours, Messages and languages.lang/<code>/emotes.yml: the emote catalogue, one per language. See Emotes.lang/<code>/menus/andlang/<code>/screens/: the menus, see The menu and Edit menus.spatial/emotes.yml: the layout of the 3D selector.
config.yml and messages.yml are written from a schema: comments are regenerated on every start,
unknown keys are dropped, and a key you delete comes back with its default.
Apply a change#
Edit the file and run /emotesadmin reload. You can also change config.yml in game, from the Settings button in the /emotesadmin hub, or from the browser with ExyliaLib's web editor. ownership needs a restart.
What owners change most#
- Cooldown between emotes:
behaviour.cooldown(default3s). - Stop walking from ending an emote:
behaviour.cancel-on-move. - Limit emotes to some worlds:
behaviour.worlds. - Open the 3D selector instead of the inventory menu:
menu.style: SPATIAL. - Crate keys, odds and prices:
crate.start-keys,tiers.*.chance,shop.tier-prices. See The crate. - Language:
language, covered right below.
The full list of keys follows, folded.
Every key, default and message
language#
language: defaultdefault 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 under lang/ you can edit. English is the base the others are laid over, so a line not
translated yet still arrives in English.
On the first start after updating, the old messages.yml and menus/ move to lang/custom/ and
config.yml is pointed at it with language: custom, so nothing a server edited is lost. The menu
wording, the key item's name and lore, and the placeholder fallbacks config.yml used to hold move into
messages.yml. Set language to default or a code to switch to the shipped translations.
behaviour#
When an emote may play, and what calls one off.
behaviour:
require-permission: true
hide-without-permission: false
cooldown: 3s
cancel-on-move: true
move-tolerance: 0.6
cancel-on-damage: true
block-in-combat: true
endless-limit: 5m
worlds: []| Key | Default | What it does |
|---|---|---|
require-permission | true | Whether performing an emote needs owning it. Only /emotesadmin play reaches past it. |
hide-without-permission | false | Whether an emote the player does not own is hidden in the menu instead of shown locked. |
cooldown | 3s | How long before the same player may play any other emote. Written out: 3s, 1m30s. 0s turns it off. A rank can wait less with exyliaemotes.cooldown.<seconds>. |
cancel-on-move | true | Whether walking ends an emote. |
move-tolerance | 0.6 | How far a player may drift before cancel-on-move fires, in blocks. Never less than 0.05: a client sends tiny corrections while standing still. |
cancel-on-damage | true | Whether being hit ends an emote, including another player punching the body. |
block-in-combat | true | Whether an emote is refused while the player is combat tagged, by whichever combat plugin ExyliaLib is bridged to. |
endless-limit | 5m | The longest an endless emote runs before it ends by itself. Never less than a second. A rank can dance longer with exyliaemotes.endless.<seconds>. |
worlds | [] | The worlds emotes may be played in, ignoring case. Empty means every world. |
A player performing an emote is frozen and cannot see who is next to them. The emote does not protect them, so the least it can do is get out of the way when it starts hurting.
cancel-on-move governs the movement the server sees and the walking keys it hears as its own input
event. A walking key read straight off the connection ends an emote whatever it says — see
Playing an emote.
camera#
camera:
enabled: true
hide-body: true| Key | Default | What it does |
|---|---|---|
enabled | true | Whether the player is shown their own emote from outside. Off, every [CAMERA] line is removed as the catalogue is compiled: the emote still plays for everybody around them, they simply do not see it. |
hide-body | true | Whether the real player is hidden while their body plays. Off, the player and their body stand in the same place at once. |
With the camera off a player can really walk, which is what move-tolerance is for. The startup log
says so when the camera is off.
duet#
duet:
invite: 20s
max-distance: 3.0| Key | Default | What it does |
|---|---|---|
invite | 20s | How long an invitation stands before it expires. Never less than a second. |
max-distance | 3.0 | How far apart the two players may be, in blocks, both when inviting and when it starts. |
The distance does not decide where the bodies stand: they are always placed on the line between the two
players, the emote's own gap apart. See Duets.
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 /emote opens. CLASSIC: the inventory menu. SPATIAL: the 3D selector, laid out in spatial/emotes.yml. /emote 3d and /emote classic open one or the other whatever this says. |
What the menu calls things is in messages.yml, under menu — see below. The screen
itself is lang/<code>/menus/emotes.yml — see The menu.
tiers#
The rarities emotes 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 emotes.yml writes as tier. Full reference on
The 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 }chance is a weight, not a percentage.
crate#
crate:
enabled: true
start-keys: 1
duplicate-refund: 1
reward: UNLOCK
blocks: []
max-at-once: 4
spin-frames: 34
stagger-seconds: 2.0
on-spin:
sound:
name: BLOCK_NOTE_BLOCK_HAT
volume: 0.7
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
volume: 0.7
pitch: 0.8
opening: INVENTORY| Key | Default | What it does |
|---|---|---|
enabled | true | Off, the crate says so instead of opening. |
start-keys | 1 | Keys a player is given the first time they are seen. |
duplicate-refund | 1 | Keys handed back for an emote already unlocked. |
reward | UNLOCK | UNLOCK, ITEM or BOTH. An emote has no item, so all three unlock it. |
blocks | [] | The blocks that open the crate, as server,world,x,y,z,yaw,pitch. Bind them with /emotesadmin crate block add. |
max-at-once | 4 | How many crates one player may open in one go, up to seven. |
spin-frames | 34 | How many 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. |
on-spin | A hat note | Played on every tick a reel is still falling. |
on-win | An experience orb | Played the moment a reel stops on something new, once per crate. |
on-duplicate | A bass note | Played instead when that reel stopped on something already unlocked. |
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 — see The crate. |
key-item#
How a crate key that can be held looks. Its name and lore are key-item in messages.yml.
key-item:
material: TRIPWIRE_HOOK
glow: trueA key is recognised by what it carries in its data, so renaming or recolouring it changes nothing for the keys already out there.
preview#
Where an emote can be watched without performing it: /emote preview, and right click in the menu.
preview:
location: ""
distance: 5.0
settle-ticks: 4
linger-ticks: 20
max-ticks: 600| Key | Default | What it does |
|---|---|---|
location | Empty | Where the player stands while a preview plays. Set it with /emotesadmin preview location, which opens a placement wizard. Only the position is used: a preview always faces north. |
distance | 5.0 | How far in front of the player the emote plays, in blocks. Never less than 1. |
settle-ticks | 4 | How long to wait after the teleport before playing. Reads a written duration too: 1s, 500ms. |
linger-ticks | 20 | How long the stage is held after the emote ends. |
max-ticks | 600 | The longest a preview may last, whatever happens. |
Empty means no stage, and previews answer preview-unavailable. Two players previewing at once may
share it: everyone is hidden from everyone, and each emote is sent to one player.
showcase#
showcase:
locations: []
pause-seconds: 3.0
radius: 24.0
emotes: []| Key | Default | What it does |
|---|---|---|
locations | [] | Where emotes play on a loop. Set them with /emotesadmin showcase add. |
pause-seconds | 3.0 | The rest between one emote ending and the next starting. |
radius | 24.0 | How close a player has to be for a showcase to play and to see it, in blocks. |
emotes | [] | The ids a showcase picks from. Empty picks from every one. Duets are never picked. |
See Showcases.
feedback#
feedback:
on-play:
sound:
name: BLOCK_AMETHYST_BLOCK_CHIME
volume: 0.7
pitch: 1.4
on-cancel:
sound:
name: ITEM_BUNDLE_REMOVE_ONE
volume: 0.7
pitch: 0.8
on-invite:
sound:
name: BLOCK_NOTE_BLOCK_BELL
volume: 0.7
pitch: 1.6| Key | Played |
|---|---|
on-play | To the player the moment their emote starts — to both, in a duet. |
on-cancel | To the performers when an emote is ended before its time. Not when it runs to the end. |
on-invite | To whoever is invited into a duet. |
These and the three crate blocks are full ExyliaLib effect blocks: title, action bar, boss bar, sound,
particle and firework are all available on each. Every shipped one is a single short sound at volume
0.7, in the PLAYERS category, heard by the player it is for.
Updating from 1.3 rewrites a sound still exactly as shipped (same name, volume 1.0) to the new default:
volume 0.7, the level-up on on-win becomes an experience orb and the grindstone on on-cancel a
bundle. A sound the server picked or retuned is left alone.
shop#
A locked emote can be bought from the menu. See The crate.
shop:
enabled: true
tier-prices:
common: 500
rare: 1500
epic: 4000
legendary: 10000| Key | Default | What it does |
|---|---|---|
enabled | true | Whether a locked emote with a price can be bought from the menu. |
tier-prices | 500 / 1500 / 4000 / 10000 | What an emote costs by its rarity, in the default currency, when it sets no price of its own. A rarity left out is not for sale. A price is a number (500, 2.5k) or {amount: 500, currency: gems} for another currency. |
ownership#
Where what a player unlocks here counts, for networks of several servers. Restart the server to apply a change. New in v1.5.0
ownership:
scope: global
global-currencies: []| Key | Default | What it does |
|---|---|---|
scope | global | global: an unlock counts on every server. server: only on this one. default: servers in this server's network group. Or write a group name. What was unlocked globally always counts. |
global-currencies | none | Currencies whose purchases count on every server, whatever the scope. |
A single server can leave this alone.
messages.yml#
lang/<code>/messages.yml. Every line the plugin sends. prefix is {primary}&lEMOTES {letters_black}•<reset> and every other message starts
with %prefix%.
| Key | Sent when | Placeholders |
|---|---|---|
playing | An emote started. | %emote%, %id%, %player% |
unknown-emote | The id names nothing, or the emote plays nothing. | %emote%, %id% |
no-permission | The player does not own it. | %emote%, %id% |
on-cooldown | A cooldown is running. | %emote%, %time% |
already-playing | They are performing one. | |
in-combat | They are combat tagged. | |
wrong-world | Emotes are off in their world. | |
needs-partner | A duet was asked for with nobody named. | %emote%, %id% |
invite-sent | To the inviter. | %player%, %emote% |
invite-received | To the invited player, with Accept and Decline buttons. | %player%, %emote% |
invite-expired | The invitation ran out, or the inviter left. | |
invite-declined | To the inviter, when it was declined. | %player% |
invite-none | Accepting or declining with nothing waiting. | |
invite-self | Inviting yourself. | |
partner-too-far | The partner is too far, or in another world. | %player% |
partner-busy | The partner is performing something, or left. | %player% |
partner-cannot | The partner cannot perform it, for any reason. | %player% |
list-header / list-entry / list-empty | /emote list. | %id%, %emote% |
favourite-added / favourite-removed | Starring and unstarring. | %emote% |
favourites-cleared / favourites-empty | Emptying the shortlist, or finding it already empty. | |
crate-won / crate-duplicate | A reel landed on something new, or already unlocked. | %emote%, %tier%, %refund% |
crate-no-keys | Not enough keys. | %amount%, %keys% |
crate-busy / crate-empty / crate-disabled | The crate refused to open. | |
given-key | To a player handed key items. | %amount% |
rewards-claimed | On join, when key items were waiting for them. | %amount% |
keys-received / keys-taken | To a player whose account keys changed. | %amount% |
keys-given | To the admin, after any keys subcommand. | %player%, %amount% |
unlock-granted / unlock-already / unlock-revoked | unlocks subcommands. | %emote%, %player% |
crate-block-added / crate-block-removed | A block was bound or unbound. | %location% |
crate-block-already / crate-block-missing | It already was, or never was. | |
crate-block-none | No block within six blocks is being looked at. | |
crate-blocks-header / crate-blocks-entry / crate-blocks-empty | crate block list. | %location% |
crate-blocks-cleared | crate block clear. | %amount% |
preview-location-set | The preview stage was moved. | %location% |
preview-unavailable / preview-unavailable-admin | A preview was asked for before a stage was set; the second only to admins. | |
showcase-added / showcase-removed | A showcase was placed or removed. | %location% |
showcase-missing | No showcase within five blocks. | |
showcases-header / showcases-entry / showcases-empty | showcase list. | %location% |
showcases-cleared | showcase clear. | %amount% |
favourites-clear-prompt | The confirmation asked before the menu empties the shortlist. | |
confirm-crate-blocks-clear / confirm-showcases-clear | A clear typed without confirm: what it would remove. | %command% |
The same file holds the wording one template draws for every row, the key item's name and lore, and what placeholders answer with nothing to say:
menu:
tab-open: "{success}✔ You are here"
tab-closed: "{warning}➥ 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"
emoting-now: "Emoting now"
key-item:
name: "{primary}&lEMOTE KEY"
lore: [...]
placeholders:
none: "None"
unknown: "Unknown"
spatial:
catalog: { ... }| Key | What it is |
|---|---|
menu.tab-open / menu.tab-closed | %category_status% on the tab being looked at, and on the others. |
menu.favourites-name | What the favourites tab is called. |
menu.favourite-on / menu.favourite-off | %emote_favourite% for a starred and an unstarred emote. |
menu.kind-solo / menu.kind-duet | %emote_kind% for a one-player and a two-player emote. |
menu.emoting-now | What the admin hub calls the number of players performing an emote right now. |
key-item.name / key-item.lore | How a held crate key is named and described. |
placeholders.none | A player placeholder asked with no player, and playing_id / playing_name when nothing is playing. |
placeholders.unknown | An emote_<id>_<field> placeholder naming an emote or a field that does not exist. |
spatial holds what the 3D selector says: spatial.catalog is its
buttons, hint lines and tour captions, and spot-placed, spot-removed, spot-missing and tour-reset
answer the /emotesadmin spatial commands. spatial.about-line ({letters_black}%line%) is one line
of the centre stage's description, %emote_about_1% to %emote_about_3%, with the wrapped text in
%line%. header-title to nothing-selected fill the placeholders the pre-1.4.0 layout drew; the
shipped layout no longer uses them, and they stay for a server whose own spatial/emotes.yml still does.
cancelled, camera-unavailable and refreshed are in the file but nothing sends them: an emote cut
short says so with the on-cancel sound, and /emotesadmin reload reports through ExyliaLib's own
reload line.
Every refusal of an emote fills %emote%, %id%, %player% and %time% whether or not the line uses
them, so any of them can be added to any refusal line.
Something missing on this page? Tell us on Discord