Apollo
Developers
Mod Options
LightOverlay

Light Overlay

Shows the light levels of blocks where mobs can spawn

Integration

How to toggle the mod

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

Available options

  • ENABLED

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

  • RENDER_RANGE_LIMIT

    • The rendering limit (in chunks) for light overlay values. §eHigher values might lower your FPS.
    • Config Key: render-range-limit
    • Values
      • Type: Integer
      • Default: 2
      • Minimum: 1
      • Maximum: 12

  • FAST_UPDATES

    • With this option on, the overlay updates aren't deferred, and happen as fast as possible. This looks nicer (less "pop in"), but §eturning this option on comes at a potential performance cost.
    • Config Key: fast-updates
    • Values
      • Type: Boolean
      • Default: false

  • CULLING

    • Reduce the amount of overlays that are rendered, increasing performance, especially at higher rendering ranges. This comes at the expense of overlays at the edges of the screen sometimes popping in and out as you look around. It's highly recommended that this option is kept on, especially if using higher rendering ranges.
    • Config Key: culling
    • Values
      • Type: Boolean
      • Default: true

  • INCLUDE_SKY_LIGHT

    • With this option on, the real, effective light value is displayed. With this option off, only the block light is used, completely ignoring the sky/day light.
    • Config Key: include-sky-light
    • Values
      • Type: Boolean
      • Default: true

  • HIDE_UNSPAWNABLE_LIGHT

    • Only show on blocks which have light levels that hostile mobs can spawn on
    • Config Key: hide-unspawnable-light
    • Values
      • Type: Boolean
      • Default: false

  • CUSTOM_LIGHT_THRESHOLD

    • Set a custom threshold for Light Check. This overrides the vanilla hostile mob spawning value, and shows the light overlay on all blocks on which the light level falls below this threshold
    • Config Key: custom-light-threshold
    • Values
      • Type: Boolean
      • Default: false

  • THRESHOLD

    • Config Key: threshold
    • Values
      • Type: Integer
      • Default: 15
      • Minimum: 0
      • Maximum: 15

  • SHOW_LIGHT_VALUE

    • Show a number for the light value of each block. Turning this option on might lower your FPS.
    • Config Key: show-light-value
    • Values
      • Type: Boolean
      • Default: false

  • CROSS_THICKNESS

    • Config Key: cross-thickness
    • Values
      • Type: Float
      • Default: 2.0F
      • Minimum: 0.5F
      • Maximum: 10.0F

  • TEXT_COLOR

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

  • BRIGHT_COLOR

    • Color where hostile mobs can't spawn
    • Config Key: bright-color
    • Values
      • Type: String
      • Default: #FF00FF00

  • DARK_COLOR

    • Color where hostile mobs can spawn
    • Config Key: dark-color
    • Values
      • Type: String
      • Default: #FFFF0000

  • LIGHT_OVERLAY_DYNAMIC_COLOR

    • When this is off, the color is picked based on the light level allowing hostile mobs to spawn. When this is on, the color is interpolated smoothly.
    • Config Key: light-overlay-dynamic-color
    • Values
      • Type: Boolean
      • Default: false
LightingMarkers