Skip to main content
This documentation is for NameplateBuilder v4.260326.2 with API v2.0.0.

​
Requirements

  • Java 25
  • Hytale Server build-7 or later
  • Gradle 9.2+ (only if building from source)

​
Installing the Server Plugin

  1. Download the NameplateBuilder server plugin JAR from CurseForge
  2. Place the JAR in your server’s UserData/Mods folder
  3. Start the server - NameplateBuilder will generate its config files automatically
  4. Players can now use /npb to open the customization UI
That’s it. Built-in segments (Player Name, Health, Stamina, Mana) are available immediately.

​
For Mod Developers

If you’re building a mod that integrates with NameplateBuilder, you also need the API jar:
  1. Download the NameplateBuilder API jar from CurseForge
  2. Place it in your mod project’s libs/ folder
  3. Add it as a compileOnly dependency in your build.gradle:
dependencies {
    compileOnly files('libs/NameplateBuilder-API-2.0.0.jar')
}
The -javadoc.jar and -sources.jar are available as additional downloads. Place all three in your libs/ folder for full IDE support (autocomplete, inline docs, click-to-source).
  1. Add the manifest dependency so NameplateBuilder loads first:
{
  "Dependencies": {
    "Frotty27:NameplateBuilder": ">=4.260326.2"
  }
}
See the Modding Quick Start for a complete integration walkthrough.

​
Building from Source

git clone https://github.com/TimShol/hytale-nameplate-builder.git
cd hytale-nameplate-builder
./gradlew build
This compiles all three modules (nameplate-api, nameplate-server, nameplate-example-mod), packages shadow JARs, and deploys them to your Hytale UserData/Mods folder. To build individual modules: 
./gradlew :nameplate-api:build
./gradlew :nameplate-server:build
./gradlew :nameplate-example-mod:build