initial commit

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0ff765
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Hyperion MPD music visualisation plugin
+=======================================
+
+Adapted from [this script by `tuckerbuchy`](https://github.com/tuckerbuchy/ledvis/blob/master/audioprocessing.py).
+
+Add this to your `mpd.conf`:
+```
+audio_output {
+    type    "fifo"
+    name    "MPD FIFO"
+    path    "/tmp/mpd.fifo"
+    format  "48000:16:1"
+}
+```
+
+Then, install `numpy` and place `mpdvis.json`, `mpdvis.py` into hyperion's effects folder (`/opt/hyperion/effects` or similiar).