Content generated with AI — it may contain mistakes.

ExyliaSandBox/ReferencereferenceUpdated in v1.2.0

Configuration

Where the ExyliaSandBox files are, how to change the language, the RTP numbers, the /rekit cooldown, the command whitelist, the messages and the sidebar, with every key and default.

Page 14 of 246 min read
         - ""      - " {muted}❙ {letters}World: {highlight}%world%"      - " {muted}❙ {letters}Players: {success}%players%"      - ""      - " {muted}❙ {letters}Kills: {success}%kills%"      - " {muted}❙ {letters}Deaths: {error}%deaths%"      - " {muted}❙ {letters}KDR: {highlight}%kdr%"      - " {muted}❙ {letters}Playtime: {info}%sandbox_playtime%"      - ""      - " {muted}❙ {letters}Border: {info}%border%"      - ""      - " {highlight}{server-ip}"

ExyliaSandBox writes three files on the first run, in plugins/ExyliaSandBox/. None of them is inside the jar: they are generated from the plugin's own schema, comments included, so an unknown key is reported once and then removed from the file. Worlds, kits, templates, the kit room, teleport pads, the lobby and the kit-creator room live in the database and are edited from /sandboxadmin.

FileWhat is in it
config.ymlThe language, RTP and queue numbers, the TPA timeout, the rekit cooldown, the pad hologram settings, the command whitelist, the worlds scope
lang/<language>/messages.ymlEvery line the plugin sends, the queue action bars, the pad visuals, and every label the screens draw
lang/<language>/scoreboards.ymlThe one sidebar

After editing, run /sandboxadmin reload or click Reload in the admin panel. The database is not touched. A few values can also be changed in game from Settings.

Change the language#

language#

yaml
language: default

This picks the folder under plugins/ExyliaSandBox/lang/ the menus, messages and sidebar are read from. 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 you can edit. See Messages and languages.

Servers that ran 1.0.x keep their edits

On the first start of 1.1.0 the existing messages.yml, scoreboards.yml and menus/ are adopted as lang/custom/, and config.yml is set to language: custom, so nothing a server edited is lost. Set language to default or a code to switch to the shipped translations.

Make RTP and the queue feel right#

In config.yml:

plugins/ExyliaSandBox/config.yml
yaml
rtp:
  queue-pair-distance: 10
  search-attempts: 50
  border-margin: 20
  rotative-queue-actionbar-time: 2.0

Raise queue-pair-distance if paired players land too close; raise search-attempts if /rtp says there is no safe location on a rough world. How they work is in RTP and the queue.

Change the /rekit wait and the /tpa timeout#

yaml
tpa:
  request-timeout-seconds: 60
rekit:
  cooldown-seconds: 30

A rank can have a shorter /rekit wait with exyliasandbox.rekit.cooldown.<seconds>; see Teleport requests, /back and /rekit.

Choose which commands work inside a sandbox#

command-whitelist has enabled and a list of command names. Players inside a sandbox world or queue can run only those, unless they have exyliasandbox.bypass.blocked-commands. See Commands. Both keys can be edited in game on the Rules page of Settings.

Share worlds between servers#

worlds-scope decides which servers share the world list and teleport pads stored in the database. default follows the network group set in ExyliaLib's config.yml, so identical servers share and no group means one shared table. server gives each server its own, global shares with every server, and any other value is a group name. It is read at startup, so restart after changing it. See Database.

Edit what players read#

lang/<language>/messages.yml holds every line. Edit text freely; keep the %placeholders in a line. Colours are palette tokens ({primary}, {success}, {error}, {highlight} and so on); see Colours. A line may start with an effect tag such as [sound:ENTITY_VILLAGER_NO|1.0|1.0], which is an instruction and never reaches the screen.

The pad's boss bar, title and hologram lines are covered on Teleport pads.

Edit the sidebar#

lang/<language>/scoreboards.yml holds one board, sandbox, shown to anybody standing in a sandbox world. title is a list (several entries animate one per refresh) and at most fifteen lines are drawn. The names usable in the lines are on Placeholders.

Every key in config.yml
KeyDefaultWhat it does
languagedefaultLanguage folder; default, en, es, pt, fr, ru, tr or custom
rtp.queue-pair-distance10Blocks between the two players a queue pair drops in (0 to 1000 in the settings menu)
rtp.search-attempts50Random spots tried before giving up (1 to 1000)
rtp.border-margin20Blocks kept clear of the border, subtracted from the radius (0 to 1000)
rtp.rotative-queue-actionbar-time2.0Seconds each waiting player is advertised for; takes decimals
tpa.request-timeout-seconds60How long a /tpa request lives (5 to 3600)
rekit.cooldown-seconds30Seconds between two /rekit uses (0 to 86400)
tp-region.hologramsee fileScale, billboard, alignment, view distance, offsets, and config.update-interval in ticks (20)
command-whitelist.enabledtrueWhether commands are filtered inside a sandbox world
command-whitelist.commandsmsg, message, tell, w, whisper, reply, r, respond, sandbox, rtp, rtpqueue, rtpqueuefast, back, tpa, tpaccept, tpdeny, rekit, leavesandbox, leavertpqueue, kitcreator, kitsave, kitroom, bot, leaveNames without the slash
worlds-scopedefaultdefault, server, global or a group name
Every section of messages.yml

One prefix and fifteen sections. Every line takes %prefix%, and most take one or two of %world%, %player%, %region%, %name%, %slot%, %max% and %percent%.

SectionCovers
worldCreated, saved, deleted, imported, not found
queueJoining, leaving, pairing, teleporting, no kit, no safe location, the join broadcast, and the action bars in-queue-actionbar and rotative-queue-actionbar
tpaSent, received, accepted, denied, expired and the refusals. received is a list: the centred request with clickable accept and decline buttons
backNo location, teleporting, outside world
lobbyLobby set, kit-creator room set, not set
kitroomNo space, and the category create, delete and icon lines
kit-creatorEntering, saving, renaming, deleting, the icon, the slot limit and three title blocks
predefined-kitSaving, renaming, deleting, copying, the refusals and the invalid slot
rekitApplied, no kit, not in a world, and cooldown with %time%
tp-regionNo favourite kit, teleported, the wand, the create, save and delete lines, and bossbar, countdown-title and hologram-lines
generalNot available, command blocked, in combat
screensEvery label the screens draw: the PREGEN %percent% label, world statuses, the favourite toggle, the five preset names, enabled and disabled states, and the text the queue placeholder shows while nobody waits
promptsWhat a player is asked to type or pick: names, icons, the biome, the border, the pad name and interval
wizardsThe world creation and import wizards, and the lobby and kit-creator spawn wizards
confirmThe five confirmation screens, a title and two lines each

queue.in-queue-actionbar and queue.rotative-queue-actionbar are effect blocks. Their text takes %world%, %time% and, on the rotative one, %player%. A duration of 0 keeps the bar until the queue tick replaces or stops it. back.outside-world, queue.select-kit and the three kit-creator title blocks exist in the file but the kit creator's prompts come from prompts.

The default sidebar and its update settings
plugins/ExyliaSandBox/lang/en/scoreboards.yml
yaml
scoreboards:
  sandbox:
    enabled: true
    title: ["{primary}&lSANDBOX"]
    lines:
      - ""
      - " {muted}❙ {letters}World: {highlight}%world%"
      - " {muted}❙ {letters}Players: {success}%players%"
      - ""
      - " {muted}❙ {letters}Kills: {success}%kills%"
      - " {muted}❙ {letters}Deaths: {error}%deaths%"
      - " {muted}❙ {letters}KDR: {highlight}%kdr%"
      - " {muted}❙ {letters}Playtime: {info}%sandbox_playtime%"
      - ""
      - " {muted}❙ {letters}Border: {info}%border%"
      - ""
      - " {highlight}{server-ip}"
    update:
      interval: 10
      smart: true
      cache: true

{server-ip} is the address from ExyliaLib's shared colors.yml. update.interval is in ticks, not seconds. smart sends only the lines that changed.

Something missing on this page? Tell us on Discord