docs: Update README and index.html with new overlays

This commit is contained in:
2025-10-31 09:41:41 +01:00
parent 67ac5f3613
commit c45cfc9aa0
5 changed files with 34 additions and 203 deletions

View File

@@ -1,8 +1,26 @@
# Overlays
# Ramforth Overlays
This repository serves as a collection of various overlays for streaming and other purposes.
Each subdirectory contains overlays for a specific service or project.
This repository contains a collection of browser source overlays for streaming software like OBS Studio.
## Available Overlays
* **Azuracast:** Overlays for displaying "Now Playing" information from an Azuracast radio station.
* **Azuracast "Now Playing"**: Displays the currently playing song from an Azuracast radio station.
* `overlay-text-only.html`: A clean, text-only overlay.
* `overlay-with-album-art.html`: An overlay that includes album art.
* **Weather Overlay**: Displays the current weather for a specific location.
* **System Monitor Overlay**: Displays real-time system information like CPU and memory usage.
## Future Ideas
* An overlay that can take RSS feeds and make a ticker style horizontal scroller for the headlines
* A What's playing on Spotify overlay
* Overlay for Youtube music "now playing"
* Live Chat Overlay: Display chat messages from a YouTube or Twitch stream in real-time.
* Goals & Countdown Overlay: Show stream goals (followers, subs, etc.) with a progress bar, or a countdown to a specific event.
* Social Media Feed: Display a live feed of posts from a Twitter/X hashtag or account.
## Usage
To use these overlays, you can clone this repository and open the HTML files in a browser source in your streaming software.
For detailed instructions on each overlay, please refer to the individual `README.md` files in the respective overlay directories.