Skip to main content
Compass elements show directional indicators and waypoint markers. They’re configured in YAML files in the compasses/ directory.

​
File Structure

Compass configuration files are located at:
  • plugins/BetterHud/compasses/

​
Basic Compass Structure

default_compass.yml
default_compass:
  type: circle
  default: true
  file:
    n:
      name: "compass/n.png"
    s:
      name: "compass/s.png"
    e:
      name: "compass/e.png"
    w:
      name: "compass/w.png"
    point:
      name: "compass/point.png"
      y: -8
  scale: 0.75
  scale-equation: 1 - t/20
  length: 20
  space: 2
  gui:
    x: 50
    y: 0
  pixel:
    x: 0
    y: 20
  apply-opacity: true

​
Configuration Options

​
type
string
required
Compass display type: circle or bar
​
default
boolean
default:"false"
Show this compass to all players by default
​
file
object
required
Direction indicator images:
  • n, s, e, w: Cardinal directions
  • ne, nw, se, sw: Diagonal directions
  • point: Waypoint marker icon
  • chain: Connection line (for bar type)
​
scale
number
default:"1.0"
Size multiplier for all compass elements
​
scale-equation
string
Dynamic scale equation based on distance
​
length
integer
Number of markers to display
​
space
integer
Spacing between markers in pixels
​
gui
object
required
GUI position (percentage based)
​
pixel
object
Pixel offset from GUI position
​
apply-opacity
boolean
default:"false"
Apply distance-based opacity

​
Examples

​
Circle Compass

circle-compass.yml
circle_compass:
  type: circle
  file:
    n:
      name: "compass/north.png"
    s:
      name: "compass/south.png"
    e:
      name: "compass/east.png"
    w:
      name: "compass/west.png"
    point:
      name: "compass/marker.png"
  scale: 1.0
  gui:
    x: 50
    y: 10

​
Bar Compass

bar-compass.yml
bar_compass:
  type: bar
  length: 30
  space: 3
  file:
    point:
      name: "compass/point.png"
    chain:
      name: "compass/chain.png"
  gui:
    x: 50
    y: 5

​
See Also

Compass Concepts

Learn about compass architecture

Images

Configure image elements

API Usage

Add waypoints programmatically

Animations

Animate compass elements

Build docs developers (and LLMs) love

Get started for freeTalk to us