summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 9b2c40cbb0c591861b1103b5573a883c71254008 (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
# clerk

MPD client using bash and rofi

# Screenshot (V3)
![Screenshot]
(images/clerk_multi_keys.jpg)

# Features:

* Play random Album/Tracks
* Add/Insert/Replace Albums/Songs
* Manage current Queue
* Locate Album/Track in Library
* Toggle scrobbling
* Love current Song on last.fm
* Rate Albums/Tracks
* Load rated Albums/Tracks
* Play Similar Songs
* Control mpd options
* Customizable Hotkeys

Written completely functional, nearly every option is accessible
from command line.
For example `clerk --random track` will play random songs.

see `clerk -h` for all default arguments.

From every database related menu it's possible to add/insert/replace one or multple entries.
For this to work, you need a recent rofi build from git.

# Dependencies:

* rofi (https://github.com/DaveDavenport/rofi)
* mpc (at least 0.26, for working albumlist sorted by mtime 0.27 is needed)
* python-mpd2 (https://github.com/Mic92/python-mpd2)
* a version of column with `-s` support.
* perl

# Optional Dependencies

* lastfm-mpd-cli for loving tracks (https://github.com/morendi/lastfm-mpd-cli)
  (Not needed when using mpdas instead of mpdscribble)
* mpd-sima (for Similar Artists playback)

# Installation

1. Install dependencies (each binary needs to be in your $PATH)
2. Copy config.clerk to $HOME/.config/clerk/config and edit it.
3. Copy clerk and clerk_helper to $PATH
4. Run clerk

For arch linux there is a package in [AUR](https://aur.archlinux.org/packages/clerk-git/)

# FAQ
1. It's not working properly  
  Make sure to have your files tagged properly. You need: `albumartist`, `artist`, `album`, `date`, `tracknumber`, `title` tags.
2. mpd says 'connection closed by server'  
  increase your `max_output_buffer_size` in mpd.conf  
  I requested a chunked protocol feature [here](http://bugs.musicpd.org/view.php?id=4488)