Content generated with AI — it may contain mistakes.

Getting startedguide

First steps

Build a working journey around you with /journeyadmin demo, then make your own first journey in the in-game editor.

The demo, in one command

Stand somewhere open, as an operator, and run:

/journeyadmin demo

The plugin writes a complete example around you and starts it for you at once:

FileWhat it is
journeys/demo.ymlFirst steps, six steps, one of every common kind.
cinematics/demo-orbit.ymlEight shots circling you, three subtitles and two sounds.
routes/demo-path.ymlA curved path from where you stand to the guide.
config.yml → npcs.demo-guideA guide NPC about twenty blocks ahead of you.

The journey then walks you through:

  1. Watch the introduction — the cinematic plays (WATCH_CINEMATIC).
  2. Follow the trail — footprints and a beacon lead to the guide (REACH with a trail).
  3. Talk to the guide — right-click the NPC, which glows for you (INTERACT_NPC).
  4. Break three blocks — any block counts (BREAK_BLOCK).
  5. Open your journey — type /journey (RUN_COMMAND).
  6. Take a breath — five seconds you cannot skip (WAIT).

Finishing it pays 50 experience and plays the celebration. The demo journey is repeatable and starts only from a command or the demo:start key, so it never reaches your players on its own. Run the command again to rebuild it where you stand.

Without PacketEvents

The demo still runs, with chat and particle guidance, but the guide NPC cannot be shown: the plugin tells you so and gives you the command that finishes that step, /journeyadmin trigger <you> npc:demo-guide.

Your first journey

Open the editor

Run /journeyadmin. Every journey file is listed; click CREATE JOURNEY, type an id (welcome) and a name. The journey is created with one step, Find the meeting point: a REACH where you are standing.

Add the steps

STEPS → ADD STEP, pick an objective type, then fill the objective from its screen: the place (left-click PLACE sets where you stand), the NPC, the filter of blocks or items, the amount.

Show the way

On each step, GUIDANCE: the text panel, the beacon and its label, a trail along a recorded route, the waypoint, the glow and a cinematic to open the step. See Guidance.

Decide when it starts

TRIGGERS → ADD TRIGGER. For onboarding, FIRST_JOIN. A new journey has no trigger, so nobody gets it until you add one.

Reward it

REWARDS & EFFECTS for the journey, and EFFECTS & REWARDS on each step.

Test it

TEST ON YOURSELF starts the live version for you, ignoring its requirements and cooldown. CHECK lists anything the plugin could not read.

Every click is written back to journeys/<id>.yml and goes live at once, with no reload. See The editor.

What a fresh install does

Nothing reaches players until you say so: journeys/example.yml ships with enabled: false, and the demo only starts from a command. Once a journey is enabled with a trigger, players get it.

WhatDefault
Who can open /journeyEverybody (exyliajourney.use)
Who can editOperators (exyliajourney.admin)
First-join journeys start3 seconds after joining, so the world has loaded
HintsAfter 45 seconds idle on a step
A step counts as abandonedAfter 7 days with no progress
Cinematic viewers far awayMoved next to the scene beyond 96 blocks, then put back

Something missing on this page? Tell us on Discord