aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index de500c1..5a8cc92 100644
--- a/README.md
+++ b/README.md
@@ -91,6 +91,18 @@ The example tools only read:
- `vms`: libvirt VMs and their state, or one VM's details, through `virsh`
read commands
+## Overlay
+
+The assistant broadcasts its state, context use, the running tool and the
+audio levels as JSON lines on `$XDG_RUNTIME_DIR/desktop-assistant.sock`
+(mode 0600). The overlay is the `assistant/` component of the quickshell
+repo: a circle with the name, `used / max` context and the tool, pulsing
+dots while it transcribes or thinks, and a ring of ripples following your
+voice and the reply. It fades out after the reply. Name, position, delay
+and colours are the `[overlay]` table in `config.toml`. With no overlay
+running the assistant works the same. A press ignored in presentation or
+gaming mode sends a normal-urgency notification instead.
+
## License
Copyright (C) 2026 Danilo M. <danix@danix.xyz>