fader_master/README.md

37 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# fader_master
![Version](https://assets.dandaedre.com/coverage/MadGobblins/fader_master/main/version.svg)
![Tests](https://assets.dandaedre.com/coverage/MadGobblins/fader_master/main/test.svg)
![Coverage](https://assets.dandaedre.com/coverage/MadGobblins/fader_master/main/coverage.svg)
Linux application volume and mute control from one or more USB MIDI surfaces.
This repository currently contains tested domain and configuration libraries plus
an interactive TUI shell. The domain layer supports matching, routing, balanced
group volume plans, and mute intent. Atomic TOML persistence and checkpointing are
implemented; the server, audio adapters, persistent bindings, and configuration
editor remain planned in the following documents:
- [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 TUI
```sh
cargo run --locked -p fader_master
```
Use the arrow keys to move the demo fader, Home/End for its endpoints, and Q or
Escape to quit. The screen currently uses local demo state; live server and audio
integration follow in M3–M8.
# References
* [pwvucontrol](https://github.com/saivert/pwvucontrol/blob/main/src/backend/pwnodeobject/mixerapi.rs)
* [ratatui](https://ratatui.rs/)
* [midir](https://github.com/Boddlnagg/midir)