Merge remote-tracking branch 'Blackout/main'

Merged Blackout

README.md

@@ -30,6 +30,41 @@ Simple mod to clear hud notifications when joining an online instance. Can also
 
 There is no native method to clear notifications, so I force an immediate notification to clear the buffer.
 
+# Blackout
+
+    Functionality heavily inspired by VRSleeper on Booth: https://booth.pm/ja/items/2151940
+
+    There are three states of "blackout":
+
+    0 - Awake (no effect)
+    1 - Drowsy (partial effect)
+    2 - Sleep (full effect)
+
+    After staying still for DrowsyModeTimer (minutes), you enter DrowsyMode.
+    This mode dims the screen to your selected dimming strength.
+    After continuing to stay still for SleepModeTimer (seconds), you enter SleepMode.
+    This mode over renders mostly everything with black.
+
+    Slight movement while in SleepMode will place you in DrowsyMode until SleepModeTimer is reached again.
+    Hard movement once entering DrowsyMode will fully wake you and return complete vision.
+    
+    Auto state changing can be disabled. This allows you to use UIExpansionKit to manually change Blackout states.
+    
+    Supports DesktopVRSwitch~ if that releases.
+    
+**Settings**
+
+* Hud Messages - Sends hud notification on state change.
+* Lower FPS While Sleep - Caps FPS to 5 while in Sleep State.
+* Drowsy Dim Strength - How strong of a dimming effect should drowsy mode have.
+
+//Automatic State Change related stuff
+* Automatic State Change - Dim screen when there is no movement for a while.
+* Drowsy Threshold - Degrees of movement to return partial vision.
+* Awake Threshold - Degrees of movement to return full vision.
+* Enter Drowsy Time - How many minutes without movement until enter drowsy mode.
+* Enter Sleep Time - How many seconds without movement until enter sleep mode.
+    
 ---
 
 Here is the block of text where I tell you this mod is not affiliated or endorsed by ABI.