summaryrefslogtreecommitdiff
path: root/doc/en/plugins/mpd_client.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/plugins/mpd_client.txt')
-rw-r--r--doc/en/plugins/mpd_client.txt54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/en/plugins/mpd_client.txt b/doc/en/plugins/mpd_client.txt
new file mode 100644
index 00000000..54c6fb2d
--- /dev/null
+++ b/doc/en/plugins/mpd_client.txt
@@ -0,0 +1,54 @@
+MPD Client
+==========
+
+This plugin is here to display what you are listening to in a chat tab.
+
+
+Installation and configuration
+------------------------------
+
+Installation
+~~~~~~~~~~~~
+
+You need https://github.com/Mic92/python-mpd2[python-mpd], in its python3
+version.
+
+Then you can load the plugin.
+
+==============
+
+ /load mpd_client
+
+==============
+
+Configuration
+~~~~~~~~~~~~~
+
+You have to put the following into _mpd_client.cfg_, as explained in
+link:index.html[the index page].
+
+NOTE: If you do not put anything, the plugin will try to connect to
+_localhost:6600_ with no password.
+
+[source,conf]
+---------------------------------------------------------------------
+[mpd_client]
+host = the_mpd_host
+port = 6600
+password = password if necessary
+---------------------------------------------------------------------
+
+Usage
+-----
+
+=======
+
+ /mpd
+
+Will show the current song, artist, and album
+
+ /mpd full
+
+Will show the current song, artist, and album, plus a nice progress bar.
+
+======