Skip to content

Commit 33353ef

Browse files
committed
Update README.md
1 parent a895fa6 commit 33353ef

1 file changed

Lines changed: 29 additions & 10 deletions

File tree

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,57 @@
1-
# pi-audio-feedback
21

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.
423

524
## Install
625

726
```sh
827
pi install npm:pi-audio-feedback
928
```
1029

11-
## Audio Settings
30+
## Settings
1231

13-
Run the command from an idle Pi TUI:
32+
Run the command from pi TUI input:
1433

1534
```text
1635
/audio:config
1736
```
1837

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.
2039

2140
## Compatibility
2241

2342
- **Pi:** `@earendil-works/pi-coding-agent >=0.80.6 <1.0.0`
2443
- **Node.js:** `>=20`
2544
- **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_
2948
- WSL is explicitly unsupported.
3049
- Audio is intentionally unavailable in non-TUI modes, including RPC, JSON, and print mode. Audio is
3150
also suppressed in CI and SSH sessions. WSL, remote-host and remote-client playback, and other
3251
non-interactive environments are unsupported.
3352

3453
## License and notices
3554

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
3857
assets are distributed in [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).

0 commit comments

Comments
 (0)