Configuration
Every key of config.yml, the hologram and NPC presets, the message files and the language.
config.yml decides how the plugin behaves. What it shows lives in holograms.yml and npcs.yml; see
the File reference.
debug: false
watch-files: true
modules:
holograms: true
npcs: true
holograms:
spawn-height: 2.0
default-view-distance: 48.0
near-radius: 20.0
skin-refresh: 30s
presets:
simple:
name: Simple title
lines:
- '<size:1.4>{primary}&l%hologram%'
- '{letters}Edit me with {highlight}/holo %hologram%'
# portal, lounge, checkpoint, welcome...
npcs:
default-view-distance: 48.0
default-look: each-viewer
face-creator: true
say-duration: 5s
turn-back: 4s
near-radius: 20.0
skin-refresh: 30s
presets:
guide:
name: Guide
skin: ''
label:
- '<size:1.2>{primary}&lGUIDE'
- '<opacity:200>{letters_black}Right-click me'
actions:
- 'right: [SOUND] ENTITY_VILLAGER_AMBIENT;1;1.2'
- 'right: [SAY] {letters}Welcome, {highlight}%player_name%{letters}! The portals are behind me.;6s'
- 'left: [ANIMATE] hurt'
- 'left: [SAY] {error}Hey, that hurt!;2s'
# simple, portal, shopkeeper, mirror...General
debugbooleanpor defecto falseExtra console output, for reporting a problem. With it on, every NPC click is logged with what became of it.
watch-filesbooleanpor defecto trueApply holograms.yml and npcs.yml on their own when they are saved by hand. Off, use
/holoadmin reload or /npcadmin reload after an edit. A change here takes effect on /displays reload.
modulesmappor defecto holograms: true, npcs: trueWhich modules run. A module switched off costs nothing; a module the file does not name runs. Needs a restart.
holograms
holograms.spawn-heightnumberpor defecto 2.0How far above your feet a hologram you create stands, in blocks. Below 0 reads as 0.
holograms.default-view-distancenumberpor defecto 48.0The view distance of a new hologram, in blocks.
holograms.near-radiusnumberpor defecto 20.0The radius of /holoadmin near when none is typed.
holograms.presetsmapWhat a hologram created from the list can start from, by id. name is shown in the window, lines are
its lines, and %hologram% in a line becomes the new hologram's name. Add your own; an empty map leaves
the window without a preset choice and new holograms get their name in bold. Shipped: simple, portal,
lounge, checkpoint, welcome.
npcs
npcs.default-view-distancenumberpor defecto 48.0The view distance of a new NPC, in blocks.
npcs.default-lookfixed | nearest | each-viewerpor defecto each-viewerWhere a new NPC turns its head.
npcs.face-creatorbooleanpor defecto trueA new NPC faces whoever created it. Off, it looks the way they were looking, level.
npcs.say-durationdurationpor defecto 5sHow long a [SAY] bubble stays when its line names no time. Reads 5s, 1m.
npcs.turn-backdurationpor defecto 4sHow long an NPC keeps facing whoever clicked it before turning back.
npcs.near-radiusnumberpor defecto 20.0The radius of /npcadmin near when none is typed.
npcs.skin-refreshdurationpor defecto 30sHow often a skin written as a placeholder (a leaderboard's top name) is read again. At least 1s.
npcs.presetsmapWhat an NPC created from the list can start from, by id. name is shown in the window; skin is an
account name or @mirror (empty keeps the one typed); label and actions are its label lines and
interaction lines; %npc% in a label line becomes its name. Shipped: simple, guide, portal,
shopkeeper, mirror.
Messages
| File | Contents |
|---|---|
lang/<code>/messages.yml | prefix (put into every %prefix%), reloaded, help, and the /displays modules lines. |
lang/<code>/messages/holograms.yml | Every hologram reply, /holo help, the info layout, the dialog windows' words, the visibility, attach and fine-adjust lines, and file-applied / file-issues. |
lang/<code>/messages/npcs.yml | Every NPC reply, /npc help, interaction-denied, interaction-cooldown (%remaining% seconds), say-bubble (%text%), the windows' words, and file-applied / file-issues. |
Colours use palette tokens ({primary}, {error}, {highlight}), so recolouring the server through
ExyliaLib never means editing these files. A message may open with [sound:NAME|volume|pitch], which plays
a sound and is never shown; [center] centres a help line, and <click:…> makes it clickable.
Language
The plugin has no language key: it follows ExyliaLib's. It ships English, Spanish (es) and Russian
(ru) messages and screens, written under lang/<code>/.
Reloading
/displays reload reads config.yml and the message files again, along with both module files, and
reloads the screens. modules is the one key that needs a restart.
Something missing on this page? Tell us on Discord