Content generated with AI — it may contain mistakes.

Getting started

Introduction

What ExyliaDisplays is, what it puts in the world, and how this documentation is organised.

ExyliaDisplays puts holograms and NPCs in the world of a Paper or Folia server, and gives both the same click system. It is free and open source, published under the GNU General Public License v3.0 on Modrinth.

Everything it shows is packets, drawn by ExyliaLib: nothing is a real entity, nothing is saved in the chunks, and nothing ticks on the server. A hologram or an NPC exists for whoever is close enough to see it and costs nothing when nobody is.

Each one can be edited three ways that always agree: screens and dialog windows in game, /holo and /npc commands, or holograms.yml and npcs.yml by hand, which are applied the moment you save them.

It used to be called ExyliaHolograms. A server coming from it keeps its holograms and its permission; see Migration.

What is included

Requirements

RequirementDetail
ServerPaper or Folia 1.21.4 or newer
Java21
Requiredpacketevents, and ExyliaLib 1.299.0 or newer (the 2.4.0 jar) — installed automatically when missing
OptionalPlaceholderAPI, whose placeholders work in every line and every action
ClientsDialog windows need a 1.21.6+ client; older clients and Bedrock players get the same fields through chat or forms
About ExyliaLib

The holograms, the NPCs, the line tags, the click lines, the screens and the dialog windows all come from ExyliaLib. ExyliaDisplays is what keeps them in files, edits them and gives them commands; every Exylia plugin that shows a hologram draws it the same way.

How to read this documentation

Getting started

Installation, what the first start writes, and a first hologram and NPC.

Holograms

Lines, line tags, pages, and who sees a hologram or what it rides.

NPCs

Skin, pose, equipment, where it looks, its label and a hologram that follows it.

Shared

Click interactions, fine adjust with the mouse wheel, editing the files by hand, the screens, and imports from other plugins.

Reference

Commands, permissions, config.yml and messages, every key of holograms.yml and npcs.yml, and the FAQ.

Conventions

  • Values marked as default are what the plugin writes when the key is missing.
  • Identifiers between < and > are variables: /holo <name> addline <text> means /holo spawn addline Welcome.
  • A hologram or an NPC is named by its name: lowercase letters, digits, _ and -, up to 32 characters. Commands lowercase what you type.
  • Colours use ExyliaLib palette tokens ({primary}, {highlight}, {letters}), & codes, hex and MiniMessage.
  • Line numbers in commands start at 1.

Something missing on this page? Tell us on Discord