Skip to main content
Images are visual elements displayed in HUDs, popups, and compasses. They’re configured in YAML files in the images/ directory.

​
File Structure

Image configuration files are located at:
  • plugins/BetterHud/images/
Image files themselves go in:
  • plugins/BetterHud/assets/

​
Image Types

BetterHud supports three image types:

Single

Static single image

Listener

Dynamic image that responds to data

Sequence

Animated PNG sequence

​
Single Image

Static images that don’t change. 
health_empty:
  type: single
  file: health_empty.png
​
type
string
required
Must be single
​
file
string
required
Path to the image file in the assets directory

​
Listener Image

Images that display based on dynamic values (health, hunger, etc.). 
health_bar:
  type: listener
  file: health_bar.png
  split: 25
  split-type: left
  setting:
    listener:
      class: health
​
type
string
required
Must be listener
​
file
string
required
Path to the image file
​
split
integer
required
Number of frames in the image strip
​
split-type
string
required
Split direction: left, right, up, down
​
setting.listener.class
string
required
Data source: health, food, armor, air, absorption, etc.

​
Sequence Image

Animated images using PNG sequences. 
animated_effect:
  type: sequence
  file: effect/frame_%d.png
  count: 10
  duration: 20
​
type
string
required
Must be sequence
​
file
string
required
File pattern with %d placeholder for frame number
​
count
integer
required
Number of frames in the sequence
​
duration
integer
required
Animation duration in ticks

​
Complete Examples

​
Health System

health-images.yml
health_empty:
  type: single
  file: health_empty.png

health_bar:
  type: listener
  file: health_bar.png
  split: 25
  split-type: left
  setting:
    listener:
      class: health

armor_bar:
  type: listener
  file: armor_bar.png
  split: 25
  split-type: left
  setting:
    listener:
      class: armor

​
Animated Effect

effect-images.yml
levelup_animation:
  type: sequence
  file: effects/levelup_%d.png
  count: 20
  duration: 40

​
See Also

Layouts

Organize images in layouts

Listeners

Learn about listener types

Resource Packs

How images become fonts

Animations

Animate image display

Build docs developers (and LLMs) love

Get started for freeTalk to us