MemoryFreeze Fix

MemoryFreeze Fix

Release 2.0

Forge & Neoforge versions available !

A Minecraft Mod that Cleans Memory before it reaches 100% , therefore not causing any Stuttering when the allocated memory reaches It's limit.

Author: zSouul

What it does

• Watches what the garbage collector really does: pause times, full GCs, and how much memory is still in use after a GC. If something is wrong it tells you, for example that your heap is too small.
• Frees memory (a GC call) only when you won't notice: on loading screens, with no world loaded (title screen, world list), on the "loading terrain" screen, while the window is unfocused, or on a server with nobody online.
• Turns on G1's periodic GC while the game runs (if your launcher hasn't), so old garbage gets cleaned up in the background when the game is paused or idle.
• /memoryfreeze advice suggests launcher arguments based on numbers it measured on your machine.
• /memoryfreeze diagnose writes a heap report grouped by mod, so you can see which mod is holding memory.

Requirements

• Fabric Loader 0.19.3 - 0.20.0
• Compatible Version of Fabric API Optional :
• Compatible Version of Cloth Config API (for the config screen)

Commands

These exist on the server (trim, deepclean, diagnose, reload and hud need operator level 2) and on the client with the same names, so they work in singleplayer and on any server. The client versions only affect your own game.

There are also three keybinds (unbound by default) under Options > Controls > MemoryFreeze Fix: deep clean, full reset and heap report. They work on the title screen too.

Config

Use the config screen or edit config/memoryfreeze-fix.json. Values outside the allowed range are corrected when the file is loaded. A config from the old 1.x version is converted automatically and the old file is kept as memoryfreeze-fix.v1.json.bak.

Things to know

• A mod can't do more than a GC call can. If a cleanup frees little, the memory is really in use, either by the world or by another mod. In that case use /memoryfreeze reset, give the game more memory, or look at what the heap report shows.
• A forced GC stops the game under G1 whenever it runs. That is why automatic ones are limited to moments you won't notice. If you want almost no GC pauses at all, use Generational ZGC. That is a launcher setting, /memoryfreeze advice shows the flags for your Java version.
• If your launcher passes -XX:+DisableExplicitGC, GC calls do nothing. The mod notices this and tells you.
• The mod needs the jdk.management module for GC events and the runtime tuning. The Java runtimes that come with Minecraft have it. Without it the mod falls back to rough polling and skips the tuning.