about summary refs log tree commit diff stats
path: root/README.md
blob: 578c90a79451b1383bc1f3bcf0b23c289522477a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# RADISH
## radio player in sh

I just want a simple script to play radio sometimes, or shuffle music on my
computer, or play noise.  I don't need tagging, playlist building, blah blah
blah.  So, I wrote RADISH.

## Usage

Copied from `radish -h`:

```
RADISH: radio, music, static
USAGE:  radish [-h|-k|-r|-s|-S]
  radish -l [NAME]
  radish [STATION]

FLAGS:
 -h    Show this help and exit.
 -s    Show radish's status and exit.
 -S    Show radish's status indefinitely.
 -k    Kill the currently-playing radish invocation.
 -r    Replay most recently-played station.

OPTIONS:
 -l [NAME]  List available stations.
    If NAME is given, narrow the list to those matching it.

PARAMETERS:
 STATION  Which configured station to play.
          Stations are defined in the $RADISH_STATION_FILE
          (default: /home/case/etc/radish/stations).
          If STATION is not present, or if it matches
          more than one station, radish will present a menu.
```

## Configuration

A default `radish.stations` is provided in this repo; save it to
`$XDG_CONFIG_HOME/radish/stations` and edit as you see fit.

Radish's `station` file is a tab-separated file with the following schema:

```
URL	DESCRIPTION	TAGS
```

Lines starting with `#` are ignored as comments.

A `URL` can be the URL of an internet radio or other stream, or one of
`file://<FOLDER>`, `shuf://<FOLDER>`, or `noise://<NOISE-SPEC>`.  The `file:`
protocol simply finds all music files underneath `FOLDER` and plays them in
order.  `shuf:` does the same, but shuffles the files.  `noise:` uses SoX's
`play` binary to generate noise.

**NOTE**: Currently the `noise:` URL parsing doesn't work.  Patches welcome!

**NOTE**: I'm looking at using a previously-existing playlist format, like `pls`
or `m3u`, instead of this ad-hoc tab-separated deal.  Expect change in this area.

## Installation

```
# make install
```

## Uninstallation

```
# make uninstall
```

## Contributing

Patches, comments, complaints are welcome.  You can email me at the address
listed on the bottom of this page.

RADISH and its associated files are licensed under the Fair License.  See
COPYING for more details.