Locator Bar

Customize the locator bar’s position, size, and displayed information.

Integration

How to toggle the mod

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

Available options

• ENABLED

  • Config Key: enabled
  • Values
    • Type: Boolean
    • Default: false

• HIDE_LOCATOR_BAR

  • Config Key: hide-locator-bar
  • Values
    • Type: Boolean
    • Default: false

• DETACHED

  • Move and scale the locator bar like a HUD mod instead of keeping it in the hotbar
  • Config Key: detached
  • Values
    • Type: Boolean
    • Default: false

• SCALE

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

• USE_PLAYER_HEADS

  • Draw the head of a player instead of the colored dot
  • Config Key: use-player-heads
  • Values
    • Type: Boolean
    • Default: true

• PLAYER_HEAD_SCALE

  • Config Key: player-head-scale
  • Values
    • Type: Float
    • Default: 1.0F
    • Minimum: 0.5F
    • Maximum: 2.0F

• PLAYER_HEAD_HIGHLIGHT

  • Draw an outline around the head with the dot color
  • Config Key: player-head-highlight
  • Values
    • Type: Boolean
    • Default: true

• LIMIT_HEAD_RANGE

  • Players beyond the range show as the colored dot
  • Config Key: limit-head-range
  • Values
    • Type: Boolean
    • Default: false

• PLAYER_HEAD_DISPLAY_RANGE

  • The maximum distance in blocks at which player heads show
  • Config Key: player-head-display-range
  • Values
    • Type: Integer
    • Default: 100
    • Minimum: 16
    • Maximum: 332

• SHOW_PLAYER_NAME

  • Config Key: show-player-name
  • Values
    • Type: Boolean
    • Default: false

• PLAYER_NAME_SCALE

  • Config Key: player-name-scale
  • Values
    • Type: Float
    • Default: 1.0F
    • Minimum: 0.5F
    • Maximum: 1.0F

• ONLY_SHOW_NAME_WHEN_LOOKING_NEAR

  • Only draw the name of a player when you look toward them
  • Config Key: only-show-name-when-looking-near
  • Values
    • Type: Boolean
    • Default: false

• LIMIT_NAME_RANGE

  • Only draw the names of players within the range
  • Config Key: limit-name-range
  • Values
    • Type: Boolean
    • Default: false

• PLAYER_NAME_DISPLAY_RANGE

  • The maximum distance in blocks at which player names show
  • Config Key: player-name-display-range
  • Values
    • Type: Integer
    • Default: 100
    • Minimum: 16
    • Maximum: 332

• COLORED_PLAYER_NAME

  • Color the player name with their team color, or with their dot color when they have no team
  • Config Key: colored-player-name
  • Values
    • Type: Boolean
    • Default: true

• HIDE_OVERLAPPING_NAMES

  • When names overlap, only draw the name closest to the middle of the bar
  • Config Key: hide-overlapping-names
  • Values
    • Type: Boolean
    • Default: true

• CUT_LONG_NAMES

  • Cut names longer than 8 characters, but keep them different from other players
  • Config Key: cut-long-names
  • Values
    • Type: Boolean
    • Default: true

• SHOW_DIRECTION

  • Config Key: show-direction
  • Values
    • Type: Boolean
    • Default: false

• USE_COORDINATE_DIRECTIONS

  • Show +Z, -Z, +X and -X instead of the direction letters
  • Config Key: use-coordinate-directions
  • Values
    • Type: Boolean
    • Default: false

• SHOW_BAR_ICONS

  • Draw the dots or player heads. Turn this off to only show the names
  • Config Key: show-bar-icons
  • Values
    • Type: Boolean
    • Default: true

• USE_XP_BAR

  • Draw the waypoints on the xp bar instead of the locator bar
  • Config Key: use-xp-bar
  • Values
    • Type: Boolean
    • Default: false

• TEXT_SHADOW

  • Adds a shadow to text
  • Config Key: text-shadow
  • Values
    • Type: Boolean
    • Default: true

• LOCATOR_BAR_PEEK

  • Only show the extra info while the peek keybind is held down
  • Config Key: locator-bar-peek
  • Values
    • Type: Boolean
    • Default: false

• ONLY_SHOW_WHILE_PEEKING

  • Hide the locator bar until you hold the peek keybind
  • Config Key: only-show-while-peeking
  • Values
    • Type: Boolean
    • Default: false