X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/4fd9ef1d072166be3951f87451713d17a815c28c..a14469d9f649e9d95956c6c460313b8708537a92:/mpd.md diff --git a/mpd.md b/mpd.md index 17acab8..0e2eca5 100644 --- a/mpd.md +++ b/mpd.md @@ -1,6 +1,8 @@ -Shows mpd status in a textbox. +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) - mympd = lain.widgets.mpd() +Shows MPD status in a textbox. + + mpdwidget = lain.widgets.mpd() Now playing songs are notified like this: @@ -12,56 +14,72 @@ Now playing songs are notified like this: | +-------+ | +--------------------------------------------------------+ -Dependencies +You need a file like this + + (Front|front|Cover|cover|Art|art|Folder|folder)\.(jpg|jpeg|png|gif) -- imagemagick +in the album folder in order to show album art too. -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- -`password` | Mpd password | string | "" -`host` | Mpd server | string | "127.0.0.1" -`port` | Mpd port | string | "6600" +`timeout` | Refresh timeout seconds | int | 1 +`password` | MPD password | string | "" +`host` | MPD server | string | "127.0.0.1" +`port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" -`refresh_timeout` | Refresh timeout seconds | int | 1 -`color_artist` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" -`color_song` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" -`spr` | Separator text between artist and song values | string | " " -`app` | Music program to spawn on click | string | "ncmpcpp" -`shadow` | Hide widget when there are no songs playing | boolean | false +`cover_size` | Album art notification size | int | 100 +`default_art` | Default art | string | "" +`settings` | User settings | function | empty function + +`settings` can use `mpd_now` table, which contains the following string values: + +- state (possible values: "play", "pause", "stop") +- file +- artist +- title +- album +- date + +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: -**Note**: `spr` can be a markup text. + mpd_notification _preset = { + title = "Now playing", + timeout = 6, + text = string.format("%s (%s) - %s\n%s", mpd_now.artist, + mpd_now.album, mpd_now.date, mpd_now.title) + } -`lain.widgets.mpd` outputs the following table: +### output table Variable | Meaning | Type --- | --- | --- `widget` | The textbox | `wibox.widget.textbox` -`notify` | The notification | function +`update` | The notification | function -Finally, you can control the widget with key bindings like these: +You can control the widget with key bindings like these: -- MPD control awful.key({ altkey, "Control" }, "Up", - function () - awful.util.spawn_with_shell( "mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle") + mpdwidget.update() + end), awful.key({ altkey, "Control" }, "Down", - function () - awful.util.spawn_with_shell( "mpc stop || ncmpcpp stop || ncmpc stop || pms stop", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop") + mpdwidget.update() + end), awful.key({ altkey, "Control" }, "Left", - function () - awful.util.spawn_with_shell( "mpc prev || ncmpcpp prev || ncmpc prev || pms prev", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev") + mpdwidget.update() + end), awful.key({ altkey, "Control" }, "Right", - function () - awful.util.spawn_with_shell( "mpc next || ncmpcpp next || ncmpc next || pms next", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next") + mpdwidget.update() + end), where `altkey = "Mod1"`. \ No newline at end of file