# KS Nameplates

# KS Nameplates

**KS Nameplates** is a fully-featured nameplate and tag system for Hytale servers. Players can unlock and display tags/badges above their heads and as chat prefixes. Admins can create, manage and assign tags through an in-game UI or commands.

**Main Command:** `/ksnameplate` (aliases: `/nameplate`, `/np`, `/tag`, `/tags`)

## Features at a Glance

- **Tag System** — Define tags with display text, color, permission and priority
- **Tag Types** — PREFIX (before name), SUFFIX (after name), ABOVE (on separate line)
- **Tag Groups** — Group tags together with optional exclusive selection (e.g., only one rank active)
- **Nameplate Display** — Tags shown above player heads (plain text, configurable format)
- **Chat Formatting** — Colored tag prefixes in chat messages via Message API
- **Image Tags** — PNG badges for visual tags (shown in UI preview)
- **Player UI** — Browse available tags, toggle active/inactive, live preview
- **Admin UI** — Create, edit and delete tags via in-game panel
- **Permissions** — Per-tag permission nodes, default-active tags
- **Persistence** — SQLite database for player tag selections
- **API** — Cross-mod integration via `NameplatesAPI`
- **Localization** — English and German included

## Quick Start

1. Install `KyuubiSoftNameplates.jar` in your server's `mods/` folder
2. Start the server — default tags and config are auto-generated
3. Players open the tag browser with `/ksnameplate open` or `/np open`
4. Admins manage tags with `/ksnameplate admin panel` (needs `ks.nameplate.admin` and `kyuubisoft.nameplates.admin`)

Nameplates work for players in every world, not only the default world (fixed in 1.2.2).

## Default Tags

The mod ships with example tags:

| Tag | Display | Color | Group | Permission |
|-----|---------|-------|-------|------------|
| Owner | `[Owner]` | Red | Ranks | `nameplates.tag.owner` |
| Admin | `[Admin]` | Red | Ranks | `nameplates.tag.admin` |
| Mod | `[Mod]` | Cyan | Ranks | `nameplates.tag.mod` |
| VIP | `[VIP]` | Gold | Ranks | `nameplates.tag.vip` |
| Builder | `★` | Green | Badges | `nameplates.tag.builder` |

## Limitations

- **Nameplate text is plain text only** — Hytale does not support colors in the Nameplate component. Colored tags are only visible in chat.
- **Image tags** are shown as their display text in the nameplate. The image is visible in the Tag Browser UI.

## Requirements

- Hytale Server 0.7.x (version 1.2.2 is built against 0.7.0)
- Java 25