Installation
Follow this guide to install CustomPlayerNametags.
1. Install dependencies
Download the following plugins and move them into /plugins:
| Plugin | Why |
|---|---|
| PacketEvents required | It allows the plugin to hide vanilla nametags and control them individually for each viewer by sending raw team packets directly to clients, something Bukkit's Scoreboard API cannot do. |
| PlaceholderAPI strongly advised | Allows parsing placeholders in nametag formats. Without it, only individual player formats work and %placeholder% values are not resolved. |
| LuckPerms optional | Enables creating group formats for LuckPerms groups. |
2. Add the plugin
- Download
CustomPlayerNametags. - Place it in your server's
/pluginsfolder, alongside PacketEvents and PlaceholderAPI. - Start the server.
3. Verify it loaded
On startup, check your console for:
[CustomPlayerNametags] CustomPlayerNametags enabled.If instead you see the server refuse to load the plugin, make sure the latest version of PacketEvents is installed. If it still doesn't work, see Troubleshooting.
Files the plugin creates
Everything is kept in plugins/CustomPlayerNametags/. config.yml is the only file you normally edit; the rest of the plugin's data lives in a storage folder.
| File | Purpose |
|---|---|
config.yml | All settings, including the global and Bedrock global formats. See Configuration. |
storage/player-formats.db | Individual player formats set by admins. |
storage/player-widget-fills.db | What players have typed into widgets. |
storage/nametag-toggles.db | Which players have hidden other players' nametags. |
storage/group-formats.yml | LuckPerms group formats. |
storage/editor-placeholders.yml | Placeholders offered in the nametag editor. Manage them with /nametags editor placeholders. |
storage/messages.yml, storage/gui.yml | Plugin messages and menu layouts. Reset to their defaults on every server start, so don't edit them. |
storage/install-info.yml | Internal file used for anonymous statistics. |
Anonymous statistics
The plugin reports anonymous usage statistics to bStats. Alongside bStats' standard server information, it only shares which optional plugins are installed and a few setting values, such as the dismount mode and height adjustments. No player names or nametag formats are sent. To opt out, set enabled: false in plugins/bStats/config.yml.