Updated Widgets (markdown)

[etc/awesome.git] / mpd.md

diff --git a/mpd.md b/mpd.md
index ab36d153639b1dec1953b9ece557a4eca7efcef9..0e2eca57d62841e2f038f1120726bcce01c1cc5e 100644 (file)
--- a/mpd.md
+++ b/mpd.md
@@ -14,7 +14,13 @@ Now playing songs are notified like this:
        | +-------+                                              |
        +--------------------------------------------------------+
 
-The function takes a table as optional argument, which can contain:
+You need a file like this
+
+     (Front|front|Cover|cover|Art|art|Folder|folder)\.(jpg|jpeg|png|gif)
+
+in the album folder in order to show album art too.
+
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
@@ -23,28 +29,26 @@ Variable | Meaning | Type | Default
 `host` | MPD server | string | "127.0.0.1"
 `port` | MPD port | string | "6600"
 `music_dir` | Music directory | string | "~/Music"
+`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
+- state (possible values: "play", "pause", "stop")
 - file
 - artist
 - title
 - album
 - date
 
-and can modify `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:
+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:
 
-    notification _preset = {
+    mpd_notification _preset = {
        title   = "Now playing",
-       text    = mpd_now.artist .. " ("   ..
-                 mpd_now.album  .. ") - " ..
-                 mpd_now.date   .. "\n"   ..
-                 mpd_now.title,
-       fg      = beautiful.fg_normal or "#FFFFFF",
-       bg      = beautiful.bg_normal or "#000000",
-       timeout = 6
+       timeout = 6,
+       text    = string.format("%s (%s) - %s\n%s", mpd_now.artist,
+                 mpd_now.album, mpd_now.date, mpd_now.title)
     }
 
 ### output table
@@ -52,7 +56,7 @@ and can modify `notification_preset` table, which will be the preset for the nau
 Variable | Meaning | Type
 --- | --- | ---
 `widget` | The textbox | `wibox.widget.textbox`
-`notify` | The notification | function
+`update` | The notification | function
 
 You can control the widget with key bindings like these:
 
@@ -60,22 +64,22 @@ You can control the widget with key bindings like these:
     awful.key({ altkey, "Control" }, "Up",
         function ()
             awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle")
-            mpdwidget.notify()
+            mpdwidget.update()
         end),
     awful.key({ altkey, "Control" }, "Down",
         function ()
             awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop")
-            mpdwidget.notify()
+            mpdwidget.update()
         end),
     awful.key({ altkey, "Control" }, "Left",
         function ()
             awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev")
-            mpdwidget.notify()
+            mpdwidget.update()
         end),
     awful.key({ altkey, "Control" }, "Right",
         function ()
             awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next")
-            mpdwidget.notify()
+            mpdwidget.update()
         end),
 
 where `altkey = "Mod1"`.
\ No newline at end of file