Description
# FrameGuard
FrameGuard is a performance, diagnostics, and server-utility mod for Forge and NeoForge modpacks. It helps players, server owners, and modpack developers monitor game performance more effectively, identify problems more easily, and control selected performance-related issues.
## Supported Versions
FrameGuard is available for:
- **Forge 1.20.1**
- **NeoForge 1.21.1**
Both versions are intended to provide the same core feature set. The NeoForge version is a technical port for newer Minecraft versions while keeping the user-facing features as close as possible to the Forge version.
## Performance HUD
FrameGuard displays important performance values directly in the HUD, including:
- FPS
- Frametime
- Ping
- Server status
- TPS, when available
Through the advanced HUD mode, additional statistics can also be shown, such as:
- Average frametime
- P99 frametime
- Maximum frametime
- 1% low FPS
This makes it easier to keep track of performance problems while playing.
## FPS Control
FrameGuard includes FPS control options for menu and background situations.
This can help reduce unnecessary system load when Minecraft is not actively being played, for example while the game is minimized, in the background, or inside menus.
## Client-Side Performance Features
FrameGuard includes client-side performance tools such as the Entity Render Guard.
The Entity Render Guard can help reduce rendering pressure in situations with many visible entities by limiting far-away entity rendering while keeping important entities visible, depending on the configuration.
## Diagnostics and Log Export
FrameGuard provides a log export system for troubleshooting and support.
The export system can collect useful diagnostic information, including:
- Relevant log files
- Configuration files
- Crash reports
- System information
- Important filtered log entries
The exported ZIP file can help players, modpack developers, or server administrators analyze issues more easily.
FrameGuard also includes optional crash auto-export support, which can help preserve useful diagnostic data after problems occur.
## Server-Side Features
When installed on the server side, FrameGuard can provide additional functionality beyond the client HUD.
Server-side features include:
- TPS syncing for clients
- Entity cramming protection
- TNT performance guards
- Queued TNT activation handling
- Item ban system
- Removal or blocking of configured banned items from inventories and dropped items
If FrameGuard is installed on both the client and the server, additional information can be exchanged between them. This allows the HUD to display more accurate server-related values.
## Main Focus
FrameGuard focuses on:
- Clear performance monitoring
- Simpler troubleshooting
- Useful diagnostic exports
- Client-side FPS and HUD control
- Server-side performance guards
- Low additional overhead through optimized value updates
## Who Is FrameGuard For?
FrameGuard is especially useful for:
- Larger modpacks
- Technical players
- Server owners
- Modpack developers
- Players who want better performance visibility
- Anyone who wants to track possible performance issues and selected server-side risks
## License
FrameGuard is released under **All Rights Reserved**.
You may use FrameGuard on private and public servers.
You may include the unmodified FrameGuard `.jar` file in free modpacks, as long as the modpack itself is not sold.
You may share modified FrameGuard configuration files, for example adjusted limits, server-specific balancing, banned item lists, performance settings, or other configuration changes.
Voluntary donations for servers or modpacks using FrameGuard are allowed, as long as the donation is not required to download the modpack or access FrameGuard itself.
You are not allowed to:
- Sell FrameGuard
- Sell modified versions of FrameGuard
- Redistribute modified `.jar` files
- Redistribute the source code
- Publish modified source code
- Claim FrameGuard as your own work