]> git.madduck.net Git - etc/awesome.git/blob - mpd.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated borderbox (markdown)
[etc/awesome.git] / mpd.md
1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
2
3 Shows MPD status in a textbox.
4
5         mpdwidget = lain.widgets.mpd()
6
7 Now playing songs are notified like this:
8
9         +--------------------------------------------------------+
10         | +-------+                                              |
11         | |/^\_/^\| Now playing                                  |
12     | |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 |
13     | | '.o.' | Hammer Smashed Face (Radio Disney Version)   |
14         | +-------+                                              |
15         +--------------------------------------------------------+
16
17 You need a file like this
18
19      (Front|front|Cover|cover|Art|art|Folder|folder)\.(jpg|jpeg|png|gif)
20
21 in the album folder in order to show album art too.
22
23 ### input table
24
25 Variable | Meaning | Type | Default
26 --- | --- | --- | ---
27 `timeout` | Refresh timeout seconds | int | 1
28 `password` | MPD password | string | ""
29 `host` | MPD server | string | "127.0.0.1"
30 `port` | MPD port | string | "6600"
31 `music_dir` | Music directory | string | "~/Music"
32 `cover_size` | Album art notification size | int | 100
33 `default_art` | Default art | string | ""
34 `settings` | User settings | function | empty function
35
36 `settings` can use `mpd_now` table, which contains the following string values:
37
38 - state (possible values: "play", "pause", "stop")
39 - file
40 - artist
41 - title
42 - album
43 - date
44
45 and can modify `mpd_notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition:
46
47     mpd_notification _preset = {
48        title   = "Now playing",
49        timeout = 6,
50        text    = string.format("%s (%s) - %s\n%s", mpd_now.artist,
51                  mpd_now.album, mpd_now.date, mpd_now.title)
52     }
53
54 ### output table
55
56 Variable | Meaning | Type
57 --- | --- | ---
58 `widget` | The textbox | `wibox.widget.textbox`
59 `update` | The notification | function
60
61 You can control the widget with key bindings like these:
62
63     -- MPD control
64     awful.key({ altkey, "Control" }, "Up",
65         function ()
66             awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle")
67             mpdwidget.update()
68         end),
69     awful.key({ altkey, "Control" }, "Down",
70         function ()
71             awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop")
72             mpdwidget.update()
73         end),
74     awful.key({ altkey, "Control" }, "Left",
75         function ()
76             awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev")
77             mpdwidget.update()
78         end),
79     awful.key({ altkey, "Control" }, "Right",
80         function ()
81             awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next")
82             mpdwidget.update()
83         end),
84
85 where `altkey = "Mod1"`.