Content generated with AI — it may contain mistakes.

ExyliaEvents/Getting startedUpdated in v1.11.0

Installation

Install ExyliaEvents with ExyliaLib, set the main lobby, and choose where its data is stored.

Page 2 of 254 min read

Install ExyliaEvents next to ExyliaLib, start the server once and set the lobby players return to. After that you are ready to create your first event.

Before you start#

You need Paper 1.21.1 or newer, or Folia 1.21.4 or newer, with Java 21. ExyliaLib must be in plugins/ before the first boot: it provides configuration, database, menus, holograms, scoreboards, placeholders, rewards and schematics.

Everything else is optional and only adds something:

  • packetevents: the client-side effects drawn with packets. Without it the plugin runs and only those extras stay off.
  • FastAsyncWorldEdit: saves, restores and clones arena schematics when installed. Without it ExyliaLib's built-in engine does the same with the same .schem files.
  • PlaceholderAPI: read the plugin's counters elsewhere. See Placeholders.
  • ExyliaProxyUtils: only for a network, to move a player to the server an event is on. See Network.
  • Worlds: how the temporary world arena copies go into is created on Folia. Off Folia the plugin creates it through Bukkit itself and this is not needed.
  • ExyliaPracticeCore, ExyliaFFA, ExyliaSandBox: a player busy in one of those cannot be pulled into an event, and the other way round. ExyliaPracticeCore also lends its kits to any event and its arenas to Brackets, Sumo and Tournament: see Teams, kits and loot · PracticeCore kits.
  • AuraSkills, mcMMO: held back during events unless an arena allows them, through the skills arena flag.
  • ViaVersion, WorldGuard, TAB, floodgate, Apollo, Feather: load-order declarations for servers that run them.

Steps#

Drop in the jars

Put ExyliaEvents.jar and ExyliaLib into plugins/.

Start the server

The first boot writes the configuration files and creates the database tables.

Set the main lobby

Run /eventsadmin and set the lobby players return to when they leave an event.

Create your first event

Check that it works#

After the first boot, plugins/ExyliaEvents/ contains config.yml and a lang/<code>/ folder, and the console shows no errors from ExyliaEvents. /eventsadmin opens the admin panel for anyone with the admin permission (see Permissions). If it does not, see Common problems.

Going further#

Store data in MySQL or another database#

The default is H2, embedded. To share configurations and statistics between servers, point database.yml at a real database:

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

Engines: h2, mysql, mariadb, postgresql, mongodb. The shared options are described in Database.

Arena schematics are per server

Configurations travel through the database, but the .schem files behind them live on each server's disk. A second server reading the same database still needs those files to restore or clone an arena.

Back up and move your events#

/eventsadmin export dumps every table into plugins/ExyliaEvents/dumps/ and reports how many rows it wrote. /eventsadmin import <filename> reads one of those files back from the same folder. Do it before a risky change on a live server; it is also how a set of configurations moves between database engines.

Update#

Replace the jar and restart. config.yml is versioned and migrates itself: see Configuration · Migrations.

Generated files and tables

In plugins/ExyliaEvents/:

FileContents
config.ymlLanguage, limits, cooldowns, timers, command whitelist, world rules, random events, music.
lang/<code>/messages.ymlEvery message, with a section per event type, including its boss bars and titles.
lang/<code>/scoreboards.ymlOne sidebar per event type, plus the lobby sidebar.
lang/<code>/buildbattle-themes.ymlThe themes Build Battle votes on.
lang/<code>/trivia-questions.ymlThe questions Trivia asks.
lang/<code>/menus/Menu layouts: the admin panel, one settings screen per type, and the player menus.

<code> is the language the plugin runs in: en, es, pt, fr, tr or ru, or ExyliaLib's own language while config.yml says language: default. See Configuration · language.

Tables:

TableHolds
event_configurationsThe configured events, with their settings, rewards and loot tables.
events_player_statsGlobal player statistics.
events_player_event_statsStatistics per player per arena.
events_player_type_statsStatistics per player per minigame, across all its arenas.
events_player_preferencesPer-player preferences, currently the music toggle.
events_settingsThe single settings row an older version wrote, read once and adopted.
events_server_settingsPer-backend settings, currently each server's main lobby location.
event_kitsKits belonging to a configuration, and its links to PracticeCore kits.
event_gauntletsSaved gauntlet series.
event_inscriptionsSign-up lists.
event_pending_rewardsRewards owed to players who were offline.

Something missing on this page? Tell us on Discord