ramforth/Overlays
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update index.html and azuracast/README.md with new strategy

Browse Source
This commit is contained in:
Ramforth
2025-10-30 14:38:08 +01:00
parent 9b62800a28
commit 597e26ab62
2 changed files with 25 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
azuracast/README.md
View File

@@ -2,13 +2,15 @@
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.
* **Easy to Customize:** The overlays are simple HTML and CSS files that can be easily modified to match your stream's branding.
* **Lightweight:** The overlays are designed to be lightweight and efficient, so they won't consume unnecessary resources.
## Usage
@@ -17,8 +19,8 @@ This directory contains browser source overlays specifically designed for displa
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:** `https://overlays.ramforth.net/azuracast/overlay-text-only.html`
* **With Album Art URL:** `https://overlays.ramforth.net/azuracast/overlay-with-album-art.html`
* **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".
@@ -46,4 +48,4 @@ To add the radio stream itself to your OBS scene, you can use a "Media Source".
## 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.
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.

26
index.html
View File

@@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Ramforth Overlays</title>
<title>Ramforth Overlays (Reference)</title>
<style>
body {
font-family: sans-serif;
@@ -44,27 +44,37 @@
li {
margin-bottom: 10px;
}
.important-note {
background-color: #555;
padding: 15px;
border-left: 5px solid #FFC107;
margin-top: 20px;
}
</style>
</head>
<body>
<div class="container">
<h1>Ramforth Overlays</h1>
<p>This page serves as the entry point for various streaming overlays developed by Ramforth. Each overlay is designed for seamless integration with streaming software like OBS Studio, providing dynamic content for your broadcasts.</p>
<h1>Ramforth Overlays (Reference)</h1>
<p>This page provides a reference and overview of various streaming overlays developed by Ramforth. The files hosted here are for demonstration and reference purposes only.</p>
<div class="important-note">
<strong>Important:</strong> For the latest versions, deployment instructions, and to customize these overlays for your own use, please clone the official Gitea repository. We do not provide hosting for convenience; users are expected to deploy these files themselves.
</div>
<h2>Repository</h2>
<p>All source code and documentation for these overlays can be found on our Gitea instance:</p>
<p>All source code and comprehensive documentation for these overlays can be found on our Gitea instance:</p>
<p><a href="https://gitea.ramforth.net/ramforth/Overlays">https://gitea.ramforth.net/ramforth/Overlays</a></p>
<h2>Available Overlays</h2>
<p>Here you will find the direct links to the available overlays:</p>
<h2>Available Overlays (Reference Files)</h2>
<p>Below are links to the current reference versions of the overlays hosted on this server:</p>
<h3>Azuracast Radio Overlays</h3>
<ul>
<li><a href="/azuracast/overlay-text-only.html">Text-only Now Playing Overlay</a></li>
<li><a href="/azuracast/overlay-with-album-art.html">Now Playing Overlay with Album Art</a></li>
</ul>
<p>For detailed instructions on how to use these overlays in OBS Studio, please refer to the <a href="https://gitea.ramforth.net/ramforth/Overlays/src/branch/main/azuracast/README.md">Azuracast README.md</a> in the repository.</p>
<p>For detailed usage instructions and to understand how to deploy these overlays, please refer to the <a href="https://gitea.ramforth.net/ramforth/Overlays/src/branch/main/azuracast/README.md">Azuracast README.md</a> within the Gitea repository.</p>
</div>
</body>
</html>
</html>