Integrations
On this page10 sections
Every integration is optional and detected at startup; the console line
Enabled with ... hooks: PlaceholderAPI, LuckPerms, Floodgate, MiniPlaceholders shows which ones
are active, and so does /nametag debug.
PlaceholderAPI
Install PlaceholderAPI (opens in a new tab) and any %placeholder% works
in nametag lines and show-if conditions. AdvancedNametags also registers its own expansion,
%advancednametags_...% (badge, template, lines, preferences), for TAB and other plugins: the full
list is in placeholders.
Values that players can type (nicknames, clan names) keep their colours but cannot draw badges or
images unless the placeholder is in placeholders.trusted
(why). placeholders.replacements turns raw values into
something nicer (yes → [AFK]).
MiniPlaceholders
With MiniPlaceholders (opens in a new tab), <advancednametags_badge>,
<advancednametags_badge:<id>> and <advancednametags_badges> return the real badge component,
usable by any plugin that supports MiniPlaceholders (chat, scoreboards, menus). MiniPlaceholders
tags of other plugins also work in nametag lines.
TAB
Works out of the box. AdvancedNametags hides vanilla nametags by rewriting team packets, so TAB's prefixes, colours and tab-list sorting keep working. To show badges in the tab list:
# plugins/TAB/groups.yml
_DEFAULT_:
tabprefix: "%advancednametags_badge% "TAB's nametag prefixes and suffixes (scoreboard-teams) belong to the vanilla nametag, which
AdvancedNametags hides; keep the feature on if you use it for tab-list sorting.
LuckPerms
Optional, recommended. Templates can be given by group (groups: [vip]); the plugin checks the
permission group.<name>, which LuckPerms grants for inherited groups too. With LuckPerms, every
permission or group change (including temporary ranks expiring) re-applies the player's template
instantly. Without it, other permission plugins work as long as they grant group.<name> (or use
permission:), and templates are re-checked every updates.permission-check-ticks (5 seconds).
%luckperms_prefix% and %luckperms_suffix% are trusted by default, so a prefix like
<badge:vip> or &c[Admin] draws as intended.
ViaVersion and Bedrock
- Players on versions older than 1.21.9 (through ViaVersion) see a text version of badges
(
fallback) and icons (coloured symbols); faces and sprites are left out. Menus need 1.21.6+; older clients use the commands. - Bedrock players cannot draw display entities. With Floodgate installed they are detected and
keep the vanilla nametag (
compatibility.bedrock-viewers: vanilla, the default); withdisplaysthey are treated like Java players. Without Floodgate, Bedrock players cannot be told apart from Java players.
Vanish, skins, NPCs, disguises
No integration needed: nametags are spawned and removed together with the player entity for each
viewer, so anything that hides or replaces a player (vanish, NPC and skin plugins, world changes)
is followed automatically. <face> follows skin plugins too.
Custom items and hats
- Item rows accept custom item models:
item: "model:nexo:crown"(Nexo, Oraxen, ItemsAdder). - Tall hats:
compatibility.helmet-offsetsraises the nametag for specific helmets, by item model or material:
compatibility:
helmet-offsets:
'nexo:crown': 0.25
'minecraft:carved_pumpkin': 0.05- Resource-pack glyphs work in any line.
MySQL and MariaDB
Player customisations (badge choice, forced templates, custom lines, view preferences...) are stored per player; only players with a customisation are stored. For networks, share them through a database:
storage:
type: mysql # or mariadb; both use the MariaDB driver
sql:
host: db.example.net
port: 3306
database: minecraft
username: nametags
password: 'change-me'
table-prefix: an_
pool-size: 4
sync-interval: 5 # seconds; picks up edits made on other servers
properties:
sslMode: verify-full- The server downloads the driver and connection pool (HikariCP, MariaDB Connector/J) on the first start, so it needs internet access once.
- The tables
<prefix>profilesand<prefix>metaare created by themselves; the database must exist. - The storage changes on a restart only. Then
/nametag import yamlshows how many players are stored indata/players/, and/nametag import yaml confirmcopies them into the database (they replace what the database has for them; the YAML files are kept). - If the database cannot be reached at startup the plugin falls back to YAML storage and says so in the console.
- Every
sync-intervalseconds each server reads the profiles other servers changed, so an admin's/nametag seton the lobby shows up on the server where the player is.0turns it off. - Templates, badges and animations are files: copy them to every server (or share the folder).
UnlimitedNametags
/nametag import unt converts your UnlimitedNametags configuration into templates, with a preview,
a backup and a report of anything without an exact equivalent. See
migrating from UnlimitedNametags.
Java API
Other plugins can hide nametags, play reactions, read the template, pick badges and add text effects. See the developer API.