Done
This commit is contained in:
40
README.md
40
README.md
@@ -1,2 +1,40 @@
|
||||
# RadioDJ-Tuna
|
||||
# 🎧 RadioDJ Tuna Bridge
|
||||
|
||||
A lightweight Java utility that pulls "Now Playing" info from RadioDJ's REST XML API, and outputs it as `.txt` files and album art for tools like Tuna (OBS plugin).
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Features
|
||||
|
||||
- ✅ Pulls title / artist / album / album art via REST
|
||||
- 🛑 Only updates files if the song actually changed
|
||||
- 🖼️ Copies matching album art, or uses fallback image
|
||||
- 💾 Creates & reads from `config.yml` and `last-played.xml`
|
||||
- 🪄 Fully customizable update interval
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
1. **First Run:**
|
||||
- Launch the app with `java -jar radiodj-tuna-bridge.jar`
|
||||
- You'll be prompted to enter your API URL, art folder, fallback filename, and polling interval
|
||||
|
||||
2. **Outputs:**
|
||||
- Stored in `tuna-output/` folder:
|
||||
- `track-title.txt`
|
||||
- `track-artist.txt`
|
||||
- `track-album.txt`
|
||||
- `album-art.jpg` (copied from your RadioDJ art folder)
|
||||
|
||||
3. **Reconfigure:**
|
||||
- Edit the `config.yml` file to change settings at any time
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Build Instructions
|
||||
|
||||
```bash
|
||||
git clone https://github.com/you/radiodj-tuna-bridge.git
|
||||
cd radiodj-tuna-bridge
|
||||
build.bat
|
Reference in New Issue
Block a user