Better Compass Changelog

Theme Commands

/bettercompass theme list

Displays all available themes with a marker (§a▶) for the active theme.

/bettercompass theme set <theme_name>

Changes the current theme. Supports Tab auto-completion.

/bettercompass theme reload

Reloads all themes from files (useful for developers).

/bettercompass theme current

Displays the currently active theme with all its settings.

Client Configuration

File: config/bettercompass/compass.toml

requireCompass = false
currentTheme = "default"

• requireCompass: If true, the HUD only appears if the player has a compass
• currentTheme: The selected theme (default, compact, colorful, immersive)

Server Configuration

File: server_config.toml

# If true, forces all clients to use the specified theme
serverForceTheme = false

# Theme to force on all clients (ignored if serverForceTheme = false)
serverTheme = "default"

# Compass configuration
requireCompass = "client"

• serverForceTheme: Enables server-side theme forcing
• serverTheme: Theme to enforce on all players
• requireCompass: "client" (client decides), "true" (required), "false" (optional)

Theme System

Themes are stored in config/bettercompass/themes/ in TOML format.

Complete Example: "Custom" Theme

File: config/bettercompass/themes/custom.toml

# General colors (ARGB format: 0xAARRGGBB)
primaryColor = 0xFFFFFF00
secondaryColor = 0xFF00FF00
backgroundColor = 0x80000000
textColor = 0xFFFFFFFF
borderColor = 0xFFFF8800

# Dimensions and spacing
compassSize = 100
textScale = 1.0
padding = 5
borderWidth = 2

# Positions (x, y offsets from edges)
compassX = 10
compassY = 10

# Coordinates display
showCoordinates = true
coordinatesX = 10
coordinatesY = 30
coordinatesScale = 0.8

# Dimension display
showDimension = true
dimensionX = 10
dimensionY = 50
dimensionScale = 0.8

# Biome display
showBiome = true
biomeX = 10
biomeY = 70
biomeScale = 0.8

# Animation
enableSmoothRotation = true
rotationSpeed = 0.1

# Theme metadata
themeName = "Custom"
themeAuthor = "Player"
themeDescription = "A custom theme for Better Compass"

Field Explanations

Supported Color Formats

• ARGB (recommended): 0xAARRGGBB e.g. 0xFF00FF00 (opaque green)
• Short hex: #RRGGBB e.g. #00FF00
• RGB: rgb(255, 0, 0) (red)
• RGBA: rgba(255, 0, 0, 128) (semi-transparent red)

Default Themes

4 themes are included:

1. default - Balanced standard theme
2. compact - Reduced version for small screens
3. colorful - Vibrant and attractive colors
4. immersive - Clean and subtle design

Summary of Additions

✅ Theme commands - /bettercompass theme <list|set|reload|current>
✅ Simplified client config - Only requireCompass and currentTheme
✅ Server config - serverForceTheme and serverTheme to control clients
✅ Complete theme system - 50+ customizable parameters per theme
✅ 4 default themes - Automatically included in the mod
✅ Auto-completion - Tab-completion for theme names