Content generated with AI — it may contain mistakes.

ExyliaEmotes/ReferenceUpdated in v1.5.0

Configuration

Every block of config.yml and every line of messages.yml, with their defaults.

Page 14 of 2115 min read
            

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/ and lang/<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 (default 3s).
  • 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#

yaml
language: default

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

Servers that ran 1.0 keep their edits

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.

yaml
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: []
KeyDefaultWhat it does
require-permissiontrueWhether performing an emote needs owning it. Only /emotesadmin play reaches past it.
hide-without-permissionfalseWhether an emote the player does not own is hidden in the menu instead of shown locked.
cooldown3sHow 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-movetrueWhether walking ends an emote.
move-tolerance0.6How 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-damagetrueWhether being hit ends an emote, including another player punching the body.
block-in-combattrueWhether an emote is refused while the player is combat tagged, by whichever combat plugin ExyliaLib is bridged to.
endless-limit5mThe 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.
Leave cancel-on-damage on

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#

yaml
camera:
  enabled: true
  hide-body: true
KeyDefaultWhat it does
enabledtrueWhether 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-bodytrueWhether 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#

yaml
duet:
  invite: 20s
  max-distance: 3.0
KeyDefaultWhat it does
invite20sHow long an invitation stands before it expires. Never less than a second.
max-distance3.0How 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.

yaml
menu:
  favourites-icon: "AMETHYST_SHARD"
  style: CLASSIC
KeyDefaultWhat it does
favourites-iconAMETHYST_SHARDThe material the favourites tab is drawn as.
styleCLASSICWhat /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.

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.

crate#

yaml
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
KeyDefaultWhat it does
enabledtrueOff, the crate says so instead of opening.
start-keys1Keys a player is given the first time they are seen.
duplicate-refund1Keys handed back for an emote already unlocked.
rewardUNLOCKUNLOCK, 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-once4How many crates one player may open in one go, up to seven.
spin-frames34How many faces the first reel runs through. Capped at 200, about eleven seconds.
stagger-seconds2.0How long after one reel stops the next one does. 0 stops them together.
on-spinA hat notePlayed on every tick a reel is still falling.
on-winAn experience orbPlayed the moment a reel stops on something new, once per crate.
on-duplicateA bass notePlayed instead when that reel stopped on something already unlocked.
openingINVENTORYHow 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.

yaml
key-item:
  material: TRIPWIRE_HOOK
  glow: true

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

yaml
preview:
  location: ""
  distance: 5.0
  settle-ticks: 4
  linger-ticks: 20
  max-ticks: 600
KeyDefaultWhat it does
locationEmptyWhere 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.
distance5.0How far in front of the player the emote plays, in blocks. Never less than 1.
settle-ticks4How long to wait after the teleport before playing. Reads a written duration too: 1s, 500ms.
linger-ticks20How long the stage is held after the emote ends.
max-ticks600The 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#

yaml
showcase:
  locations: []
  pause-seconds: 3.0
  radius: 24.0
  emotes: []
KeyDefaultWhat it does
locations[]Where emotes play on a loop. Set them with /emotesadmin showcase add.
pause-seconds3.0The rest between one emote ending and the next starting.
radius24.0How 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#

yaml
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
KeyPlayed
on-playTo the player the moment their emote starts — to both, in a duet.
on-cancelTo the performers when an emote is ended before its time. Not when it runs to the end.
on-inviteTo 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.

Quieter sounds on update

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.

yaml
shop:
  enabled: true
  tier-prices:
    common: 500
    rare: 1500
    epic: 4000
    legendary: 10000
KeyDefaultWhat it does
enabledtrueWhether a locked emote with a price can be bought from the menu.
tier-prices500 / 1500 / 4000 / 10000What 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

yaml
ownership:
  scope: global
  global-currencies: []
KeyDefaultWhat it does
scopeglobalglobal: 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-currenciesnoneCurrencies 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%.

KeySent whenPlaceholders
playingAn emote started.%emote%, %id%, %player%
unknown-emoteThe id names nothing, or the emote plays nothing.%emote%, %id%
no-permissionThe player does not own it.%emote%, %id%
on-cooldownA cooldown is running.%emote%, %time%
already-playingThey are performing one.
in-combatThey are combat tagged.
wrong-worldEmotes are off in their world.
needs-partnerA duet was asked for with nobody named.%emote%, %id%
invite-sentTo the inviter.%player%, %emote%
invite-receivedTo the invited player, with Accept and Decline buttons.%player%, %emote%
invite-expiredThe invitation ran out, or the inviter left.
invite-declinedTo the inviter, when it was declined.%player%
invite-noneAccepting or declining with nothing waiting.
invite-selfInviting yourself.
partner-too-farThe partner is too far, or in another world.%player%
partner-busyThe partner is performing something, or left.%player%
partner-cannotThe partner cannot perform it, for any reason.%player%
list-header / list-entry / list-empty/emote list.%id%, %emote%
favourite-added / favourite-removedStarring and unstarring.%emote%
favourites-cleared / favourites-emptyEmptying the shortlist, or finding it already empty.
crate-won / crate-duplicateA reel landed on something new, or already unlocked.%emote%, %tier%, %refund%
crate-no-keysNot enough keys.%amount%, %keys%
crate-busy / crate-empty / crate-disabledThe crate refused to open.
given-keyTo a player handed key items.%amount%
rewards-claimedOn join, when key items were waiting for them.%amount%
keys-received / keys-takenTo a player whose account keys changed.%amount%
keys-givenTo the admin, after any keys subcommand.%player%, %amount%
unlock-granted / unlock-already / unlock-revokedunlocks subcommands.%emote%, %player%
crate-block-added / crate-block-removedA block was bound or unbound.%location%
crate-block-already / crate-block-missingIt already was, or never was.
crate-block-noneNo block within six blocks is being looked at.
crate-blocks-header / crate-blocks-entry / crate-blocks-emptycrate block list.%location%
crate-blocks-clearedcrate block clear.%amount%
preview-location-setThe preview stage was moved.%location%
preview-unavailable / preview-unavailable-adminA preview was asked for before a stage was set; the second only to admins.
showcase-added / showcase-removedA showcase was placed or removed.%location%
showcase-missingNo showcase within five blocks.
showcases-header / showcases-entry / showcases-emptyshowcase list.%location%
showcases-clearedshowcase clear.%amount%
favourites-clear-promptThe confirmation asked before the menu empties the shortlist.
confirm-crate-blocks-clear / confirm-showcases-clearA 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:

yaml
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: { ... }
KeyWhat it is
menu.tab-open / menu.tab-closed%category_status% on the tab being looked at, and on the others.
menu.favourites-nameWhat 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-nowWhat the admin hub calls the number of players performing an emote right now.
key-item.name / key-item.loreHow a held crate key is named and described.
placeholders.noneA player placeholder asked with no player, and playing_id / playing_name when nothing is playing.
placeholders.unknownAn 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.

Three keys are never sent

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