Reference

File reference

Every key of holograms.yml and npcs.yml, with its type, default and what it does.

Both files hold one block per entry, keyed by its name. A hand-written entry only needs the keys it changes; everything else takes the default shown here. See Editing the files for how a save is applied.

holograms.yml

plugins/ExyliaDisplays/holograms.yml

holograms:
  spawn:
    enabled: true
    location: {world: world, x: 0.5, y: 66.0, z: 0.5, yaw: 0.0, pitch: 0.0}
    lines:
      - '<size:2><shine>{primary}&lWELCOME'
      - '{letters}to the server'
    pages: []
    page-interval: 0
    permission: ''
    view-distance: 48.0
    per-player: false
    appearance:
      billboard: CENTER
      alignment: CENTER
      scale-x: 1.0
      scale-y: 1.0
      scale-z: 1.0
      shadow: true
      see-through: false
      line-width: 200
      line-spacing: 0.25
      text-opacity: 255
      default-background: false
      background-color: '#00000000'
      brightness: -1
      glowing: false
    refresh:
      update-interval: 20
      auto-update: true
    click:
      commands: []
      width: 1.5
      cooldown: 500
      hover-scale: 1.08
    visibility:
      mode: all
      shown-to: []
      hidden-from: []
    attach:
      entity: ''
      offset: 0.5

Key	Type	Default	What it does
`enabled`	boolean	`true`	`false` keeps it in the file without showing it.
`location.world`	string	`world`	The world's folder name. A world that is not loaded is waited for.
`location.x` `.y` `.z`	number	`0.5` `100` `0.5`	Where the bottom line stands; lines stack upwards. Kept to 0.001.
`location.yaw`	number	`0`	Which way it faces, for a `FIXED` billboard: 0 south, 90 west, 180 north, -90 east.
`location.pitch`	number	`0`	How far it leans, for a `FIXED` billboard.
`lines`	list	empty	Page 1, top first, with line tags.
`pages`	list	empty	Pages after the first, each `lines` and `click` (a list of interaction lines). See Pages.
`page-interval`	ticks	`0`	Each player's page turns on its own every that many ticks; 0 never.
`permission`	string	empty	Only players with it see it.
`view-distance`	number	`48`	How far away it is seen, in blocks. 0 or less reads as 48.
`per-player`	boolean	`false`	A copy per viewer. On by itself when a line has a placeholder.
`appearance.billboard`	`CENTER` `VERTICAL` `HORIZONTAL` `FIXED`	`CENTER`	How it turns toward the player.
`appearance.alignment`	`CENTER` `LEFT` `RIGHT`	`CENTER`	Text alignment.
`appearance.scale-x` `-y` `-z`	number	`1.0`	Size along each axis.
`appearance.shadow`	boolean	`true`	Text shadow.
`appearance.see-through`	boolean	`false`	Visible through blocks.
`appearance.line-width`	integer	`200`	Pixels before the client wraps a line.
`appearance.line-spacing`	number	`0.25`	Blocks between lines.
`appearance.text-opacity`	0–255	`255`	Text opacity.
`appearance.default-background`	boolean	`false`	Use the client's own background instead of the colour below.
`appearance.background-color`	`#AARRGGBB`	`#00000000`	Background; `#00000000` is transparent.
`appearance.brightness`	-1–15	`-1`	Fixed light level, or -1 for the light where it stands.
`appearance.glowing`	boolean	`false`	Whether it glows. Only set in the file.
`refresh.update-interval`	ticks	`20`	Ticks between placeholder refreshes. Also reads `1s`, `500ms`.
`refresh.auto-update`	boolean	`true`	Whether the lines refresh on their own. Lines without placeholders never do.
`click.commands`	list	empty	Interaction lines run on page 1. Empty: not clickable.
`click.width`	number	`1.5`	Width of the click box; it is as tall as the lines.
`click.cooldown`	milliseconds	`500`	Wait between two clicks of the same player. Also reads `500ms`, `1s`.
`click.hover-scale`	number	`1.08`	Growth while a player looks at it; `1` off.
`visibility.mode`	`all` `manual`	`all`	`all`: everyone but `hidden-from`. `manual`: only `shown-to`. Anything else reads as `all`.
`visibility.shown-to`	list of UUIDs	empty	Who sees it in `manual`.
`visibility.hidden-from`	list of UUIDs	empty	Who does not see it in `all`.
`attach.entity`	UUID	empty	A player or saved entity it rides. See Visibility and attaching.
`attach.offset`	number	`0.5`	How high above the entity it rides.

npcs.yml

plugins/ExyliaDisplays/npcs.yml

npcs:
  guide:
    enabled: true
    location: {world: lobby, x: 0.5, y: 64.0, z: -3.5, yaw: 180.0, pitch: 0.0}
    skin: {type: player, player: Notch, texture: '', signature: ''}
    pose: standing
    scale: 1.0
    glow: '#8a51c4'
    equipment: {hand: DIAMOND_SWORD, head: playerhead-Notch}
    look: {mode: each-viewer, range: 8.0}
    view-distance: 48.0
    permission: ''
    label:
      lines: ['<size:1.2><shine>{primary}&lGUIDE']
      height-offset: 0.25
    linked-hologram: ''
    interactions:
      actions: ['right: [SAY] Hello, %player_name%!;5s']
      permission: ''
      cooldown: 2s
      deny-message: ''
      cooldown-message: ''
      face-clicker: true

Key	Type	Default	What it does
`enabled`	boolean	`true`	`false` keeps it in the file without showing it.
`location`	world, x, y, z, yaw, pitch	`world`, `0.5`, `100`, `0.5`, `0`, `0`	Where it stands and which way it faces. Yaw 0 south, 90 west, 180 north, -90 east; pitch -90 to 90.
`skin.type`	`player` `texture` `mirror` `none`	`none`	Where the skin comes from. A type missing what it needs draws the default skin.
`skin.player`	string	empty	The account, for `player`.
`skin.texture`	string	empty	The base64 texture value, for `texture`.
`skin.signature`	string	empty	Mojang's signature of the texture; without it the client draws the default skin.
`pose`	`standing` `sneaking` `lying` `crawling` `spinning`	`standing`	How it holds itself.
`scale`	number	`1.0`	1 is a player's size; clamped to 0.0625–16.
`glow`	`#RRGGBB`	empty	An outline, drawn in the nearest team colour. Empty for none.
`equipment`	map	empty	By slot (`head`, `chest`, `legs`, `feet`, `hand`, `off_hand`): a material, `playerhead-<name>`, `basehead-<texture>` or a `bytes:` item.
`look.mode`	`fixed` `nearest` `each-viewer`	`each-viewer`	Where its head turns.
`look.range`	number	`8.0`	How close a player must be for it to turn to them.
`view-distance`	number	`48`	How far away it is seen.
`permission`	string	empty	Only players with it see it and its label.
`label.lines`	list	empty	The lines above its head, top first, with line tags. Empty: no label.
`label.height-offset`	number	`0.25`	Gap between the top of its head and the label's bottom line.
`linked-hologram`	string	empty	A hologram of `holograms.yml` kept above its head. See NPCs.
`interactions.actions`	list	empty	Interaction lines, run in order.
`interactions.permission`	string	empty	Only players with it can use it.
`interactions.cooldown`	duration	`0`	Wait between two uses by the same player: `500ms`, `2s`, `1m`.
`interactions.deny-message`	string	empty	Told to a player without the permission; empty uses `interaction-denied`.
`interactions.cooldown-message`	string	empty	Told to a player still waiting (`%remaining%` seconds); empty uses `interaction-cooldown`.
`interactions.face-clicker`	boolean	`true`	Turn to whoever clicked it for `turn-back`.

Something missing on this page? Tell us on Discord