Content generated with AI — it may contain mistakes.

ExyliaCapture/Getting startedUpdated in v1.3.0

Install ExyliaCapture

Put the plugin and ExyliaLib on your server, start it, check that it loaded and choose where data is saved.

Page 2 of 234 min read

After this page ExyliaCapture is running on your server and /captureadmin opens the admin panel.

Before you start#

You need a Paper server (1.21.1 or newer) or a Folia server (1.21.4 or newer), running Java 21. These versions come from ExyliaLib; ExyliaCapture itself declares API 1.21 and supports Folia. Put ExyliaLib in plugins/ before the first start. Without it the server disables ExyliaCapture and says so in the console.

PluginWhat for
ExyliaLibConfiguration, database, menus, zone selection wand, holograms, boss bars, placeholders, rewards.

These are optional:

  • packetevents: the packet layer the client integrations sit on. Without it the plugin runs and only what is drawn with packets stays off.
  • PlaceholderAPI: to read the plugin's values from other plugins. See Placeholders.
  • A clan plugin: required for Conquest, and for clan mode in the other types. See Clans for which ones are detected.
  • Apollo or Feather: draws an on-screen waypoint over the running event's zone.
  • SurvivalCore: the waypoint plus the event clock, a beam, the zone border and a HUD bar. See On-screen visuals.
  • ViaVersion: older clients.
  • ExyliaStaff: players in staff mode or vanished are left out of every event.

Steps#

Add the plugins

Copy ExyliaCapture.jar and ExyliaLib.jar into the server's plugins/ folder.

Start the server

The first start writes the configuration files and creates six database tables.

Check the console

ExyliaCapture should load without errors. If ExyliaLib is missing, the console says so.

Open the panel

With the exyliacapture.admin permission (operators have it), run /captureadmin. A menu opens. Everything else happens there.

Check that it works#

Run /plugins: ExyliaCapture and ExyliaLib are green. Then run /captureadmin: the admin menu opens with Configurations, Active events, Reload and Settings. A plugins/ExyliaCapture/ folder now exists with the files listed below. Next, create your first event.

Events are not in a file

An event configuration (its type, zone, settings, rewards, commands and schedules) is a row in the database. You create and edit it from /captureadmin, which also lets several servers share one set of events by pointing at the same MySQL.

Going further#

Generated files#

All of them live in plugins/ExyliaCapture/.

FileContents
config.ymlLanguage, scheduler timezone, zone particles, hologram look per event type, leaderboard menus, Discord webhook.
database.ymlDatabase engine. H2 by default, embedded.
lang/<code>/messages.ymlEvery message, grouped by system, including boss bars and hologram lines.
lang/<code>/scoreboards.ymlOne sidebar per event type, plus the shared sidebar for several at once.
lang/<code>/menus/The menu layouts, admin and player.

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

Choosing an engine#

By default the plugin uses H2: a file in the plugin folder, nothing to install. That is fine for one server. To share events and statistics between servers, or to use MySQL, edit database.yml and restart. The general walkthrough is in Set up the database.

plugins/ExyliaCapture/database.yml
yaml
database:
  type: mysql
  settings:
    pool-size: 0
  mysql:
    host: 127.0.0.1
    port: 3306
    database: minecraft
    username: root
    password: ""

Supported engines: h2, mysql, mariadb, postgresql and mongodb. Only the block matching type is read; an unrecognised value falls back to h2 and says so in the console.

Changing the engine needs a restart

The database client is opened at boot. /captureadmin reload re-reads the files and the events; it does not swap the database client.

Database tables
TableHolds
capture_event_configsThe configured events.
capture_player_statsGlobal player statistics.
capture_player_event_statsPlayer statistics per event.
capture_clan_statsGlobal clan statistics.
capture_clan_event_statsClan statistics per event.
capture_pending_rewardsRewards owed to players who were offline when they won.

Every table declares what it holds, so /exylialib wipe ExyliaCapture and /exylialib resetplayer <player> ExyliaCapture cover them: event configurations are setup (kept by a season wipe); statistics and pending rewards are progress.

Updating#

Replace the jar and restart. config.yml is versioned and migrates itself, keeping your edits. See Configuration · Migrations.

Something missing on this page? Tell us on Discord