Apollo
Developers
Mods
Waypoints

Waypoints

Create a waypoint anywhere in the world that will show how for away from a location you are as well as optionally render the name and a beam.

Integration

How to toggle the mod

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

Available options

  • ENABLED

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

    • Allows you to click coordinates in chat and create a new waypoint from them
    • Config Key: add-waypoints-from-chat
    • Values
      • Type: Boolean
      • Default: true
  • DEATH_WAYPOINT

    • Automatically create a waypoint when you die
    • Config Key: death-waypoint
    • Values
      • Type: Boolean
      • Default: true
  • LIMIT_DEATH_WAYPOINTS

    • Limit the amount of waypoints that can be created, removing the oldest one when going over the limit
    • Config Key: limit-death-waypoints
    • Values
      • Type: Boolean
      • Default: true
  • MAX_DEATH_WAYPOINTS

    • Maximum amount of Death Waypoints you will see at one time
    • Config Key: max-death-waypoints
    • Values
      • Type: Integer
      • Default: 3
      • Minimum: 1
      • Maximum: 20
  • WAYPOINT_BEAMS

    • Enables beams for waypoints in the world
    • Config Key: waypoint-beams
    • Values
      • Type: Boolean
      • Default: true
  • BOX_BORDER

    • Adds a box around the waypoint label in the world
    • Config Key: box-border
    • Values
      • Type: Boolean
      • Default: true
  • TEXT_SHADOW

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

    • Increase the size of the labels box
    • Config Key: box-padding
    • Values
      • Type: Float
      • Default: 4.0F
      • Minimum: 1.0F
      • Maximum: 8.0F
  • SHOW_ICONS

    • Show simpler text icons above each waypoint
    • Config Key: show-icons
    • Values
      • Type: Boolean
      • Default: false
  • LABEL_SCALE

    • Scale the box containing the waypoints name in the world
    • Config Key: label-scale
    • Values
      • Type: Float
      • Default: 1.0F
      • Minimum: 0.1F
      • Maximum: 2.0F
  • ICON_SCALE

    • Scale the box containing the waypoints icon in the world
    • Config Key: icon-scale
    • Values
      • Type: Float
      • Default: 1.5F
      • Minimum: 0.1F
      • Maximum: 3.0F
  • HIGHLIGHT_WAYPOINT_BLOCK

    • Show an outline around the block the waypoint is positioned on
    • Config Key: highlight-waypoint-block
    • Values
      • Type: Boolean
      • Default: true
  • HIGHLIGHT_WAYPOINT_BLOCK_LINE_WIDTH

    • The width of the outline around the block being highlighted
    • Config Key: highlight-waypoint-block-line-width
    • Values
      • Type: Float
      • Default: 4.0F
      • Minimum: 1.5F
      • Maximum: 7.5F
  • WAYPOINT_SHOW_DISTANCE

    • Show the distance of a waypoint in the world
    • Config Key: waypoint-show-distance
    • Values
      • Type: Boolean
      • Default: true
  • ONLY_SHOW_WHEN_LOOKING_NEAR

    • Waypoints will only be displayed when your camera is facing towards their general direction
    • Config Key: only-show-when-looking-near
    • Values
      • Type: Boolean
      • Default: false