Merge branch 'main' of https://github.com/NotAKidOnSteam/FuckMetrics

README.md

@@ -2,6 +2,21 @@
 
 This mod limits UpdateMetrics & SendCoreUpdate while the menus are closed. This helps to alleviate hitching and performance issues, particularly with FPS drops while unmuted in online instances and VRIK tapping in place.
 
+## Settings
+
+* Disable CohtmlView On Idle 
+  - Disables CohtmlView on the menus when idle. Takes up to 6 seconds after menu exit. This can give a huge performance boost, but is disabled by default as Cohtml can be unpredictable.
+* Menu Metrics
+  - Menu metrics settings (FPS & Ping). Always, Menu Only, or Disabled. Updates once on menu open if disabled.
+* Menu Core Updates
+  - Menu core update settings (Gamerule icons & download debug status). Always, Menu Only, or Disabled. Updates once on menu open if disabled.
+* Metrics Update Rate
+  - Sets the update rate for the menu metrics. CVR default is 0.5f. Recommended to be 1f or higher.
+* Core Update Rate
+  - Sets the update rate for the menu core updates. CVR default is 0.1f. Recommended to be 2f or higher as it is intensive.
+
+In general, keeping Menu Metrics & Menu Core Updates to Menu Only with a high Update Rate (in seconds), should be enough for smooth gameplay. Only turn on Disable CohtmlView On Idle if you really wanna squeeze performance, as Cohtml can sometimes freak out when disabled.
+
 ## Examples
 
 The following clips demonstrate the difference in performance with and without the FuckCohtml mod. While not a scientifically rigorous comparison, it is clear that there is a significant performance hit when unmuted, causing Dynamic Bones to jitter, in the clip without the mod: