added README
[mpdhero.git] / README
blobeb4a4aeb116ab631ade76621ad69b20e0006183b
1 mpdhero transforms your mpd playlist, for example by shuffling album-wise or
2 adding random songs.  It requires ruby 1.8.  mpdhero --help prints a full list
3 of options:
5 Usage: mpdhero [options]
6         --version                    display version
7     -v, --[no-]verbose               print information about what is happening
8     -q, --[no-]quiet                 supress warnings
9     -R, --[no-]more-randomness       add more randomness in some operations
10     -a, --shuffle-albums             shuffle the playlist but keep albums intact
11     -k, --shuffle-chunks             shuffle 20-minute chunks of albums
12     -A, --shuffle-artists            shuffle the playlist but keep artists intact
13     -b, --add-random-album [PATH]    adds a random album
14     -d, --add-random-song [PATH]     adds a random song
15     -n, --number n                   specifies a number
16     -l, --log [n]                    delay the addition of songs by log n (x) minutes
17     -P, --play                       start playing
18     -C, --clear                      clear playlist before doing anything
19     -c, --[no-]current-first         put current playling song/album first, when shuffling
20     -h, --host IP                    the mpd server, defaults to MPD_HOST || localhost
21     -p, --port PORT                  the mpd server port, defaults to MPD_PORT || 6600
22     -r, --remove-current             removes the current entry/entries if something is added