docs: Add README.md for system_monitor_overlay

This commit is contained in:
2025-10-31 09:53:51 +01:00
parent a48a06ed04
commit a1bb4a1010

View File

@@ -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.