amrfti/icyws
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add ices2 sample config block

Browse Source
This commit is contained in:
amrfti
2025-12-09 21:21:32 -05:00
parent 643d3e0ad4
commit 8e0f5453b0
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,7 +1,7 @@
# icyws # icyws
A tiny ices2 input module. It does two things: A tiny ices2 input module. It does two things:
* Runs a WebSocket server on port 8765 that broadcasts the current song as `Artist - Title` * Runs a WebSocket server on port 8765 that broadcasts the current song as `Artist - Title`
* When run with no arguments, picks a random song from a newline‑separated file list, prints its full path, extracts metadata, and tells the WebSocket server * When run with no arguments, picks a random song from a newline-separated file list, prints its full path, extracts metadata, and tells the WebSocket server
## Usage ## Usage
@@ -15,11 +15,20 @@ icyws serve --bind :8765 --allow-origin *
ICYWS_TRACKLIST=tracks.txt icyws ICYWS_TRACKLIST=tracks.txt icyws
``` ```
This prints the selected file path to stdout and broadcasts the now‑playing info. This prints the selected file path to stdout and broadcasts the now-playing info.
### Track list format ### Track list format
A plain text file with one absolute file path per line. A plain text file with one absolute file path per line.
### ices2 config
```xml
<input>
<module>playlist</module>
<param name="type">script</param>
<param name="program">ICYWS_TRACKLIST=/etc/ices2/playlist.txt /usr/local/bin/icyws</param>
</input>
```
### WebSocket endpoint ### WebSocket endpoint
Connect to: `/ws/radio` Connect to: `/ws/radio`
Receives: `Artist - Title` whenever a new song is selected Receives: `Artist - Title` whenever a new song is selected