summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 97f84f92d1805884797c44d578d133945305a442 (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
# clerk - the only mpd client UI that needs typing

clerk uses dmenu (or rofi) to draw a menu which lets you
manage your mpd server.

# Functions:

* Play random album
* Play x random tracks
* Browse Library (Artist > Album > Tracks)
* Show current Playback Queue
* Show Albums/Tracks by currently playing Artist
* Enable or disable scrobbling (with support for remote mpdscribble)
* Love current song on lastfm
* Rate albums (using rating.txt in album folder - needs local access to
* directories)
* Load rated album
* Rate tracks (stored in comment tag - needs local access to files)
* Control mpd options (modes, replaygain, crossfade)
* Lookup artist/album/lyrics in webbrowser

Being written completely functional means, every option is accessible
Some example arguments have been added. e.g:
`clerk -rs` will play random songs.

see `clerk -h` for all default arguments.


# Dependencies:

* dmenu2 (https://bitbucket.org/melek/dmenu2) OR
* rofi (https://github.com/DaveDavenport/rofi)
* mpc (will get completely replaced with mppc, once its finished)
* mppc (https://github.com/carnager/mppc)


# Optional Dependencies

* python-eyed3 (for track ratings)
* metaflac (for track ratings)
* surfraw (for lookup)