From 93a724bb01521103564df458af0cb1dc14ee6ad9 Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Wed, 5 Feb 2025 03:54:04 +0300
Subject: [PATCH] add manual ipc request instructions

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

diff --git a/README.md b/README.md
index 985092c7..153b4c68 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,13 @@ with a wrapper library, a CLI and a server for remote control.
 
 ## Hacking
 
+Both CLI and server utilities require mpv to be started with the IPC socket
+enabled.
+
+```bash
+mpv --idle --input-ipc-server=/tmp/mpvsocket
+```
+
 mrc does not handle TLS certificates for you. To run the remote control server,
 you must create your own PKCS#12 certificates using OpenSSL.
 
@@ -30,3 +37,12 @@ Then start the server with `cargo run --bin=server`.
 
 How you handle environment is up to you, Systemd makes it somewhat easy if
 running mrc as a service.
+
+### Testing mpv IPC socket
+
+If you suspect some IPC commands are not being sent properly, try sending them
+manually first with something like socat.
+
+```bash
+echo '{ "command": ["pause"] }' | socat - /tmp/mpvsocket
+```