Skip to main content

📟 HUDs

Overview​

HUDs in Oraxen use glyphs to render custom textures in the action bar. This lets you build bars, counters, icons, and other on-screen overlays. Under the hood, each HUD element is a Unicode character mapped to a texture through Minecraft’s font system. Because fonts can be separated, the same character can show different visuals depending on the selected font, giving you flexible control over how your HUD appears.

Configuration​

HUDs are configured in the hud.yml file in the plugins/Oraxen/ directory.

  • 📁 plugins
    • 📁 Oraxen
      • 📄 hud.yml

Properties​

permission - The permissions required to use this HUD. Defaults to none.
display_text - The text to display for this HUD. A HUD without it is skipped with a warning.
disabled_whilst_in_water - Whether the HUD is disabled whilst in water. Defaults to false.
enabled_by_default - Whether the HUD is enabled by default. Defaults to false.
enable_for_spectator_mode - Whether this HUD appears for spectators. Defaults to false.

warning

Oraxen's HUD system is not complex or advanced. For more advanced HUDs, consider using a third-party plugin such as MythicHUD.

Positioning & Fonts​

You can fine-tune HUD placement using <shift> and <font> in display_text.

  • <shift:-10> moves elements 10 pixels left
  • <shift:10> moves elements 10 pixels right

<shift> works everywhere Oraxen parses MiniMessage and is useful for lining up text, icons, and bars precisely.

<font:...> lets you render normal text/placeholders with a custom font file, similar to glyph rendering. This is especially useful for vertical alignment (moving text up/down) using the font's ascent value.

For example, if you use <font:balance_hud>, that font can define a negative ascent so text appears higher on screen (common for action bar style HUDs), then switch back with <font:default>.

{
  "providers": [
    {
      "type": "bitmap",
      "file": "minecraft:required/ascii_offset.png",
      "ascent": -13,
      "height": 8,
      "chars": [
        "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000",
        "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000",
        "\u0020\u0021\u0022\u0023\u0024\u0025\u0026\u0027\u0028\u0029\u002a\u002b\u002c\u002d\u002e\u002f"
      ]
    }
  ]
}

Like glyph offsets, changing ascent adjusts the Y-position of rendered text in that font.

Example​

note

If you want to disable custom HUD updates entirely, set update_time_in_ticks to 0.

update_time_in_ticks: 40
huds:
  balance:
    permission: "oraxen.hud.balance"
    display_text: "<shift:100><font:balance_hud>%vault_eco_balance%<font:default><glyph:coin>"
    disabled_whilst_in_water: true
    enabled_by_default: true
    enable_for_spectator_mode: true