8000 GitHub - bbf/LagGoggles: A minecraft forge mod which visualises lag in the world
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

bbf/LagGoggles

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LagGoggles

Intuitive lag hunting!

Hey there! I don't have time right now to maintain this mod like I did before due to private reasons, I will still look at pull requests, and review them, if you feel the need to help out.
When I get more time on my hands, I will definetly continue support, but at this moment, there's no guarantee.
Sorry for the inconvienience.



LagGoggles is a profiler where you can see timings in the world, visually. It comes with a custom GUI using a configurable keybind. It's compatible with [SpongeForge](https://github.com/SpongePowered/SpongeForge) and [Mixin](https://github.com/SpongePowered/Mixin)!
You can use LagGoggles as a player too! This is my attempt to create an understanding of what causes lag on a server to regular players.
I noticed some common misconceptions like having machines spread out over different chunks causes less lag than putting it in one chunk.
With LagGoggles, you can look around and see that alot of small things like pipes or cables cause a tiny bit of lag most of the time, often resulting in more lag than a machine right next to the source would.

LagGoggles can also profile clientside FPS as of version 4.0!

Download: here

Screenshots

LagGoggles enabled normal view
alt text alt text
alt text alt text
alt text alt text

alt text alt text alt text alt text

Features

  • Sponge compatible (use the SPONGEFORGE version!)
  • Teleporting to sources of lag
  • Client GUI, including overlay and clickable menus
  • Colour scale for easy spotting of sources of lag.
  • Calculations are done on the client, so each client can have a different colour scale.
  • Clientside FPS support!
    • Checks render time for Entities, Tile entities and event subscribers
    • It's very young, but it should give some insight in what may cause FPS issues.
  • Config for client:
    • Custom gradients
    • Colorblindess support
  • Config for server
    • Custom permissions for players (non-operators)

Configuration

  • Drop the jar in the /mods folder
  • Serverside configuration is not required and has no effect.
  • Clients can edit the config to change the colour scale.

How it works

At startup Mixin handles each class being loaded. On the server side, this mod hooks into the loading mechanism. This is the same mechanism SpongeForge uses, that's why it's compatible.

Entities, blocks and event-subscribers are timed using System.nanotime() before and after the tick() and update() methods. These times are being recorded and sent to the client when the profiler is done.

Benefits

  • Visualisation of various sources of lag
  • Learn your players to build lag-free bases.

Dependencies

As of version 3.0, you'll have to pick the right version of LagGoggles.
If you are a player, you can simply install the FORGE edition.

If you're installing it on the server you have to use either the FORGE or SPONGEFORGE version.
Quick answer: Running SpongeForge? Install the SPONGEFORGE version.

Elaboration: SpongeForge changes classes at startup in such a way it's completely incompatible with LagGoggles's FORGE edit's on WorldServer.class, therefore I made an alternative WorldServer.class just to be compatible with SpongeForge.

About

A minecraft forge mod which visualises lag in the world

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%
0