Getting started

Installation

The loader jar and the licence, dependencies, what changes without PacketEvents, the files the plugin writes and updating.

Getting the plugin

ExyliaJourney is a premium plugin, bought on BuiltByBit. It ships through the Lukittu loader, so the file you install is the loader jar, Exylia-Journey-Loader.jar. Bought on BuiltByBit, the licence is embedded in that jar: there is no key to enter. The loader checks the licence on every start and then hands over to the plugin.

Before you start

Requirement	What for
Paper or Folia 1.21.4+	The server. Folia is supported: progress changes on each player's own region thread.
Java 21	The runtime.
`ExyliaLib`	Required, version 1.392.0 or newer: guidance, world cameras, NPC click events, configuration, menus, rewards, the database and the `JourneyService` API.

ExyliaLib is listed as soft, and installed for you

The loader's plugin.yml names ExyliaLib under softdepend on purpose: the loader is what installs it, so the loader has to be allowed to start without it. On a server without ExyliaLib it downloads the newest release into plugins/ and asks for a restart.

PacketEvents

packetevents is optional but strongly recommended. It is what draws the floating text, the beacon, the trail, the glow and the cinematic camera, plus the step toasts, the plugin's own NPCs and the cinematic recorder's hotbar. Without it ExyliaJourney still runs every journey, with simpler guidance:

Part	With PacketEvents	Without it
Step text	A panel floating ahead of the eyes, or standing at a place	The step in chat when it starts, and one action bar segment with title, progress and distance
Beacon	A glowing beam with a distance label	A particle column over the target, or a particle marker towards it when far
Trail	Glowing markers on the ground along the route	Particle footprints along the route
Waypoint	Locator bar (1.21.6+) or Lunar/Feather minimap	None
Glow	The NPC or block outlined for the player	None
Cinematics	The camera flies the keyframes with subtitles, bars and fades	The camera does not move; subtitles arrive in chat at their times and sounds play
Plugin NPCs	Placed from `config.yml`	Not placed. ExyliaDisplays NPCs still work

Bedrock players always get the right-hand column, player by player, even with PacketEvents installed. See the FAQ.

Optional plugins

Plugin	What it adds
`PlaceholderAPI`	The `%journey_...%` placeholders in other plugins, and placeholder conditions in requirements and `PLACEHOLDER` objectives. See Placeholders.
`ExyliaDisplays`	Its NPCs as journey targets and triggers, with no setup. See Integrations.
`ExyliaAnalytics`	Every start, step, skip, completion and abandonment sent as an event. See Analytics.

Installing

Drop in the jars

Exylia-Journey-Loader.jar and packetevents into plugins/.

Start the server

The loader checks the licence embedded in the jar and hands over to the plugin. The loader installs ExyliaLib if it is missing; if it had to, restart once more.

Let it generate

The plugin writes config.yml, its messages and menus, and the folders journeys/ (with a disabled example.yml), cinematics/ and routes/.

Try it

Join as an operator and run /journeyadmin demo. See First steps.

Generated files

All of them live in plugins/ExyliaJourney/.

File	Contents
`loader.yml`	Written by the loader: `license_key`, and `version` (`auto` keeps the plugin on the newest release).
`config.yml`	Timings, feedback, the plugin's own NPCs, the guidance look and cinematic playback. See Configuration.
`journeys/<id>.yml`	One journey per file; the file name is its id. See Journeys.
`cinematics/<id>.yml`	One cinematic per file. See Cinematics.
`routes/<id>.yml`	One recorded route per file. See Guidance.
`lang/<language>/`	Messages, the editor's words, the menus and the recorder's hotbar.

Ids — file names of journeys, cinematics and routes — are lower-case letters, digits, - and _, at most 48 characters. A file with another name is reported and not loaded.

Player progress and the funnel counters are kept in the database ExyliaLib provides. The funnel counters are only ever added to, so several servers sharing one database add up.

Updating

Replace the loader jar and restart, or leave version: auto in loader.yml. Your config.yml, journeys, cinematics, routes and messages are kept; new keys are added with their defaults.

Something missing on this page? Tell us on Discord