From a1bb4a1010731702981a2f0ab3cb64f3f8451a1b Mon Sep 17 00:00:00 2001 From: ramforth Date: Fri, 31 Oct 2025 09:53:51 +0100 Subject: [PATCH] docs: Add README.md for system_monitor_overlay --- system_monitor_overlay/README.md | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 system_monitor_overlay/README.md diff --git a/system_monitor_overlay/README.md b/system_monitor_overlay/README.md new file mode 100644 index 0000000..28cdb80 --- /dev/null +++ b/system_monitor_overlay/README.md @@ -0,0 +1,36 @@ +# System Monitor Overlay + +This overlay displays real-time system information like CPU and memory usage. It's designed to be used as a browser source in streaming software like OBS Studio. + +## Example Output + +*(Image to be provided by user)* + +## Installation + +To use this overlay, you need to run a small Python server on your computer to provide the system stats to the overlay. + +1. **Install the required library:** + + ```bash + pip install psutil + ``` + +2. **Run the server:** + + ```bash + python server.py + ``` + + The server will start on port 8000. + +3. **Add to OBS Studio:** + + * Add a new "Browser" source to your scene. + * Set the URL to the `index.html` file in this directory. + * Set the width and height to your desired dimensions. + +## Overlays + +* `index.html`: The default overlay with a heading. +* `index-no-heading.html`: An alternative overlay without the heading.