59 lines
961 B
Markdown
59 lines
961 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
|
|
- Chat input history (Up/Down arrow navigation)
|
|
- Self-deafen toggle
|
|
|
|
## Key Bindings
|
|
|
|
| Key | Action |
|
|
|-----|--------|
|
|
| `F1` | Toggle self-deafen |
|
|
| `F4` | Push-to-talk (configurable) |
|
|
| `Enter` | Send message |
|
|
| `Up` | Previous sent message (in chat input) |
|
|
| `Down` | Next sent message (in chat input) |
|
|
| `q` | Quit |
|
|
| `Ctrl+C` | Quit |
|
|
|
|
## 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 = "f4"
|
|
mode = "hold"
|
|
backend = "auto"
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- Python 3.11+
|
|
- libopus
|
|
- portaudio (libportaudio2)
|
|
- A Mumble server to connect to
|