Skip to main content
HUDs are persistent UI elements that stay on screen. They’re configured in YAML files in the huds/ directory.

​
File Structure

HUD configuration files are located at:
  • plugins/BetterHud/huds/
Each file can contain multiple HUD definitions.

​
Basic HUD Structure

default-hud.yml
test_hud:
  layouts:
    1:
      name: health
      gui:
        x: 35
        y: 100
      pixel:
        x: 0
        y: -80
    2:
      name: hunger
      gui:
        x: 65
        y: 100
      pixel:
        x: 0
        y: -80

​
Configuration Options

​
HUD Properties

​
layouts
object
required
Map of layout components that make up the HUD
​
conditions
object
Conditional display logic for the HUD
​
triggers
object
Events that update the HUD

​
Layout Properties

​
name
string
required
Name of the layout to display
​
gui
object
required
GUI coordinate position (percentage based)
  • x: Horizontal position (0-100)
  • y: Vertical position (0-100)
​
pixel
object
Pixel offset from GUI position
  • x: Horizontal pixel offset
  • y: Vertical pixel offset

​
Examples

​
Health and Hunger HUD

health-hud.yml
health_hud:
  layouts:
    1:
      name: health
      gui:
        x: 35
        y: 100
      pixel:
        x: 0
        y: -80

​
Conditional HUD

conditional-hud.yml
combat_hud:
  conditions:
    - "%player_in_combat% = true"
  layouts:
    1:
      name: combat_indicator
      gui:
        x: 50
        y: 50

​
See Also

Layouts

Configure layout components

Images

Configure image elements

HUD Concepts

Learn about HUD architecture

Conditions

Configure conditional display

Build docs developers (and LLMs) love

Get started for freeTalk to us