Apollo
Developers
Mods
Minimap

Minimap

Display a miniature map of the world on your HUD.

Integration

How to toggle the mod

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

Available options

  • ENABLED

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

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

    • Config Key: map-width
    • Values
      • Type: Integer
      • Default: 8
      • Minimum: 1
      • Maximum: 16
  • MAP_HEIGHT

    • Config Key: map-height
    • Values
      • Type: Integer
      • Default: 8
      • Minimum: 1
      • Maximum: 16
  • MAP_ZOOM

    • Config Key: map-zoom
    • Values
      • Type: Float
      • Default: 1.0F
      • Minimum: 1.0F
      • Maximum: 2.0F
  • ROTATE_WITH_PLAYER

    • Config Key: rotate-with-player
    • Values
      • Type: Boolean
      • Default: true
  • BORDER

    • Config Key: border
    • Values
      • Type: Boolean
      • Default: true
  • BORDER_COLOR

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

    • Config Key: border-thickness
    • Values
      • Type: Float
      • Default: 1.0F
      • Minimum: 1.0F
      • Maximum: 5.0F
  • COMPASS

    • Config Key: compass
    • Values
      • Type: Boolean
      • Default: true
  • COMPASS_COLOR

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

    • Config Key: compass-shadow
    • Values
      • Type: Boolean
      • Default: true
  • PLAYER_MARKER_COLOR

    • Config Key: player-marker-color
    • Values
      • Type: String
      • Default: #FF0000FF
  • PLAYER_MARKER_SIZE

    • Config Key: player-marker-size
    • Values
      • Type: Float
      • Default: 5.0F
      • Minimum: 1.0F
      • Maximum: 10.0F
  • ENTITY_MARKER_OPACITY

    • Config Key: entity-marker-opacity
    • Values
      • Type: Float
      • Default: 1.0F
      • Minimum: 0.0F
      • Maximum: 1.0F
  • ENTITY_MARKER_SIZE

    • Config Key: entity-marker-size
    • Values
      • Type: Float
      • Default: 1.0F
      • Minimum: 1.0F
      • Maximum: 10.0F
  • ENTITY_MARKER_SHADOW

    • Config Key: entity-marker-shadow
    • Values
      • Type: Boolean
      • Default: true
  • SHOW_COORDINATES

    • Config Key: show-coordinates
    • Values
      • Type: Boolean
      • Default: true
  • SHOW_DISTANT_WAYPOINTS

    • Config Key: show-distant-waypoints
    • Values
      • Type: Boolean
      • Default: true