> ## 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.

# Installation

> Get NameplateBuilder running on your Hytale server.

<Info>This documentation is written for **NameplateBuilder >= v4.260326.7** with **API >= v2.2.0**.</Info>

## 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](https://www.curseforge.com/hytale/mods/nameplatebuilder)
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](https://www.curseforge.com/hytale/mods/nameplatebuilder-api)
2. Place it in your mod project's `libs/` folder
3. Add it as a `compileOnly` dependency in your `build.gradle`:

```groovy theme={null}
dependencies {
    compileOnly files('libs/NameplateBuilder-API-2.2.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).

4. Add the manifest dependency so NameplateBuilder loads first:

```json theme={null}
{
  "Dependencies": {
    "Frotty27:NameplateBuilder": ">=4.260326.7"
  }
}
```

See the [Modding Quick Start](/modding/quick-start) for a complete integration walkthrough.

## Building from Source

```bash theme={null}
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:

```bash theme={null}
./gradlew :nameplate-api:build
./gradlew :nameplate-server:build
./gradlew :nameplate-example-mod:build
```