colin/abaddon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ouwou
2023-08-25 21:06:01 -04:00
parent a05a259393
commit 67ee13dc1e
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -151,6 +151,7 @@ spam filter's wrath:
* [miniaudio](https://miniaud.io/) (optional, provided as submodule, required for voice) * [miniaudio](https://miniaud.io/) (optional, provided as submodule, required for voice)
* [libopus](https://opus-codec.org/) (optional, required for voice) * [libopus](https://opus-codec.org/) (optional, required for voice)
* [libsodium](https://doc.libsodium.org/) (optional, required for voice) * [libsodium](https://doc.libsodium.org/) (optional, required for voice)
* [rnnoise](https://gitlab.xiph.org/xiph/rnnoise) (optional, provided as submodule, noise suppression and improved VAD)
### TODO: ### TODO:
@@ -320,6 +321,12 @@ For example, memory_db would be set by adding `memory_db = true` under the line
| `enabled` | boolean | true (if not on Windows) | Enable desktop notifications | | `enabled` | boolean | true (if not on Windows) | Enable desktop notifications |
| `playsound` | boolean | true | Enable notification sounds. Requires ENABLE_NOTIFICATION_SOUNDS=TRUE in CMake | | `playsound` | boolean | true | Enable notification sounds. Requires ENABLE_NOTIFICATION_SOUNDS=TRUE in CMake |
#### voice
| Setting | Type | Default | Description |
|---------|--------|------------------------------------|------------------------------------------------------------|
| vad | string | rnnoise if enabled, gate otherwise | Method used for voice activity detection. Changeable in UI |
### Environment variables ### Environment variables
| variable | Description | | variable | Description |