52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# fader_master
|
|
|
|

|
|

|
|

|
|
|
|
Linux application volume and mute control from one or more USB MIDI surfaces.
|
|
|
|
This repository contains tested domain and configuration libraries, a PulseAudio
|
|
protocol worker compatible with `pipewire-pulse`, a local per-user server, and a
|
|
live terminal mixer. The domain layer supports matching, routing, balanced group
|
|
volume plans, and mute intent. Atomic TOML persistence, checkpointing, and live
|
|
profile application/group aggregation are implemented; persistent MIDI
|
|
lifecycle, pickup/feedback, and the configuration editor remain on the ordered
|
|
backlog:
|
|
|
|
- [Architecture and library research](architecture.md)
|
|
- [Implementation tasks and acceptance tests](task.md)
|
|
- [Project-agent instructions and test/commit workflow](AGENTS.md)
|
|
- [Build prerequisites and MSRV](docs/build.md)
|
|
- [CI coverage and badge lifecycle](docs/ci-coverage.md)
|
|
- [Hands-on functional checklist](checklist.md)
|
|
|
|
## Run the live TUI
|
|
|
|
Start the server in one terminal:
|
|
|
|
```sh
|
|
cargo run --locked -p fader_master -- serve \
|
|
--config examples/profiles/arch-pipewire.toml --audio pulse
|
|
```
|
|
|
|
Then start the client in another:
|
|
|
|
```sh
|
|
cargo run --locked -p fader_master -- tui
|
|
```
|
|
|
|
Use Up/Down or J/K to select a configured application or group, Left/Right to
|
|
change its volume, M to toggle mute, T to cycle the built-in themes, and Q or
|
|
Escape to quit. Pass `--theme dracula`, `nord`, `gruvbox-dark`,
|
|
`catppuccin-mocha`, or `solarized-dark` to choose an initial theme. Offline
|
|
objects remain visible, and aggregate rows show `MIXED` when member state
|
|
differs. See the hands-on checklist for the exact milestone scope and
|
|
restoration steps.
|
|
|
|
# References
|
|
|
|
* [pwvucontrol](https://github.com/saivert/pwvucontrol/blob/main/src/backend/pwnodeobject/mixerapi.rs)
|
|
* [ratatui](https://ratatui.rs/)
|
|
* [midir](https://github.com/Boddlnagg/midir)
|