New Readme
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# RadioDJViewer
|
||||||
|
|
||||||
|
RadioDJViewer is a Windows Forms application for displaying song information and album art from a RadioDJ REST API. It is designed for use with RadioDJ automation software and provides a simple interface for viewing and exporting currently playing track details.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Connects to RadioDJ REST API to acquire song info
|
||||||
|
- Displays title, artist, and album (with scrolling marquee for long text)
|
||||||
|
- Shows album art or a fallback image if none is available
|
||||||
|
- Exports title, artist, album, and album art to output folder
|
||||||
|
- Supports multiple profiles for different RadioDJ instances
|
||||||
|
- Auto-regenerates missing `profiles.json` and fallback image
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
- Windows 7 or later
|
||||||
|
- .NET Framework 4.7.2
|
||||||
|
- RadioDJ REST API running and accessible
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
1. Download the release ZIP and extract all files to a folder.
|
||||||
|
2. Ensure the following files are present:
|
||||||
|
- `RadioDJViewer.exe`
|
||||||
|
- `Newtonsoft.Json.dll`
|
||||||
|
- `RadioDJViewer.exe.config`
|
||||||
|
- (Optional) `default.jpg` and `profiles.json` (will be auto-generated if missing)
|
||||||
|
3. Run `RadioDJViewer.exe`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
1. Configure a profile with the REST API URL, output folder, and image settings.
|
||||||
|
2. Click Connect to start polling the API and display song info.
|
||||||
|
3. Output files will be saved in the selected output folder.
|
||||||
|
4. If album art is missing, a fallback image will be used.
|
||||||
|
|
||||||
|
## License
|
||||||
|
This project is licensed under the MIT License.
|
||||||
|
|
||||||
|
## Repository
|
||||||
|
[https://git.smartcraft.me/minster586/RadioDJViewer](https://git.smartcraft.me/minster586/RadioDJViewer)
|
||||||
|
|
||||||
|
---
|
||||||
|
For questions or issues, please open an issue on the repository or contact the maintainer.
|
Reference in New Issue
Block a user