|
1 | | -# pi-audio-feedback |
2 | 1 |
|
3 | | -Extension for the Pi Agent Harness that provides short audio cues for common Pi lifecycle events. |
| 2 | + |
| 3 | +`pi-audio-feedback` is an extension for the Pi Agent Harness (TUI only) that provides short audio cues for common Pi lifecycle events.</br> |
| 4 | + |
| 5 | +This can be useful for those wanting non-visual cues, for example when the agent finishes a task while running in the background.</br> |
| 6 | + |
| 7 | +The extension supports audio cues for the events: |
| 8 | ++ `agentStart` |
| 9 | ++ `agentSettled` |
| 10 | ++ `agentAborted` |
| 11 | ++ `toolError` |
| 12 | ++ `settings` |
| 13 | + |
| 14 | +## Themes |
| 15 | +Choose from 4 different audio themes: |
| 16 | ++ 🔊 **Core** |
| 17 | ++ 🔊 **Retro** |
| 18 | ++ 🔊 **Organic** |
| 19 | ++ 🔊 **Soft** |
| 20 | + |
| 21 | +All sounds are sourced from the [@web-kit/audio](https://audio.raphaelsalaja.com/) library, created by [@raphaelsalaja](https://github.com/raphaelsalaja).\ |
| 22 | +`pi-audio-feedback` captures each sound patch at build time and ships each sample as a `.wav` file. |
4 | 23 |
|
5 | 24 | ## Install |
6 | 25 |
|
7 | 26 | ```sh |
8 | 27 | pi install npm:pi-audio-feedback |
9 | 28 | ``` |
10 | 29 |
|
11 | | -## Audio Settings |
| 30 | +## Settings |
12 | 31 |
|
13 | | -Run the command from an idle Pi TUI: |
| 32 | +Run the command from pi TUI input: |
14 | 33 |
|
15 | 34 | ```text |
16 | 35 | /audio:config |
17 | 36 | ``` |
18 | 37 |
|
19 | | -The settings interface controls event cues and the active built-in audio theme. |
| 38 | +The user can control the playback of any sound (on/off) and choose from 1 of the 4 available audio themes. |
20 | 39 |
|
21 | 40 | ## Compatibility |
22 | 41 |
|
23 | 42 | - **Pi:** `@earendil-works/pi-coding-agent >=0.80.6 <1.0.0` |
24 | 43 | - **Node.js:** `>=20` |
25 | 44 | - **Supported local TUI platforms:** |
26 | | - - macOS 14+ Apple Silicon, Intel |
27 | | - - Windows 10+ x64, Windows PowerShell 5+ |
28 | | - - Linux Ubuntu/Debian 22+ x64, PipeWire/PulseAudio |
| 45 | + - macOS 14+ Apple Silicon 🟢 _tested_ |
| 46 | + - Windows 10+ x64, Windows PowerShell 5+ 🟢 _tested_ |
| 47 | + - Linux Ubuntu/Debian 22+ x64, PipeWire/PulseAudio ⚫️ _not tested_ |
29 | 48 | - WSL is explicitly unsupported. |
30 | 49 | - Audio is intentionally unavailable in non-TUI modes, including RPC, JSON, and print mode. Audio is |
31 | 50 | also suppressed in CI and SSH sessions. WSL, remote-host and remote-client playback, and other |
32 | 51 | non-interactive environments are unsupported. |
33 | 52 |
|
34 | 53 | ## License and notices |
35 | 54 |
|
36 | | -Package code, generated WAV files, and package documentation are licensed under the MIT License. See |
37 | | -[`LICENSE`](LICENSE). Licenses and attribution for third-party material used by bundled or generated |
| 55 | +Package code are licensed under the MIT License. See [`LICENSE`](LICENSE).\ |
| 56 | +Licenses and attribution for third-party material used by bundled or generated |
38 | 57 | assets are distributed in [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md). |
0 commit comments