diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 32 insertions, 6 deletions
@@ -1,15 +1,41 @@ -## Dumb Voice Protocol +<div align="center"> +<img src="https://github.com/catilgrass/dumb-voice-protocol/blob/master/icon/icon.ico" width="30%" /> +</div> -# Intro +<h1 align="center"> + Dumb Voice Protocol +</h1> -This is a CLI program that reads your microphone device and outputs information to stdout / ipc. +## Introduction -# Usage +A "dumb" voice input terminal based on [vtx-engine](https://github.com/keathmilligan/vtx-engine) and [Whisper](https://github.com/openai/whisper) — reads from microphone, transcribes to text, sends it to your game or tool. + +Supports multiple output methods: stdout / stderr / TCP / UDP / UDP broadcast / IPC, suitable for various scenarios. + +## Usage + +1. Go to [Releases](https://github.com/catilgrass/dumb-voice-protocol/releases) and download the latest version +2. Unzip, edit `dmvop.toml` to configure +3. Double-click `dmvop.exe` and start speaking + +## Usage (CLI) + +1. Go to [Releases](https://github.com/catilgrass/dumb-voice-protocol/releases) and download +2. Open a terminal, run `dmvop -h` to see options +3. Speak into the microphone + +Common examples: ``` -dmvop --help +dmvop # Load dmvop.toml from current directory +dmvop --device="My Mic" -O=stdout # Voice → terminal +dmvop --device="My Mic" -O=tcp -O=stdout # Voice → game + terminal +dmvop --device="My Mic" -O=udp-broadcast # Voice → LAN broadcast + +dmvop --list-devices # List microphone devices +dmvop --download-model=small # Download whisper model ``` -# License +## License Under WTFPL |