Configuration

Main Configuration (config.yaml)

General Settings

enabled: true
tick-speed: 2
update-interval-ticks: 20
background-opacity: 0.6
panel-spacing: 5
disabled-worlds: []

Option	Type	Default	Description
`enabled`	Boolean	`true`	Master switch for the HUD system
`tick-speed`	Integer	`2`	Scheduler period in ticks for HUD updates
`update-interval-ticks`	Integer	`20`	Default refresh interval for element content (`-1` on elements uses this)
`background-opacity`	Double	`0.6`	Opacity of panel backgrounds (0.0–1.0)
`panel-spacing`	Integer	`5`	Vertical spacing between panels that share the same anchor
`disabled-worlds`	List	`[]`	World names where the HUD is not shown

Resource Pack

resource-pack:
  mode: auto
  public-url: ""
  bind-host: "0.0.0.0"
  port: 8163
  public-host: ""
  pack-format: 34
  folder-path: ""
  folder-file-name: "minehud.zip"
  required: false

Option	Type	Default	Description
`mode`	String	`"auto"`	Pack backend: `auto`, `standalone`, `nexo`, `folder`, `external`
`public-url`	String	`""`	Public download URL; empty = auto (standalone) or host-managed (Nexo)
`bind-host`	String	`"0.0.0.0"`	HTTP bind address for standalone hosting
`port`	Integer	`8163`	HTTP port for standalone hosting
`public-host`	String	`""`	Hostname/IP players use to download the pack; empty = server IP or localhost
`pack-format`	Integer	`34`	`pack.mcmeta` format for standalone/folder packs (34 = 1.21.x)
`folder-path`	String	`""`	Target directory for `folder` mode (e.g. Oraxen external packs)
`folder-file-name`	String	`"minehud.zip"`	Output zip name for `folder` mode
`required`	Boolean	`false`	Force clients to accept the pack (standalone dispatch only)

See Resource Pack for backend details.

Editor Bridge

editor-bridge:
  enabled: true
  editor-base-url: "https://hud.mncd.pl"
  api-base-url: "https://hud.mncd.pl/api"
  ws-base-url: "wss://hud.mncd.pl/api"
  timeout-seconds: 15

Option	Type	Default	Description
`enabled`	Boolean	`true`	Enable `/minehud editor` sessions
`editor-base-url`	String	`"https://hud.mncd.pl"`	Browser UI base URL (no trailing slash)
`api-base-url`	String	`"https://hud.mncd.pl/api"`	Relay HTTP API base URL
`ws-base-url`	String	`"wss://hud.mncd.pl/api"`	Relay WebSocket base URL
`timeout-seconds`	Integer	`15`	HTTP timeout for session create/upload

See Online Editor for local and production setups.

Glyph Heights

Optional height overrides for Nexo glyphs used in HUD content (<glyph:id>):

glyph-heights:
  example_emoji: 10

If omitted, glyphs use the default rendered height.

HUDs

HUD layouts live under the huds map. Each key is a HUD id:

huds:
  main:
    permission: ""
    condition: null
    panels:
      top-bar:
        anchor: TOP
        layout: ROW
        offset-x: 0
        offset-y: 5
        # ...

Option	Type	Default	Description
`permission`	String	`""`	Permission required to see this HUD (empty = everyone)
`condition`	Object / null	`null`	Optional visibility condition (see Panels & Layout)
`panels`	Map	—	Named panels that make up the HUD

Default generated layout includes a main HUD with a top bar and a right sidebar. Full panel, line, and element options are documented in Panels & Layout.

Example default panels

huds:
  main:
    permission: ""
    condition: null
    panels:
      top-bar:
        anchor: TOP
        layout: ROW
        offset-x: 0
        offset-y: 5
        layer: 0
        opacity: 1.0
        background: true
        padding: 4
        padding-y: 0
        gap: 3
        align: center
        line-spacing: 13
        permission: ""
        condition: null
        lines:
          info:
            content: ""
            elements:
              player:
                content: "<font:small><white>%player_name% <gray>%player_ping%<dark_gray>ms</font>"
              server:
                content: "<font:small><white>%server_online%<dark_gray>/<gray>%server_max_players% <green>%server_tps_1% <gray>TPS</font>"
              coords:
                content: "<font:small><gray>%player_x% %player_y% %player_z%</font>"
      sidebar:
        anchor: RIGHT
        layout: COLUMN
        offset-x: -5
        offset-y: 0
        background: true
        gap: 0
        align: right
        lines:
          health:
            content: "<font:small><red>HP <white>%player_health%<dark_gray>/<gray>%player_max_health%</font>"
          hunger:
            content: "<font:small><gold>FOOD <white>%player_food_level%<dark_gray>/<gray>20</font>"
          balance:
            content: "<font:small><yellow>$ <white>%vault_eco_balance_formatted%</font>"
          xp:
            content: "<font:small><green>LVL <white>%player_level%</font>"
          world:
            content: "<font:small><aqua>%player_world%</font>"

Language (language.yaml)

All messages use MiniMessage. Placeholders:

Placeholder	Used in
`{url}`	Editor link message
`{error}`	Editor open failure message

hud-enabled: "<green>HUD został włączony."
hud-disabled: "<red>HUD został wyłączony."
config-reloaded: "<green>Konfiguracja HUD została przeładowana."
soft-reload-success: "<green>HUD przeładowany bez regeneracji resource packa."
soft-reload-pack-change-required: "<yellow>Zmiany wymagają regeneracji resource packa. Użyj /minehud reload."
soft-reload-no-baseline: "<red>Brak wygenerowanego resource packa jako punktu odniesienia. Użyj /minehud reload."
editor-disabled: "<red>Edytor online jest wyłączony (editor-bridge.enabled=false)."
editor-opening: "<gray>Tworzenie sesji edytora mineHud…"
editor-link: "<green>Edytor mineHud: <click:open_url:'{url}'><underlined><aqua>{url}</aqua></underlined></click>"
editor-hint: "<gray>Otwórz link (hostowane przez mineCodes), edytuj i kliknij <white>Zapisz na serwerze</white>."
editor-open-failed: "<red>Nie udało się otworzyć edytora: <white>{error}</white>"

Key	Description
`hud-enabled`	Sent after enabling HUD with `/minehud toggle`
`hud-disabled`	Sent after disabling HUD with `/minehud toggle`
`config-reloaded`	Sent after `/minehud reload`
`soft-reload-success`	Soft reload completed without pack regen
`soft-reload-pack-change-required`	Soft reload refused — full reload required
`soft-reload-no-baseline`	Soft reload refused — no pack baseline yet
`editor-disabled`	Editor bridge is off
`editor-opening`	Session creation started
`editor-link`	Clickable editor URL (`{url}`)
`editor-hint`	Hint after the editor link
`editor-open-failed`	Session creation failed (`{error}`)

Text Formatting

HUD content supports:

MiniMessage color and style tags (<red>, <white>, <bold>, …)
<font:small>...</font> — compact HUD font (recommended for dense panels)
PlaceholderAPI — %player_name%, %vault_eco_balance_formatted%, etc.
Nexo glyphs — <glyph:glyph_id> when using the Nexo backend

Tip: Prefer wrapping status lines in <font:small> for a cleaner boss-bar look and correct background metrics.