Apollo
Developers
Mods
DirectionHud

Direction HUD

Display your cardinal direction on the HUD.

Integration

How to toggle the mod

public void toggleDirectionHUDExample(Player viewer, boolean value) {
    Optional<ApolloPlayer> apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId());
    apolloPlayerOpt.ifPresent(apolloPlayer -> this.modSettingModule.getOptions().set(apolloPlayer, ModDirectionHud.ENABLED, value));
}

Available options

  • ENABLED

    • Config Key: enabled
    • Values
      • Type: Boolean
      • Default: true
  • SCALE

    • Config Key: scale
    • Values
      • Type: Float
      • Default: 1.0F
      • Minimum: 0.5F
      • Maximum: 1.5F
  • WIDTH

    • Config Key: width
    • Values
      • Type: Float
      • Default: 280.0F
      • Minimum: 168.0F
      • Maximum: 448.0F
  • TEXT_SHADOW

    • Config Key: text-shadow
    • Values
      • Type: Boolean
      • Default: false
  • BOLD_DIRECTIONS

    • Show the cardinal directions in BOLD.
    • Config Key: bold-directions
    • Values
      • Type: Boolean
      • Default: false
  • BACKGROUND

    • Config Key: background
    • Values
      • Type: Boolean
      • Default: false
  • BORDER

    • Config Key: border
    • Values
      • Type: Boolean
      • Default: false
  • BORDER_THICKNESS

    • Config Key: border-thickness
    • Values
      • Type: Float
      • Default: 0.5F
      • Minimum: 0.5F
      • Maximum: 3.0F
  • USE_LEGACY_STYLE

    • Config Key: use-legacy-style
    • Values
      • Type: Boolean
      • Default: false
  • SHOW_MARKER

    • Config Key: show-marker
    • Values
      • Type: Boolean
      • Default: true
  • SHOW_MARKER_VALUE

    • Config Key: show-marker-value
    • Values
      • Type: Boolean
      • Default: true
  • BACKGROUND_COLOR

    • Config Key: background-color
    • Values
      • Type: String
      • Default: #6F000000
  • BORDER_COLOR

    • Config Key: border-color
    • Values
      • Type: String
      • Default: #9F000000
  • MARKER_COLOR

    • Config Key: marker-color
    • Values
      • Type: String
      • Default: #FFFFFFFF
  • DIRECTION_COLOR

    • Config Key: direction-color
    • Values
      • Type: String
      • Default: #FFFFFFFF