Feedback

Mute_Checker_14.py

@@ -81,4 +81,5 @@ def get_muted():
         else:
             mute_detect_time = None
 
-obs.timer_add(get_muted, 5000)
+obs.timer_add(get_muted, 5000)
+print(f"Mute Checker initialized, {mute_time} second delay")

README.md

@@ -1,34 +1,37 @@
 # Mute_Checker
-This script will notify the user if they're muted or not.
+This is an obspython script to help a user remember to unmute their microphone by notifying them if their microphone remains muted for longer than a configured length of time.
 
-(User Options to Edit:)
-  * audio_source - This variable will need an Audio source to monitor. The default value is "Mic/Aux" which is the first default microphone source. No need to change if it's called that!
+## User Options to Edit
+For the moment at least, configuration is done by editing the script itself. All of the configurable variables are at the top of the script.
 
-  * x_position - This variable would be the x position of the mute notification
-    ---- I have made a axis locator and it's on my GitHub. Link: [Not uploaded yet]
-  * y_position - This variable would be the y position of the mute notification
+  * **audio_source:** This variable sets the name of the audio source to monitor. The default is `Mic/Aux` which is the first default microphone source.
 
-  * mute_message - Message to display when muted. The default message is "YOU'RE MUTED IDIOT"
+  * **x_position:** The `x` position (in pixels) where the mute notification should be displayed -- I have made a axis locator and it's on my GitHub. Link: [Not uploaded yet]
+
+  * **y_position:** The `y` position (in pixels) where the mute notification should be displayed
 
-  * mute_time - Time AFTER muting when the notification will show. The default time is 30 seconds
+  * **mute_message:** Message to display when muted. The default message is "YOU'RE MUTED IDIOT"
 
-  * recording_or_streaming - This variable will be used if the user wants to notify ONLY when recording or ONLY when streaming. There's an option if you want it as both - it will notify if you're recording OR streaming. values: ("recording", "streaming", "both").
+  * **mute_time:** How long (in seconds) the microphone can be muted before the notification will be displayed. The default time is 30 seconds
 
-    ![](https://github.com/Malik403/Mute_Checker/blob/main/Animation.gif)
+  * **recording_or_streaming:** Whether notifications should be displayed when the user is recording, when the user is streaming, or both. Legal values are `recording`, `streaming`, or `both`. The default is `both`
 
-(Installation:)
-    Note: As of right now, you'll need Python 11.6 or below, Python 12 isn't supported. NO MODULES NEEDED. Also, the OBS module is ONLY for OBS, no need to pip install it!
+## Installation
+Copy the script to a location of your choice, and edit the variables at the top with your desired settings. The script requires no additional python modules and is compatable with any version of python supported by OBS.
+
+<!-- (You don't really need the original note about python versions, because the script itself will work with any version of python OBS supports -- and that will change over time, even though the script won't need to. Also, the python versions aren't "11.6" and "12", they're "3.11.6" and "3.12". -->
 
- * Open OBS Studio
- * Tools
- * Scripts
- * Python Settings
- * Browse
- * Navigate to installation of Python (Probably in: C:\Users\[username]\AppData\Local\Programs\ and Select Folder
- * Add the script to the Scripts section
- * Reload OBS
- * Script automatically loads when starting OBS!
-
-
-(Streamer info:)
-I originally made this script for my streamer friend. If you want to see it in action, his Twitch is Kobe_Skrobe.
+Once the script is installed, you need to add the script to OBS:
+1. Go to `Tools > Scripts`
+2. If needed, go to the `Python Settings` tab and configure the location where you have python itself installed (it should show "Loaded Python Version: 3.xx" beneath the python path
+3. In the `Scripts` tab,  click the `+` icon and find/select the script
+4. Use the `Script Log` button to look at the log for the script, you should see "Mute Checker initialized, xx second delay" in the log
+<!-- You don't actually need to reload OBS for the script to start, so removed that line -->
+
+
+## Demo
+![](https://github.com/Malik403/Mute_Checker/blob/main/Animation.gif)
+
+
+## Credits
+I originally made this script for my streamer friend, Kobe_Skrobe. You can see him in action [here](https://twitch.tv/Kobe_Skrobe).