Getting started

Installation

Downloading the plugin, what it needs, the files the first start writes, and how updates arrive.

Downloading

ExyliaLobby is free. Every release is published on GitHub with the jar ExyliaLobby.jar, which keeps the same name on every release.

Before you start

Plugin	What for
`ExyliaLib`	Required. Configuration, menus, actions, the database, regions, holograms, teleports, the proxy link and player settings.
`PacketEvents`	Recommended. The hotbar overlay, player visibility and endless parkour need it; without it everyone sees everyone and endless parkour is unavailable.
`PlaceholderAPI`	Optional. Lets other plugins read the `%exylialobby_...%` placeholders.
`WorldGuard`	Optional. Lets a WorldGuard region be a lobby area.
`ExyliaJourney`	Optional. The onboarding module hands first-join players to it.
`ExyliaPracticeCore`	Optional. While it is installed its own lobby hotbar stays in charge, unless `force` is on in the hotbar module.

ExyliaLib is listed as soft, and is not downloaded

plugin.yml names ExyliaLib under softdepend on purpose, so the plugin can still start without it and say what is wrong. When it is missing, the console says where to download it (Modrinth or its GitHub releases) and ExyliaLobby stays off until it is installed and the server restarts. Nothing is downloaded for you.

The server selector reads its player counts from the proxy through ExyliaLib, so it needs the network link described on ExyliaLib's installation page to show live numbers.

Installing

Drop in the jars

Copy ExyliaLobby.jar into plugins/, next to ExyliaLib (and PacketEvents).

Start the server

The plugin writes its files and starts the modules that are on by default.

Open the hub

Run /lobbyadmin and follow First steps.

Generated files

All of them live in plugins/ExyliaLobby/.

File	Contents
`config.yml`	The language, which modules run, the lobby areas, the staff command labels and `debug`.
`modules/<module>/config.yml`	One settings file per module. See the module pages.
`modules/parkour/courses.yml`, `themes.yml`	The parkour courses and the endless block themes.
`lang/<code>/messages.yml`, `modules.yml`	The plugin's own lines and the name and description of each module card.
`lang/<code>/modules/<module>/messages.yml`	The text of each module.
`lang/<code>/menus/`	The menus. Admin menus are regenerated from the jar; player menus are yours to restyle and only gain what is missing.

Missing files are written again and new keys are added on every start. A changed default in a menu waits in /exylialib updates instead of overwriting your edit.

Parkour times and the lobby PvP stats are kept in ExyliaLib's database (lobby_parkour_records, lobby_parkour_stats, lobby_pvp_stats), so lobbies that share a database share their leaderboards. /exylialib wipe and resetplayer cover them.

Updating

ExyliaLib watches this plugin's GitHub releases. The plugin names its repository in plugin.yml (exylia-updates: Exylia-Plugins/ExyliaLobby) and the oldest library it runs on (exylia-lib).

A new release is announced in the console and to admins; /exylialib plugins downloads it and it applies on the next restart.
A new major version is only announced.
A release that needs a newer ExyliaLib waits until the library has updated.

To update by hand, replace the jar and restart. Your settings keep their edits.

Something missing on this page? Tell us on Discord