Hero nameplates

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.

Source: module-kits:kits/hud_nameplates/usage/en.mdView Markdown source

Also read offline — CLI: grip-forge docs hud-nameplatesMCP tool: gripforge_docs { "topic": "hud-nameplates" }

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):

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.

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.

SettingTypeDefaultRange or valuesMeaning
avoidOverlapbooleantrueSeparate projected hero bars in screen space; retain a leader to the real anchor.
maxShiftinteger1500–300Maximum upward bar displacement in CSS pixels.
visiblebooleantrueShow the overhead hero plates.
showNamebooleantrueShow the champion name or player handle above the bars.
showManabooleantrueShow a separate mana bar below health.
showLevelbooleantrueShow the current level in a badge to the left.
widthinteger160100–240Plate width in CSS pixels, independent of camera distance.
healthTicksinteger80–20Health segments (0 disables separators).
offsetYnumber0.450–3World-space vertical offset above the hero’s height.
playerNamestring""Local player handle; empty uses the champion name.
allyColorstring"#54c86a"Allied health fill.
enemyColorstring"#e0504c"Enemy health fill.
playerColorstring"#54c86a"Local player health fill.
manaColorstring"#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.