The editor

/journeyadmin opens the editor. Every change is written straight back to the YAML file — top-level comments and key order are kept — and goes live at once, without a reload. Anything the editor can do can also be written by hand in the files; the two never disagree.

The screens

Journeys (list)
├── CREATE JOURNEY · CINEMATICS · ROUTES
└── Journey (hub)
    ├── STATUS                 enabled / disabled
    ├── STEPS (list)           add, reorder with shift-clicks
    │   └── Step (hub)
    │       ├── OBJECTIVE      type and its fields
    │       ├── GUIDANCE       text, lines, place, beacon, waypoint, glow, trail, target, cinematic
    │       ├── TEXT & TIMING  title, description, hint, hint after, time limit, skippable
    │       ├── EFFECTS & REWARDS  on start, on complete, rewards
    │       ├── DUPLICATE STEP
    │       └── DELETE STEP
    ├── TRIGGERS (list)        add, edit, remove
    ├── REQUIREMENTS & GROUP   permission, condition, group
    ├── REWARDS & EFFECTS      rewards, on start, on complete
    ├── SETTINGS               name, description, icon, priority, repeatable, cooldown, skippable
    ├── FUNNEL                 the journey's stats
    ├── CHECK                  what the plugin could not read
    ├── TEST ON YOURSELF
    └── DELETE JOURNEY

Journeys

The root lists every journey file with its id, steps, group, triggers and state. Left-click edits it, right-click opens its funnel. A journey the plugin cannot load is shown as a barrier with the reason; clicking it opens the editor to fix it. The bottom row holds CREATE JOURNEY, CINEMATICS and ROUTES.

CREATE JOURNEY asks for an id and a name and writes a journey with one step, a REACH where you stand. It is enabled but has no trigger yet, so it reaches nobody until you add one.

Journey

The hub of one journey: STATUS switches it on and off; STEPS, TRIGGERS, REQUIREMENTS & GROUP, REWARDS & EFFECTS and SETTINGS open their pages; FUNNEL opens its stats; CHECK lists the problems found in the file. TEST ON YOURSELF starts the live version for you, ignoring requirements, cooldown and group. DELETE JOURNEY asks for confirmation.

Steps and step

The step list shows each step in order; shift-left and shift-right move a step up and down. ADD STEP asks for the objective type. A step the plugin cannot read is shown in red.

A step's hub opens four pages:

Triggers

One card per trigger, with a click per field: the region or sphere of a REGION_ENTER (shift-left sets the centre where you stand, shift-right the radius), the NPC, journey, permission or key of the others. Right-click removes a trigger. ADD TRIGGER asks for its type.

Cinematics

The list of cinematics: left-click edits, right-click plays it to you. RECORD CINEMATIC asks for an id and starts the recorder. A cinematic's hub opens KEYFRAMES, SUBTITLES and SOUNDS (each a list you can edit entry by entry), and has FADES (left: in, right: out), LETTERBOX, SKIPPABLE, RECORD AGAIN, WATCH IT and DELETE CINEMATIC. See Cinematics.

Routes

The list of routes: left-click opens one, right-click previews it. RECORD ROUTE asks for an id and starts recording. A route's screen has RECORD AGAIN, PREVIEW and DELETE ROUTE. See Guidance.

Edits while players are on a journey

An edited journey replaces the live one immediately, and every player on it stays where they were:

• on the same step, found by its id, wherever it moved — with their count kept;
• if their step was deleted, on the step now in its place, started afresh;
• if the journey got shorter, on its last step.

When an edit leaves the journey unreadable (a step half-built), the last working version stays live, the broken step is kept in the file and marked in the editor, and CHECK says what is wrong.

Cinematics and routes are edited the same way and go live at once.

Editing the files by hand

Edit the YAML and run /journeyadmin reload. It reloads config.yml, the messages, every journey, cinematic and route, the menus and the plugin's NPCs, and says how many problems it found.

Players on a journey you changed stay on their step by its id, exactly as with an editor edit. If their step is gone, they continue on the step now in its place, started afresh; if the journey got shorter than that, on its last step.

The editor's own words are in lang/<language>/editor.yml.