Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nameplatebuilder.frotty27.com/llms.txt

Use this file to discover all available pages before exploring further.

This documentation is written for NameplateBuilder >= v4.260326.7 with API >= v2.2.0.
Open the editor with /npb (aliases: /nameplatebuilder, /nameplateui). The UI features a sidebar on the left with three sections. The current version number is displayed in the title bar. Scrollable areas use gold-tinted scrollbars.
SectionTabDescription
GENERALSettingsMaster enable/disable, NPC look-at toggle, vertical offset, welcome message toggle
NAMEPLATESNPCsSegment chain editor for NPC nameplates
PlayersSegment chain editor for player nameplates
DisabledRead-only view of all admin-disabled segments
ADMINNPCsAdmin NPC chain order editor (Chain / Settings sub-tabs)
PlayersAdmin Player chain order editor (Chain / Settings sub-tabs)
ConfigurationRequired, Disabled, Settings, and Blacklist sub-tabs
The ADMIN section is only visible to players with the nameplatebuilder.admin permission.

How Nameplates Work

Each player has their own segment chain - an ordered list of segments that get composited into the nameplate string. The chain determines what appears above entities and in what order. For example, if a player’s NPC chain is [Health Bar, Guild Tag, Elite Tier] with - separators, entities would show:
42/67 - [Warriors] - [Elite]
Every installed mod can contribute segments. Players pick the ones they want, order them however they like, and choose display formats per segment.

Built-in Segments

NameplateBuilder ships with four built-in segments, shown with a warm-purple tint in the UI:
SegmentVariantsTarget
Player NameName, AnonymizedPlayers
HealthCurrent/Max, Percentage, BarAll
StaminaCurrent/Max, Percentage, BarAll
ManaCurrent/Max, Percentage, BarAll

Empty State

When no segments are enabled, entities display an empty nameplate (no text).