Core modules: TUI app (textual), mumble protocol client, audio pipeline (sounddevice + opus), push-to-talk with kitty protocol / evdev / toggle backends. Config via TOML.
45 lines
616 B
Markdown
45 lines
616 B
Markdown
# tuimble
|
|
|
|
TUI Mumble client with voice support and push-to-talk.
|
|
|
|
## Features
|
|
|
|
- Terminal-based UI (Textual)
|
|
- Voice transmission with Opus codec
|
|
- Push-to-talk via Kitty keyboard protocol, evdev, or toggle
|
|
- Channel browsing and text chat
|
|
|
|
## Quick Start
|
|
|
|
```sh
|
|
make setup
|
|
make run
|
|
```
|
|
|
|
## Configuration
|
|
|
|
```sh
|
|
mkdir -p ~/.config/tuimble
|
|
```
|
|
|
|
`~/.config/tuimble/config.toml`:
|
|
|
|
```toml
|
|
[server]
|
|
host = "mumble.example.com"
|
|
port = 64738
|
|
username = "myname"
|
|
|
|
[ptt]
|
|
key = "space"
|
|
mode = "hold"
|
|
backend = "auto"
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- Python 3.11+
|
|
- libopus
|
|
- portaudio (libportaudio2)
|
|
- A Mumble server to connect to
|