module-text.json

This file contains the display formatting information for all the HUD modules in DirectionHUD.
Modules like direction and tracking have a section for their assets, which can be customized.

Formatting Guidelines

Every module in this file follows the same formatting guidelines.

Getting Module Output

Each module has outputs that should be displayed.

Use %s to retrieve an output.

Module Output: 123, 45, 678
Input: This is the x value: %s
Output: This is the x value: 123

When multiple outputs need to be selected out of order, use the syntax %1$s, where the number corresponds to the original order.

Module Output: 123, 45, 678
Input: This is the z value: %3$s
Output: This is the z value: 678

Selecting a Color

There are currently two color code formats to choose from.

&1 - The player’s selected primary color.
&2 - The player’s selected secondary color.

Example: &1Hello World!
Output: Hello World!

Text Styling

DirectionHUD offers all the vanilla text formatting functionality for the module output.

&b - Makes the text bold.
&i - Makes the text italic.
&s - Makes the text strikethrough.
&u - Makes the text underlined.
&o - Makes the text obfuscated.
&r - Resets all modifiers, excluding the color of the text.

Example: &bHello &iWorld!
Output: Hello World!

Resetting the modifier between the words offers more controls.

Example: &bHello &r&i&uWorld&r!
Output: Hello World!

Default Examples

Here are some formatting examples based on these concepts

Colors: primary, secondary
Module Output: 123, 45, 678

Example: &1&b&uXYZ&2&r: %s %s %s
Output: XYZ123 45 678

Example: &1&b&iXYZ&r&2: %s&1&b-&r&2%s&1&b-&r&2%s
Output: XYZ: 123-45-678

Configuration

Each part of the file and its valid entries are detailed below.

coordinates

Display options for the coordinates module.

xyz

This is the output for when the module is in XYZ mode.

Outputs: x, y, z

xz

This is the output for when the module is in XZ mode.

Outputs: x, z

destination

Display options for the destination module.

xyz

This is the output for when the destination has all coordinates with no name.

Outputs: x, y, z

xy

This is the output for when the destination has no Y level and no name.

Outputs: x, z

name

This is the output for when the destination has a name and ALL coordinates.

Outputs: destination_name, x, y, z

name_xz

This is the output for when the destination has a name but, NO Y coordinate.

Outputs: destination_name, x, z

distance

Display options for the distance module.

number

This is the only output for the distance module.

Outputs: distance

tracking

Display options for the tracking module.

assets

This provides the symbols used for the tracking module.

Simple: the symbols used when the module style is set to simple
Compact: the symbols used when the module style is set to compact
Elevation: the symbols used when tracking elevation is enabled

tracking

This is the output for tracking without elevation.

Outputs: tracking_arrow

elevation_tracking

This is the output for tracking with elevation.

Outputs: tracking_arrow, elevation_arrow

direction

Display options for the direction module.

assets

This provides the assets used for the direction module.

Cardinal: the asset to display for each cardinal direction

facing

This is the only output for the direction module.

Outputs: direction

weather

Display options for the weather module.

weather_single

This is the output for when the weather is clear.

Outputs: weather

weather

This is the output for when the weather is not clear. (e.g., thunderstorms)

Outputs: weather, weather_conditions

time

Display options for the time module.

hour_AM

This is the output for the 12-hour clock, in the AM.

Outputs: time_hour, time_minute

hour_PM

This is the output for the 12-hour clock, in the PM.

Outputs: time_hour, time_minute

hour_24

This is the output for the 24-hour clock.

Outputs: time_hour, time_minute

angle

Display options for the angle module.

yaw

This is the output for the yaw angle.

Outputs: yaw

pitch

This is the output for the pitch angle.

Outputs: pitch

both

This is the output for both angles.

Outputs: yaw, pitch

speed

Display options for the speed module.

xz_speed

This is the output for the 2D speed.

Outputs: speed

xyz_speed

This is the output for the 3D speed.

Outputs: speed

Default File Structure

module-text.json

{
  "version": 1.01,
  "coordinates": {
    "xyz": "&1XYZ: &2%s %s %s",
    "xz": "&1XZ: &2%s %s"
  },
  "destination": {
    "xyz": "&1[&2%s %s %s&1]",
    "xz": "&1[&2%s %s&1]",
    "name": "&1[&2%s&1]",
    "name_xz": "&1[&2%s&1]"
  },
  "distance": {
    "number": "&1[&2%s&1]"
  },
  "tracking": {
    "assets": {
      "simple": {
        "north_east": "-▲▶",
        "north": "-▲-",
        "north_west": "◀▲-",
        "west": "◀--",
        "south_west": "◀▼-",
        "south": "-▼-",
        "south_east": "-▼▶",
        "east": "--▶"
      },
      "compact": {
        "north_east": "⬈",
        "north": "⬆",
        "north_west": "⬉",
        "west": "⬅",
        "south_west": "⬋",
        "south": "⬇",
        "south_east": "⬊",
        "east": "⮕"
      },
      "elevation": {
        "above": "⬆",
        "same": "-",
        "below": "⬇"
      }
    },
    "tracking": "&1&s[&r&2%s&1&s]",
    "elevation_tracking": "&1&s[&r&2%s&1|&2%s&1&s]"
  },
  "direction": {
    "assets": {
      "cardinal": {
        "north_east": "NE",
        "north": "N",
        "north_west": "NW",
        "west": "W",
        "south_west": "SW",
        "south": "S",
        "south_east": "SE",
        "east": "E"
      }
    },
    "facing": "&1%s"
  },
  "weather": {
    "weather_single": "&1%s",
    "weather": "&1%s%s"
  },
  "time": {
    "hour_AM": "&2%s&1:&2%s &1AM",
    "hour_PM": "&2%s&1:&2%s &1PM",
    "hour_24": "&2%s&1:&2%s"
  },
  "angle": {
    "yaw": "&2%s",
    "pitch": "&2%s",
    "both": "&2%s&1/&2%s"
  },
  "speed": {
    "xz_speed": "&2%s &1B/S",
    "xyz_speed": "&2%s &1B/S"
  }
}