Skip to content

File Format

dimazbtw edited this page Jun 11, 2026 · 1 revision

File Format

Each display is one YAML file in plugins/Sentinel-TextDisplays/displays/, using the familiar DecentHolograms-style format — location string, pages → lines → content, actions, ranges. Edit by hand and run /td reload, or never touch a file: the GUI and commands write it for you.

A fully commented example.yml is generated on first start.

location: "world:0.500:101.000:0.500"
facing: 0.0              # rotation in degrees (FIXED / VERTICAL billboard)
enabled: true
display-range: 48.0      # how close a player must be to SEE the display
update-range: 48.0       # how close for placeholders to keep refreshing
update-interval: 20      # ticks between placeholder updates (20 = 1s)
down-origin: false       # anchor at the bottom instead of the top

pages:
- lines:
  - content: '<gradient:#00c6ff:#0072ff>Welcome</gradient>'
  - content: '&7Hello, &f%player_name%'
  actions:
    RIGHT:
    - 'MESSAGE:&aYou clicked!'
    - 'SOUND:UI_BUTTON_CLICK'

# ---- text-display options ----
scale: [1.5, 1.5, 1.5]   # text size per axis (1.0 = vanilla)
billboard: CENTER        # FIXED | VERTICAL | HORIZONTAL | CENTER
background: transparent  # default | transparent | #RRGGBB | #AARRGGBB
text-opacity: 255        # 0-255
line-width: 200          # wrap width in pixels
text-shadow: true
see-through: false       # visible through blocks
text-alignment: CENTER   # LEFT | CENTER | RIGHT
brightness-block: -1     # 0-15, -1 = follow world light
brightness-sky: -1
view-permission: ''      # only players with this node see it ('' = everyone)
click-width: 2.5         # click hitbox; > 0 enables clicking
click-height: 1.6

Option reference

Option Values Notes
location "world:x:y:z" Where the display stands
facing degrees Visible with FIXED / VERTICAL billboard
display-range / update-range blocks See / refresh distance
update-interval ticks Placeholder refresh rate
down-origin true / false Anchor at the bottom — new lines push the text up
pages list Each page has lines (each with content) and optional actions
scale [x, y, z] or single number Text size; 1.0 = vanilla
billboard FIXED · VERTICAL · HORIZONTAL · CENTER How it faces players
background default · transparent · #RRGGBB · #AARRGGBB ARGB supports translucency
text-opacity 0 – 255 255 = opaque
line-width pixels Wrap width (default 200)
text-shadow / see-through true / false
text-alignment LEFT · CENTER · RIGHT Multi-line text
brightness-block / brightness-sky 0 – 15, -1 -1 follows world light
view-permission node or '' Hide from unpermitted players
click-width / click-height blocks > 0 enables clicking

Coming from DecentHolograms? The structure matches (location string, pages → lines → content, actions with LEFT/RIGHT/SHIFT_LEFT/SHIFT_RIGHT), so most hologram files drop in with minimal changes — the text-display options above are additive extras.

Clone this wiki locally