docs: the OBS pill

1 files changed, 19 insertions, 0 deletions

diff --git a/desktop/island/README.md b/desktop/island/README.md
index 381f536..54a40a6 100644
--- a/desktop/island/README.md
+++ b/desktop/island/README.md
@@ -71,6 +71,25 @@ second while hovered. A click on the bar seeks, only when the player reports
 `canSeek` and a known length. The wheel over the pill goes to the previous track (up)
 or the next (down), one per notch.
 
+## OBS pill
+
+Right of the status pill, while OBS Studio runs with its WebSocket server
+enabled (Tools > WebSocket Server Settings; auth stays on, the server
+listens on every interface). `Obs.qml` speaks obs-websocket v5 directly
+and reads the password from OBS's own `obs-websocket/config.json`, so no
+copy of it exists; `obs-auth.sh` computes the SHA256 handshake QML cannot.
+
+At rest it shows a record dot, with the elapsed time while recording. A
+click opens its panel in the capsule: Record or Stop, Pause or Resume
+(while recording), Show or Hide webcam (the first `v4l2_input` item in the
+current scene; absent without one), and the scene list, current one
+highlighted, click to switch. While recording the sliver pulses red, and
+holds dim while paused.
+
+QML's `WebSocket` does not expose the close code, so a wrong password
+reads the same as OBS quitting; it is logged once as "closed before
+Identified".
+
 ## Controls panel (removed)
 
 There was one, opened by SUPER alone. Each of its seven tiles opened a drawer