Content generated with AI — it may contain mistakes.

ExyliaSandBox/Getting startedguideUpdated in v1.2.0

Install ExyliaSandBox

Install the plugin and its dependencies, survive the restart the first boot triggers, set the lobby, and find the files it creates.

Page 2 of 245 min read

At the end of this page ExyliaSandBox is running, your five default worlds are generated and the lobby is set. Plan for two server starts: the first one generates the worlds and then stops the server on purpose.

Before you start#

You need a Paper, Spigot or Folia server on Minecraft 1.21.4 or newer, and these plugins:

PluginNeededWhat for
ChunkyYesPre-generating each world out to its border before anybody is let in. The server refuses to load ExyliaSandBox without it.
ExyliaLibYesMenus, configuration, database, placeholders, holograms, sidebars, regions, inventory snapshots and wizards.
PlaceholderAPINoUsing the plugin's placeholders in other plugins.
ExyliaPracticeCoreNoLetting a predefined kit use PracticeCore's kits. See the warning below.
WorldsFolia onlyFolia cannot create a world the usual way; ExyliaLib goes through Worlds. Without it, a world on Folia stays UNAVAILABLE.
packeteventsNoOnly the packet-drawn extras stay off without it.
LuckPerms or any permission pluginNoGiving ranks more kit slots with exyliasandbox.max_kits.<n>.
ExyliaPracticeCore takes the inventory over

When ExyliaPracticeCore is installed, ExyliaSandBox never saves or restores a player's inventory on entry, exit, death or join: the practice lobby dresses them instead. The plugin is detected by name only. Decide before you open the server; installing it halfway through is what leaves a player holding a sandbox kit in the lobby.

Steps#

Drop in the jars

Copy ExyliaSandBox.jar, ExyliaLib.jar and Chunky.jar into plugins/.

Start the server and let it stop

The first start writes config.yml, the language folders and the database tables, creates five worlds and five kit-room categories, then pre-generates every world through Chunky. When the last one finishes the plugin shuts the server down. Start it again and the worlds are ready.

Set the lobby

Run /sandboxadmin, click Set lobby, walk to where players should arrive and sneak-click. That is where every player returns when they die, leave or disconnect. Nothing works properly until it is set.

Set the kit creator room

In /sandboxadmin, click Set kit creator and do the same in the room where players will build kits.

Finishing a pre-generation shuts the server down

This is not only the first start. Whenever the pre-generation queue drains, including after you create a world from the admin panel on a live server, the plugin stops the server and logs All worlds pregenerated. Restarting server.... Create worlds in a maintenance window, or run the server under a process manager that starts it again.

Check that it works#

After the second start, run /sandboxadmin and click Worlds: desert, plains, snowy, mushroom and badlands are listed and ready. Then run /rtp as a player. You should land in a sandbox world. If the lobby was not set, you are told so. Next: Your first sandbox.

Going further#

Use a shared database#

By default the plugin uses H2: one file in the plugin folder, with no server to run. To share worlds, kits and statistics across servers, point every server at the same database in plugins/ExyliaSandBox/database.yml:

plugins/ExyliaSandBox/database.yml
yaml
database:
  type: mysql
  mysql:
    host: 127.0.0.1
    port: 3306
    database: minecraft
    username: root
    password: ""

Supported engines are h2, mysql, mariadb, postgresql and mongodb. The file belongs to ExyliaLib; see its database page. The table columns are on the Database page.

Change the language#

language in config.yml picks one of en, es, pt, fr, ru or tr. See Configuration and, for colours and messages, Messages and languages.

Update the plugin#

Replace the jar and restart. Your edits to config.yml, messages.yml, scoreboards.yml and menus/user/ are kept; menus/admin/ is refreshed from the jar. A server coming from 1.0.x has its files adopted into lang/custom/ on the first start. Worlds, kits and statistics live in the database and are never touched by an update.

To re-read the config files and recompile the menus without a restart, run /sandboxadmin reload from the console, or click Reload in the admin panel.

Generated files

All of them live in plugins/ExyliaSandBox/.

FileContents
config.ymlLanguage, RTP and queue numbers, TPA timeout, rekit cooldown, teleport-pad hologram, command whitelist.
lang/<language>/messages.ymlEvery line the plugin sends, the queue bars and pad visuals, and every screen label.
lang/<language>/scoreboards.ymlThe one sidebar, shown to anybody standing in a sandbox world.
lang/<language>/menus/user/The six player screens. Yours to edit; a release adds what is missing and never overwrites your changes. A changed default waits in /exylialib updates.
lang/<language>/menus/admin/The fourteen admin screens. Rewritten from the jar on every start, so a button added in a release reaches existing servers; each file carries a banner saying so.
database.ymlDatabase engine and Redis, written by ExyliaLib.

There is no config.yml inside the jar: the file is generated from the plugin's schema on first run, comments included. That is why an unknown key is reported once and then removed.

The eight tables, all prefixed sandbox_: sandbox_worlds, sandbox_player_kits, sandbox_predefined_kits, sandbox_kitroom_categories, sandbox_kitroom_items, sandbox_player_stats, sandbox_settings and sandbox_tp_regions.

plugin.yml also names ViaVersion, Multiverse-Core, PhantomWorlds, ExyliaEvents and ExyliaFFA, but this plugin never reads them. ExyliaLib is listed as a soft dependency only so the loader that installs it can load first; the plugin does not run without it.

Something missing on this page? Tell us on Discord