Content generated with AI — it may contain mistakes.

ExyliaLib/Getting started

Installation

Installing the library on a server and depending on it from a plugin.

Page 2 of 543 min read

On the server#

The minimum is Paper 1.21.1 (Folia 1.21.4, which has no 1.21.1 build). On an older server the library still loads but logs a boxed error at startup naming the detected version, because Exylia plugins fail mid-game there. See Server versions.

Drop ExyliaLib.jar into plugins/, next to PacketEvents. Plugins that depend on it refuse to load without it.

On first start the server downloads the libraries ExyliaLib declares — the command framework, Caffeine, HikariCP, the database drivers and the Redis client — from Maven Central, the same way every Exylia plugin declares its own, and keeps them in its libraries/ folder. The server needs internet access for that first start; afterwards the copies are shared by every plugin.

PacketEvents goes next to it on every server. The library's packet features — overlays, dialogs, per-viewer displays, screens and the HUD — run through it. Since 1.595.0 the library lists it under softdepend: without it, or where it misreads the server (as on NeoForge hybrids), those features stay off and the console says so, and a plugin whose product is packets declares it as its own hard dependency. Download it from Modrinth.

The packet-level sidebar library travels inside the jar, relocated, so there is exactly one copy on the server rather than one per plugin.

Optional plugins#

Nothing here is required. Each one unlocks a module or improves one:

PluginWhat it enables
PlaceholderAPIExposing this plugin's placeholders to other plugins, and reading theirs.
FastAsyncWorldEditA faster engine for schematics. Without it the library pastes with its own engine.
Vault or PlayerPointsThe economy module.
A clan pluginThe clan module. Eight are detected — see Players.
Lunar (Apollo), Feather or the SurvivalCore client modClient integration: waypoints, teams, HUD timers, cooldowns.
DeluxeCombat or PvPManagerThe combat module's answer to "is this player fighting".
WorldsCreating and deleting worlds, which is the only way to do it on Folia.

A module whose backing plugin is absent does nothing loudly: Clans.isSupported() answers honestly instead of throwing, so a plugin can hide what it cannot offer.

Configuring it#

The library writes its own files to plugins/ExyliaLib/ on first start — language, updates, metrics, colours, formats. See The library's own files.

From a plugin#

Declare the dependency so the server loads the library first:

plugin.yml
yaml
name: MyPlugin
main: net.example.MyPlugin
api-version: '1.21'
depend:
  - ExyliaLib

Then take the module views you need in onEnable. Almost every module is reached the same way — a static of(plugin) handing back a view that belongs to your plugin:

MyPlugin.java
java
public final class MyPlugin extends JavaPlugin {
 
    private ConfigFile<Settings> settings;
 
    @Override
    public void onEnable() {
        TaskScheduler tasks = Tasks.of(this);
        PluginMenus menus   = Menus.of(this);
        PluginActions acts  = Actions.of(this);
 
        settings = Configs.define(this, "config", Settings.class).load();
    }
}
Why per plugin

The view is what makes ownership work: your actions live in your namespace, your menus close when your plugin disables, your placeholders unregister with it, and values written onto items are filed under your name rather than the library's.

Cleaning up#

You do not have to. The library releases a plugin's tasks, menus, actions, placeholders and inputs when it disables — menus are closed before tasks are released, so a button whose handler comes from a dying classloader cannot answer one last click.

The library's own commands#

/exylialib shows the library's status; its subcommands reload it, update it, review changed defaults, open the web editor and move data. See Commands.

A plugin listens for /exylialib reload with Reloads.onLibraryReload(plugin, runnable) — the palette changing is the usual reason, since every compiled menu is holding the old colours.

Something missing on this page? Tell us on Discord