Display Plugin

The Nimbus Display plugin adds clickable server signs and interactive NPCs to lobby and hub servers. Players can click a sign or NPC to join a server, open a server selector inventory, or execute custom commands.

Installation

The display plugin ships inside nimbus-module-display and is auto-deployed to every backend service at runtime via ServiceFactory.resolveModulePlugins() (alongside nimbus-sdk.jar, which it depends on). Templates stay user-owned; the plugin is copied directly into each service's plugins/ directory on every prepare.

FancyNpcs is a soft dependency — it's only pulled in when you actually use NPC features and the display module opts to download it on demand. Plain server-selector sign use doesn't require FancyNpcs.

Commands

The unified command is /ndisplay (alias: /nimbusdisplay).

Signs

NPCs

Global

Creating NPCs

/ndisplay npc set BedWars                         # Villager NPC
/ndisplay npc set BedWars least PLAYER Notch       # Player NPC with skin
/ndisplay npc set BedWars fill ZOMBIE              # Zombie NPC

Entity types: PLAYER, VILLAGER, ZOMBIE, SKELETON, PILLAGER, WANDERING_TRADER, IRON_GOLEM, ALLAY, ARMOR_STAND, and any other living entity type.

For PLAYER type, the optional skin argument sets the player name whose skin to use.

Live-editing NPCs

All properties can be changed live with /ndisplay npc edit. The NPC respawns immediately with new settings and the config is saved.

Click actions

Hologram placeholders

Display config integration

Signs and NPC holograms pull their templates from config/modules/display/<group>.toml. The floating item material is also defined per group:

[display.npc]
display_name = "&b&lBedWars"
subtitle = "&7{players}/{max_players} online &8| &7{state}"
subtitle_offline = "&c✖ Offline"
floating_item = "RED_BED"

[display.npc.status_items]
ONLINE = "LIME_WOOL"
OFFLINE = "GRAY_WOOL"
INGAME = "ORANGE_WOOL"

Server selector inventory

When a player triggers the INVENTORY action, a chest GUI opens showing all services in the target group. Each service is represented by a wool item colored by status (configurable via status_items). Clicking a service connects the player.

Inventory appearance is configurable in the display config:

[display.npc.inventory]
title = "&8» &b&lBedWars Servers"
size = 27
item_name = "&b{name}"
item_lore = ["&7Players: &f{players}/{max_players}", "&7State: &f{state}", "", "&aClick to join!"]

Data storage

NPC and sign configurations are stored in the plugin's config.yml:

npcs:
  bedwars-npc-10-65-5:
    target: BedWars
    strategy: least
    entity_type: PLAYER
    skin: Notch
    look_at_player: true
    left_click: CONNECT
    right_click: INVENTORY
    hologram:
      - "&b&lBedWars"
      - "&7{players}/{max_players} online"
      - "&7{state}"
    floating_item: "true"
    equipment:
      mainhand: DIAMOND_SWORD
      offhand: SHIELD
    burning: false
    pose: null
    location:
      world: world
      x: 10.5
      y: 65.0
      z: 5.5
      yaw: 90.0
      pitch: 0.0

signs:
  bedwars-100-64-200:
    target: BedWars
    strategy: least
    location:
      world: world
      x: 100
      y: 64
      z: 200

Permissions

Compatibility

The Display plugin requires Spigot 1.13+ through the latest Paper and Folia versions. The 1.13 minimum is required because the plugin uses the flattened material system (post-1.13) for block and item resolution.

Feature availability by version

Folia details

On Folia, all block and entity operations are region-aware:

• Sign updates — Each sign is updated on the region thread that owns its block location
• NPC spawning — ArmorStand holograms, floating items, and FancyNpc entities are spawned on the correct region thread
• NPC updates — Hologram text updates are dispatched per-NPC to the correct region
• FancyNpcs — FancyNpcs 2.9.2+ has native Folia support for NPC rendering and interaction

Graceful degradation

On servers where FancyNpcs is not installed (or on Spigot versions below 1.20), the NPC system is silently disabled. Signs continue to work on all versions. The plugin logs a warning on startup if FancyNpcs is missing.

Next steps

• SDK — Backend server plugin API
• Display Config — Customize sign + NPC appearance
• Server Groups — Group configuration