diff options
| author | Danilo M. <danix@danix.xyz> | 2026-09-26 09:56:08 +0200 |
|---|---|---|
| committer | Danilo M. <danix@danix.xyz> | 2026-09-26 09:56:08 +0200 |
| commit | 746e8c05512675b1c059d73f5f54d977d5e8e8e3 (patch) | |
| tree | 119b93af42a688a46120dab6b1eb1bb65541fe68 /README.md | |
| parent | 3b6c7bf876526717d940080b84ee58026b57e853 (diff) | |
| download | desktop-assistant-746e8c05512675b1c059d73f5f54d977d5e8e8e3.tar.gz desktop-assistant-746e8c05512675b1c059d73f5f54d977d5e8e8e3.zip | |
Document the overlay and record its findings
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -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> |