# Hero nameplates (hud.nameplates)

## What it is for

Draws hero nameplates above characters in a lane game: name, level badge, segmented health bar and a separate mana bar, at a constant screen size and with no image assets.

It needs `moba.match`, `moba.controls`, `combat.health`, `game.engine`; installing it brings them in.

## Turn it on

Install the kit in a project, then change a setting (the values shown are its defaults):

```text
gripforge_gamekit_install   { project_id: "gkp_…", id: "hud.nameplates" }
gripforge_gamekit_configure { project_id: "gkp_…", id: "hud.nameplates",
                              config: { "avoidOverlap": true, "maxShift": 150 } }
```

## First example

The kit has no dedicated test yet; this installs it and sets two of its settings to their defaults.

```text
gripforge_gamekit_install   { project_id: "gkp_…", id: "hud.nameplates" }
gripforge_gamekit_configure { project_id: "gkp_…", id: "hud.nameplates",
                              config: { "avoidOverlap": true, "maxShift": 150 } }
```

## Settings and defaults

Descriptions come from the kit manifest and stay in English.

| Setting | Type | Default | Range or values | Meaning |
|---|---|---|---|---|
| `avoidOverlap` | boolean | `true` |  | Separate projected hero bars in screen space; retain a leader to the real anchor. |
| `maxShift` | integer | `150` | 0–300 | Maximum upward bar displacement in CSS pixels. |
| `visible` | boolean | `true` |  | Show the overhead hero plates. |
| `showName` | boolean | `true` |  | Show the champion name or player handle above the bars. |
| `showMana` | boolean | `true` |  | Show a separate mana bar below health. |
| `showLevel` | boolean | `true` |  | Show the current level in a badge to the left. |
| `width` | integer | `160` | 100–240 | Plate width in CSS pixels, independent of camera distance. |
| `healthTicks` | integer | `8` | 0–20 | Health segments (0 disables separators). |
| `offsetY` | number | `0.45` | 0–3 | World-space vertical offset above the hero’s height. |
| `playerName` | string | `""` |  | Local player handle; empty uses the champion name. |
| `allyColor` | string | `"#54c86a"` |  | Allied health fill. |
| `enemyColor` | string | `"#e0504c"` |  | Enemy health fill. |
| `playerColor` | string | `"#54c86a"` |  | Local player health fill. |
| `manaColor` | string | `"#329eea"` |  | Mana fill. |

## Services, events, variables

- Service `hud.nameplates`: snapshot of visible hero names, levels, health and mana; setName for per-player handles.

## Hooks and modding

- Moddable settings: `avoidOverlap`, `maxShift`, `visible`, `showName`, `showMana`, `showLevel`, `width`, `healthTicks`, `offsetY`, `allyColor`, `enemyColor`, `playerColor`, `manaColor`

## Engines

Declared targets: `web`, `rust`. `gripforge kit api hud.nameplates` lists the exact settings and services of your version.

## Versions

Kit version 1.2.0.