Revela's HUD

Revela's HUD

Revela's HUD is a lightweight, server-side mod that adds a customizable in-game HUD overlay displaying real-time player statistics.
It is designed to be informative without being intrusive, giving players constant access to helpful/informative gameplay data.

The overlay updates live as players play, fight, and move through the world -- no commands or menus required once enabled.

And YES, you can show/hide your coordinates with a simple command!

✨ Features

📈 Live Player Statistics

• Mob kills
• Player kills
• Deaths
• Playtime
• Coordinates

🧩 Configurable HUD Layout

• Fully configurable via hud-config.json
• Choose which lines are shown
• Customize titles and ordering

👁️ Per-Player Visibility Controls

• Players can toggle the entire overlay
• Players can hide or show individual overlay lines (such as coordinates)

⚙️ Server-Side Only

• No client mods required
• Works automatically for all players once installed

🧠 Native Command & Permission System

• Uses Hytale’s built-in command and permission APIs
• Fully compatible with permission management plugins

💾 Autosave Functionality (New in Version 1.4)

• Prevents data loss in the event of an unexpected shutdown

Commands

/overlay

Toggles the overlay on or off for the player.

/overlay on

Enables the overlay.

/overlay off

Disables the overlay.

/overlay coords

Toggles the coordinates line.

/overlay hide coords

Hides the coordinates line.

/overlay show coords

Shows the coordinates line.

Players can use /overlay hide --help or /overlay show --help to see available options in-game.

Permission Nodes

This mod uses explicit permission nodes only (no wildcards).

Base Command

revela.hud.command.overlay

Allows access to /overlay.

Subcommands

revela.hud.command.overlay.toggle
revela.hud.command.overlay.on
revela.hud.command.overlay.off
revela.hud.command.overlay.coords

Hide / Show Controls

revela.hud.command.overlay.hide
revela.hud.command.overlay.hide.coords

revela.hud.command.overlay.show
revela.hud.command.overlay.show.coords

 

Players must have the specific subcommand permission to use it.
Granting only the base permission allows /overlay but not subcommands.

Configuration

The mod generates a hud-config.json file on first startup.

This file allows server owners to:

• Change the overlay title
• Add or remove stat lines
• Reorder display entries
• Control which stats appear

Changes take effect after a server restart.

Notes & Limitations

• The HUD is rendered using Hytale’s Objective-based overlay system
• A numeric column (1/1) is always displayed by the engine and cannot be removed
• This is an engine limitation, not a configuration option

Compatibility

• Designed for multiplayer servers
• Safe to add or remove without corrupting player data
• No client-side installation required

Example configuration:

Default placeholder configuration: