LagGoggles Mod 1.12.2, Wiki

LagGoggles is a specialized profiling mod designed to help server administrators and players identify the exact sources of lag in their Minecraft world. Unlike traditional profilers that provide text-based logs, LagGoggles visualizes lag directly in the game world using a color-coded overlay. It measures the time (in microseconds) it takes for a block or entity to perform its update tick, allowing users to see which machines, animals, or items are consuming the most resources.

The mod is compatible with both Forge and SpongeForge environments and is essential for optimizing complex modded bases where hundreds of machines and pipes may be interacting simultaneously.

To function correctly, LagGoggles requires specific dependencies depending on the version being used:

• TickCentral: For versions 5.3 and above, TickCentral must be installed. It provides the core ticking control necessary for the profiler to hook into the game's update loops.
• Loader Versions: There are separate versions for standard Forge and SpongeForge. Ensure you select the version that matches your server environment.
• Client vs. Server: The mod must be installed on both the server and the client for the visual overlay to function. If installed only on the server, players will not see the visual goggles effect.

The mod is primarily accessed through an in-game GUI rather than physical items.

• Default Keybind: INSERT key. This opens the LagGoggles main menu.
• Alternative Keybinds: If the Insert key conflicts with other mods, it can be rebound in the standard Minecraft Controls menu under the "LagGoggles" category.

From the main menu, users can choose between different profiling modes, view previous results, or clear the current overlay.

LagGoggles operates by timing the execution of the update and tick methods for every active object in the world.

Profiling Types

The Color Scale

When the overlay is active, blocks and entities are highlighted with a gradient that indicates their performance impact:

• Green: Very low impact (0 - 25 µs/t). Normal for most blocks.
• Yellow: Moderate impact (25 - 100 µs/t). Common for active machines.
• Orange: High impact (100 - 500 µs/t). Potential source of lag if many are present.
• Red: Severe impact (500+ µs/t). Likely the primary cause of server or client lag.

Microseconds per Tick (µs/t)

Lag is measured in microseconds (µs). A Minecraft server has 50,000 µs (50ms) to process a single tick to maintain 20 TPS. If the total sum of all block and entity updates exceeds this threshold, the server will experience TPS lag.

LagGoggles does not add new mobs or blocks to the game; instead, it provides a detailed analysis of existing ones.

Analyzed Objects

• Tile Entities: Any block that stores data or performs actions, such as Furnaces, Chests, and complex machinery from other mods (e.g., Thermal Expansion, Applied Energistics 2).
• Entities: All living creatures (mobs), dropped items, and projectiles. Large concentrations of animals or items on the ground are common lag sources identified by the mod.
• Event Subscribers: Code from other mods that runs every tick but isn't attached to a specific block or entity.

Result Analysis

After a profile run (default 30 seconds), the "Analyze Results" button opens a list view. This list sorts every tracked object by its impact, showing the name, coordinates, and exact timing.

Teleportation: Players with appropriate permissions can double-click any entry in the analysis list to teleport directly to the source of the lag, even across dimensions.

The mod features extensive configuration options found in LagGoggles-server.cfg and the in-game client config.

• Permissions: Admins can restrict who can start a profile. By default, non-operators can only profile their immediate surroundings (e.g., their own base) to prevent them from seeing other players' hidden bases.
• Max Run Time: Limits the duration of a profile scan (default 30 seconds).
• Cooldown: Sets a wait time between scans to prevent server strain from repeated profiling.

Client Settings

• Custom Gradients: Users can change the colors used in the overlay to better suit their preferences.
• Colorblind Support: Includes specialized color modes for users with color vision deficiencies.
• Overlay Distance: Adjusts how far away the colored boxes are rendered.

While the GUI is the primary interface, several commands are available for administrative use: