diff --git a/README.md b/README.md index 53c8000..a521884 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +* **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. \ No newline at end of file diff --git a/azuracast/README.md b/azuracast/README.md deleted file mode 100644 index 6dc610a..0000000 --- a/azuracast/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# Azuracast Overlays - -This directory contains browser source overlays specifically designed for displaying "Now Playing" information from an Azuracast radio station. - -## Important Note - -The files hosted on `https://overlays.ramforth.net/azuracast/` are for **reference and demonstration purposes only**. For the latest versions, deployment instructions, and to customize these overlays for your own use, please clone the main `Overlays` Gitea repository. Users are expected to deploy these files themselves. - -## Features - -* **Two Overlay Variants:** - * `overlay-text-only.html`: A clean, text-only overlay showing the current song title and artist. - * `overlay-with-album-art.html`: An overlay that includes the album art for the current song. - -## Usage - -### OBS Studio: Browser Source Setup - -To add one of the overlays to your OBS Studio scene, follow these steps: - -1. **Choose an Overlay:** Decide whether you want to use the text-only overlay or the one with album art. - * **Text-only URL (Reference):** `https://overlays.ramforth.net/azuracast/overlay-text-only.html` - * **With Album Art URL (Reference):** `https://overlays.ramforth.net/azuracast/overlay-with-album-art.html` - -2. **Add a Browser Source:** In OBS Studio, right-click in the "Sources" panel and select "Add" -> "Browser". - -3. **Configure the Source:** - * Give the source a name (e.g., "Azuracast Overlay"). - * In the "URL" field, paste the URL of the overlay you chose. - * Set the "Width" and "Height" to your desired dimensions (e.g., 400x150). - * Click "OK". - -4. **Position the Overlay:** You can now resize and position the overlay within your scene as needed. - -### OBS Studio: Media Source Setup - -To add the radio stream itself to your OBS scene, you can use a "Media Source". This will allow you to play the radio audio directly in your stream. - -1. **Add a Media Source:** In OBS Studio, right-click in the "Sources" panel and select "Add" -> "Media Source". - -2. **Configure the Source:** - * Give the source a name (e.g., "Radio Stream"). - * Uncheck the "Local File" box. - * In the "Input" field, paste the following URL: `https://radio.ramforth.net/listen/lo-fi/radio.mp3` - * Click "OK". - -3. **Manage Audio:** You can now control the volume of the radio stream from the "Audio Mixer" panel in OBS. - -## Customization - -To customize the overlays, you can fork this repository and edit the HTML and CSS files directly. You can change the fonts, colors, layout, and more to match your stream's branding. \ No newline at end of file diff --git a/azuracast/overlay-text-only.html b/azuracast/overlay-text-only.html deleted file mode 100644 index a066395..0000000 --- a/azuracast/overlay-text-only.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Now Playing (Text Only) - - - -
-
-
-
radio.ramforth.net
-
- - - - diff --git a/azuracast/overlay-with-album-art.html b/azuracast/overlay-with-album-art.html deleted file mode 100644 index 53e4d50..0000000 --- a/azuracast/overlay-with-album-art.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Now Playing - - - -
- Album Art -
-
-
-
radio.ramforth.net
-
-
- - - - diff --git a/index.html b/index.html index 9b519b2..ce5d2a7 100644 --- a/index.html +++ b/index.html @@ -75,8 +75,18 @@

Azuracast Radio Overlays

+ +

Weather Overlay

+ + +

System Monitor Overlay

+

For detailed usage instructions and to understand how to deploy these overlays, please refer to the Azuracast README.md within the Gitea repository.