HUD Display
GroupManager shows real-time group information on the player's screen.
Native Multi-HUD
The group HUD uses Hytale's native multi-HUD support (server 0.7+). Each HUD is registered under its own key and the client keeps them side by side: the group HUD is registered under the key GroupHud, so it coexists with the HUDs of other plugins without replacing them.
The HUD works out of the box — no HUD plugin is required. See HUD Compatibility for notes on third-party HUD mods.
What the HUD Shows
The group HUD panel displays:
- Group leader name (highlighted)
- All group member names with optional prefix/suffix set by external plugins
- Online/offline status indicators
- Health bars for each member (via
GroupHealthTracker)
The HUD updates in real-time as members join, leave, connect, or disconnect.
HUD Name Customization
External plugins can customize what appears next to each player's name via the prefix/suffix API:
GroupService api = GroupManagerProvider.get();
api.setHudPrefix(playerUuid, "[Lv.5] "); // Before the name
api.setHudSuffix(playerUuid, " [Warrior]"); // After the name
// HUD shows: "[Lv.5] Steve [Warrior] - Leader"
This is useful for RPG plugins (levels, classes, races), rank plugins, or any system that wants to display extra information alongside player names in the group HUD.
See the GroupService API reference for full details.
HUD Position Customization
Players can reposition the group HUD on their screen using the /group hud command, which opens a settings UI with two sliders:
- Horizontal Offset (X): Moves the HUD left or right (range: -2000 to 2000).
- Vertical Offset (Y): Moves the HUD up or down (range: -2000 to 2000).
A Reset button restores the default position (0, 0).
Position preferences are saved per-player and persist across sessions. See Player Preferences for storage details.
The default HUD position places two panels on the right side of the screen. Use negative X values to move the HUD towards the center, and positive Y values to move it down.
HUD Lifecycle
- Created when a player joins a group.
- Updated periodically and on group events (member join/leave, health changes).
- Removed when the player leaves their group.
- Paused/Resumed by external plugins via the API (e.g., during gameplay activities).
- Repositioned when the player changes offset values via
/group hud(triggers a full HUD rebuild).
Pausing the HUD
External plugins can pause and resume the group HUD:
GroupService api = GroupManagerProvider.get();
api.pauseHud(playerUuid); // Hide during activity
api.resumeHud(playerUuid); // Restore after activity
pauseHud()always hides the player's group HUD.resumeHud()recreates the group HUD if the player is in a group, following the same rules as normal display (e.g., theShowHudWhenAlonesetting).
Both calls are always safe — no detection code is needed. Since HUDs coexist natively, pausing is only needed when the group HUD should be hidden during an activity (e.g., during a match).
See the HUD Compatibility page for full examples.