Reference

Configuration

Every key of config.yml with its default: timings, feedback, the plugin's own NPCs, the guidance look and cinematic playback, plus the language files.

config.yml holds what is not a journey, a cinematic or a route. Times are written 30s, 5m or 1h30m; colours are palette tokens such as {primary} or #rrggbb; blocks and icons are material names; sounds are key|volume|pitch. Apply a change with /journeyadmin reload.

General

Key	Default	What it does
`language`	`default`	`default` follows the language set in ExyliaLib's `config.yml`; a language code (`en`, `es`, `pt`, `fr`, `ru` or `tr`) sets this plugin alone. Each language is a folder under `lang/`.
`debug`	`false`	Explains in the console what the plugin is doing: starts, refusals, objectives counted.
`save-interval`	`5s`	How long changes wait before they are written, so a burst of progress costs one write. Players are always saved when they leave.
`first-join-delay`	`3s`	How long after a new player's first join their `FIRST_JOIN` journeys start, so the world has loaded.
`hint-after`	`45s`	Idle time on a step before its hint shows, for steps that do not set their own `hint-after`. `0s` turns default hints off.
`abandon-after`	`7d`	A step with no progress this long counts once as abandoned in the funnel and ExyliaAnalytics. Offline players are checked once an hour. `0s` turns it off. See Analytics.
`permission-check`	`5s`	How often `PERMISSION` triggers are checked for each online player.

Feedback

What plays on every completed step and journey, on top of each file's own effect lines.

Key	Default	What it does
`feedback.step-sound`	`minecraft:entity.experience_orb.pickup\|1.0\|1.4`	Played when a step is completed, unless the player turned journey sounds off.
`feedback.step-toast`	`GOAL`	The toast frame for a completed step: `TASK`, `GOAL` or `CHALLENGE`.
`feedback.step-toast-icon`	`LIME_DYE`	The toast icon.
`feedback.step-effects`	a burst of `HAPPY_VILLAGER` particles	Sequence lines played at the player when a step is completed.
`feedback.journey-effects`	the celebration (below)	Sequence lines played at the player when a journey is completed.

feedback:
  journey-effects:
    - '[SOUND] UI_TOAST_CHALLENGE_COMPLETE;1;1'
    - '[FIREWORK] color:{primary};fade:{accent};type:star'
    - '[CIRCLE] END_ROD;radius:1.6;points:28;y:0.2'
    - '[DELAY] 0.3'
    - '[FIREWORK] color:{highlight};fade:{secondary};type:ball_large'

NPCs

npcs is a map of NPCs this plugin places itself, by id, each one usable as an INTERACT_NPC target or an NPC_CLICK trigger. Empty by default; /journeyadmin demo adds demo-guide. They need PacketEvents.

Key	Default	What it does
`npcs.<id>.location`	`world,0,64,0,0`	`world,x,y,z[,yaw[,pitch]]`.
`npcs.<id>.skin`	`''`	A player name whose skin it wears; blank for the default.
`npcs.<id>.glow`	`''`	An outline colour as `#rrggbb`; blank for none.

Guide

How guidance looks. The beacon's colour, label and the trail's route are per step; these are the shared defaults.

Text

Key	Default	What it does
`guide.text-background`	`#000000`	The panel's background colour.
`guide.text-background-opacity`	`120`	Its opacity, `0` (no panel) to `255`.
`guide.text-line-width`	`220`	Width in pixels before a line wraps.
`guide.text-shadow`	`true`	Text shadow.
`guide.companion-scale`	`0.55`	The companion panel's size.
`guide.companion-ahead`	`2.5`	How far ahead of the eyes it floats, in blocks.
`guide.companion-drop`	`0.35`	How far below the line of sight.
`guide.companion-hide-above-speed`	`7.5`	It steps aside above this speed, in blocks per second.
`guide.companion-hide-in-combat`	`true`	It steps aside in combat.
`guide.anchored-scale`	`1.0`	The anchored panel's size.
`guide.anchored-height`	`2.4`	How high over the target it floats when the step names no anchor.
`guide.anchored-max-scale`	`4.0`	How much it may grow with distance so it stays readable. `1` keeps it fixed.

Beacon

Key	Default	What it does
`guide.beacon-block`	`PURPLE_STAINED_GLASS`	The beam's block. Stained glass reads best. The outline colour is the step's.
`guide.beacon-height`	`48`	The beam's height.
`guide.beacon-width`	`0.35`	Its width.
`guide.beacon-marker-distance`	`30`	How far ahead the stand-in is drawn while the target is out of sight.

Trail

Key	Default	What it does
`guide.trail-block`	`PURPLE_CONCRETE`	The trail's markers.
`guide.trail-color`	`{secondary_light}`	Their outline.
`guide.trail-spacing`	`1.5`	Blocks between markers.
`guide.trail-off-route`	`6`	How far off the route a player must stray for the way back to show.
`guide.trail-way-back-block`	`ORANGE_CONCRETE`	The way-back markers.
`guide.trail-way-back-color`	`{warning}`	Their outline.
`guide.route-simplify`	`0.4`	How much recorded routes are thinned before drawing, in blocks. `0` keeps every point.

Glow and hints

Key	Default	What it does
`guide.glow-color`	`{primary}`	The outline of a glowing target NPC or block.
`guide.hint-sound`	`minecraft:block.note_block.bell\|0.7\|1.6`	Played when a hint shows, unless the player turned journey sounds off.

Cinematics

Key	Default	What it does
`cinematics.move-viewer-beyond`	`96`	A viewer farther than this many blocks from a cinematic's first keyframe is moved next to it first and put back exactly where they stood when it ends. `0` never moves anybody.

Language files

The plugin ships en, es, pt, fr, ru and tr. Under lang/<language>/:

File	Contents
`messages.yml`	The prefix, every player and admin line, the panel and beacon label, the chat and action bar fallback lines, cinematic subtitles, the editor's prompts, labels, and the names of the guidance switches in `/settings`.
`editor.yml`	The editor's words.
`menus/user/journey.yml`	The `/journey` screen. Yours to restyle: an update only adds what is missing.
`menus/admin/`	The editor's screens. Regenerated from the plugin on every start.
`overlays/cinematic_recorder.yml`	The recorder's hotbar.

Something missing on this page? Tell us on Discord