From 5fbc51fba70fa669d60f71a37d9087f53c35000b Mon Sep 17 00:00:00 2001
From: Sam Rolfe <samuelrolfe@gmail.com>
Date: Fri, 9 Jan 2026 11:57:55 +1100
Subject: [PATCH] add readme

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index e69de29..e7859e1 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,47 @@
+# Mopidy Music Server Configuration
+
+This repository contains the configuration and setup for the local Mopidy instance. Mopidy acts as the primary music logic server (Radio, Local Files, Extensions) feeding into the Snapcast multi-room audio system.
+
+## 🎵 System Architecture
+
+*   **Core:** Mopidy (Python-based music server).
+*   **Output:** Pipes audio to Snapserver via a Named Pipe (`/tmp/snapfifo`).
+*   **Frontend:** Iris Web Interface (Port 6680).
+*   **Extensions:** `mopidy-radionet`, `mopidy-local`, etc.
+
+## 📂 Key Files
+
+*   **`mopidy.conf`**: The master configuration file. Controls enabled plugins, file paths, and GStreamer audio pipelines.
+*   **`requirements.txt`** (Optional): Python pip dependencies for installed plugins.
+
+## ⚙️ Configuration Highlights
+
+### Audio Output (Snapcast Link)
+To ensure compatibility with Snapserver, the audio output is forced to **48kHz Stereo 16-bit** and written to the pipe:
+
+```ini
+[audio]
+output = audioresample ! audioconvert ! audio/x-raw,rate=48000,channels=2,format=S16LE ! wavenc ! filesink location=/tmp/snapfifo
+```
+
+## 🚀 Management Commands
+
+**Restart Service:**
+```bash
+sudo systemctl restart mopidy
+```
+
+**Check Status & Logs:**
+```bash
+sudo systemctl status mopidy
+sudo journalctl -u mopidy -f
+```
+
+**Rescan Local Library:**
+```bash
+sudo mopidy local scan
+```
+
+**Config Location:**
+*   `/etc/mopidy/mopidy.conf` (System Service)
+*   `~/.config/mopidy/mopidy.conf` (User Mode)