Skip to content

Commit

Permalink
Update readme with updated info, links to dependencies, and typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
LostLuma committed Feb 19, 2024
1 parent 0fe9a0b commit 9a21bd1
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,46 @@

# Dynamic FPS

Dynamic FPS can reduce the frame rate, volume, and pause [toasts](https://minecraft.wiki/wiki/Toasts) while Minecraft is not focused or hidden.
In addition to this it also fixes a bug in vanilla Minecraft making it take too many resources in the background.

Download on [GitHub Releases](https://github.com/juliand665/Dynamic-FPS/releases), [Modrinth](https://modrinth.com/mod/dynamic-fps), or [CurseForge](https://www.curseforge.com/minecraft/mc-mods/dynamic-fps).
Reduce resource usage while Minecraft is in the background or idle.

## Features

Dynamic FPS will detect when the window is not focused, but instead either hovered over, unfocused, or invisible.
For each mode you can adjust the maximum FPS, master volume, toast visibility, and whether to invoke garbage collection.
Dynamic FPS will detect whether the Minecraft window is currently active, being hovered over, unfocused, or invisible.
For each of these states you're able to adjust the frame rate, volume, and whether [toast notifications](https://minecraft.wiki/w/Toasts) are temporarily paused.

There's also an option to enter an idle state while the window is active but hasn't received any input in a certain amount of time.

---

In addition to this Dynamic FPS also reduces background CPU usage and stops rendering the world while either the loading overlay is active or a screen is obscuring the world (e.g. when you're editing keybinds or in another screen that the mod detects as opaque).
In addition to this Dynamic FPS fixes a vanilla bug causing higher than necessary background CPU usage and stops
rendering the world while it's being obscured by opaque screens or the resource loading overlay, helping especially on low-end systems.

## Questions
## Installation

Dynamic FPS is available for download on [GitHub](https://github.com/juliand665/Dynamic-FPS/releases), [Modrinth](https://modrinth.com/mod/dynamic-fps), and [CurseForge](https://www.curseforge.com/minecraft/mc-mods/dynamic-fps).
To access the in-game config screen you'll also need to install [Mod Menu](https://modrinth.com/mod/modmenu) and [Cloth Config](https://modrinth.com/mod/cloth-config).

## Frequently Asked Questions

- Why is Minecraft still running at 15 FPS?

Dynamic FPS will only reduce the client / render loop to a minimum of 15 cycles per second.
Lower frame rates are achieved by then cancelling the rendering of all superfluous frames, eg. 14 out of 15 frames are cancelled for 1 FPS.
Lower frame rates are achieved by then cancelling the rendering of all superfluous frames, e.g. 14 out of 15 frames are cancelled for 1 FPS.

This lets you resume playing almost instantly after switching back to the game:
Instead of having to wait for up to a second until the next rendered frame comes along, the game checks back within 1/15th of a second.

## Developer Info

> [!IMPORTANT]
> These features are currently only accurate for the Fabric and Quilt versions of Dynamic FPS!
If Dynamic FPS' optimizations conflict with a feature of your mod you can disable them.
This is done by adding a `dynamic_fps` object to your mod's metadata (inside `quilt`/`fabric.mod.json`).

Force disable the loading overlay optimization:

```json5
```json
"dynamic_fps": {
"optimized_overlay": false
},
Expand All @@ -42,7 +52,7 @@ Force disable the loading overlay optimization:
Screen optimization is enabled for screens that call [`renderDirtBackground`](# "Mojang Mappings")/[`renderBackgroundTexture`](# "Quilt Mappings / Yarn").
Other screens can opt in or out by adding their package and class name to the `optimized_screens` object instead:

```json5
```json
"dynamic_fps": {
"optimized_screens": {
"enabled": [
Expand Down

0 comments on commit 9a21bd1

Please sign in to comment.