Skip to content

Holograms

alexisleder edited this page Sep 27, 2026 · 5 revisions

Holograms

LederProtections uses Bukkit TextDisplay entities. It does not require a hologram plugin or NMS. Displays are tagged with persistent data, are not saved as permanent world entities, and synchronize only with loaded chunks—there is no per-tick world scan.

Global switch

holograms:
  enabled: false

Run /lep reload after changing the setting. Disabling it removes loaded LederProtections displays and prevents new ones from spawning.

default-enabled controls protections whose individual setting remains DEFAULT. An owner/admin can choose ENABLED, DISABLED or DEFAULT from the protection's public settings.

Display settings

Setting Meaning
height Vertical offset above the protection stone.
view-distance Approximate view distance in blocks.
line-width Text wrapping width used by TextDisplay.
lines Ordered text lines; colors use & codes.

The current default configuration uses four lines: a welcome using the protection name, the owner, the stone coordinates and the public description. It does not include {user} or PlaceholderAPI tokens by default, so it keeps one shared display per protection. The default TextDisplay background panel is disabled; text shadow remains enabled. This leaves the text readable without a large translucent rectangle behind it.

holograms:
  lines:
    - "&bBienvenid@ a {title}"
    - "&7Dueño: &f{owner}"
    - "&8{x}, {y}, {z}"
    - "&7{description}"

The loader accepts at most 12 lines and 256 characters per line.

Variables

holograms.lines uses native {...} variables:

Variable Value
{title}, {name} Protection display name.
{owner} Protection owner name.
{user} Optional name of the player viewing the hologram. When used, nearby players receive separate private TextDisplay entities.
{id} Persistent protection ID.
{type}, {type_id} Protection-stone type ID.
{world} Name of the world containing the stone.
{x}, {y}, {z} Protection-stone coordinates.
{stone_x}, {stone_y}, {stone_z} Aliases for the stone coordinates.
{size_x}, {size_y}, {size_z} Inclusive dimensions.
{description} Public profile description.
{visibility} Localized visibility label.
{category} Public-directory category name.
{visits} Public-directory visit count.

These are not PlaceholderAPI %...% identifiers. See PlaceholderAPI for placeholders used by other plugins.

Colors and PlaceholderAPI

Legacy Bukkit codes are supported: &0-&9, &a-&f, &k-&o and &r. For example, "&bCasa" shows “Casa” in aqua. Formatting such as &l (bold) and &o (italic) is also supported.

When PlaceholderAPI is installed and enabled in LederProtections' compatibility settings, hologram lines can also contain tokens such as %player_name%, %vault_prefix% or %lederprotections_version%. When a line includes {user} or a PlaceholderAPI token, nearby viewers receive private displays and PAPI uses that viewer's context. PAPI values refresh when the player changes block or the configuration is reloaded, not every tick. Tokens from unavailable expansions may remain unchanged.

Personal displays are created lazily only for viewers within view-distance. The service checks proximity when a player crosses a block, joins, respawns or a nearby chunk loads; it does not run a repeating scan or force-load chunks. Displays are removed when a viewer leaves range or disconnects.

The default {description} value is the protection's public profile description. It can be blank when no description has been set.

Upgrade note: if an existing custom hologram used {user} to display the protection owner, change it to {owner}. Custom lines are preserved by the configuration updater, so they are not rewritten automatically.

Troubleshooting

  • Confirm holograms.enabled is true.
  • Check the protection's individual hologram state.
  • Confirm the stone block still exists and its chunk is loaded.
  • Run /lep reload, then /lep check.
  • Check configuration-validation warnings in console.

Clone this wiki locally