77 lines
3.2 KiB
Markdown
77 lines
3.2 KiB
Markdown
# fader_master
|
|
|
|

|
|

|
|

|
|
|
|
Control Linux application volume and mute from a USB MIDI controller. One
|
|
fader can follow an application, a group of applications, or the default audio
|
|
output, while the terminal UI remains useful as a complete software mixer.
|
|
|
|

|
|
|
|
The horizontal layout puts conventional bottom-up faders side by side. The
|
|
same profile can switch to a compact stacked layout for narrow terminals:
|
|
|
|

|
|
|
|
## Features
|
|
|
|
- Match PulseAudio or `pipewire-pulse` streams by application metadata, with
|
|
exact and regular-expression capture rules.
|
|
- Control individual applications, non-nesting application groups, and the
|
|
default output without changing live audio during discovery.
|
|
- Learn volume and mute controls from MIDI, reflect confirmed mute state on
|
|
control-surface LEDs, use pickup to prevent jumps, and
|
|
keep independently identified controllers from colliding.
|
|
- Arrange faders and named separators directly in the mixer. Choose Slim,
|
|
Bordered slim, Standard, or Thick faders, and hide detail faders behind a
|
|
group when useful.
|
|
- Use horizontal or vertical layouts and six built-in terminal themes.
|
|
- Run as one command, or keep a standalone server alive while reconnecting TUI
|
|
clients come and go.
|
|
- Edit a validated draft from the TUI and persist it with one explicit Save.
|
|
Malformed or conflicting edits never replace the active configuration.
|
|
|
|
## Quick start
|
|
|
|
Install the platform dependencies described in the
|
|
[documentation index](docs/README.md), then run the combined server and TUI
|
|
with the sample PipeWire/Pulse profile:
|
|
|
|
```sh
|
|
cargo run --locked -p fader_master -- \
|
|
--config examples/profiles/arch-pipewire.toml --audio pulse
|
|
```
|
|
|
|
The combined executable connects to an existing per-user server when possible
|
|
and starts an embedded one otherwise. Running without `--config` creates a
|
|
safe empty `default` profile on first use, which can then be edited in the TUI.
|
|
|
|
## Everyday controls
|
|
|
|
| Action | Vertical | Horizontal |
|
|
|---|---|---|
|
|
| Select | Up/Down or J/K | Left/Right or J/K |
|
|
| Change volume | Left/Right | Up/Down |
|
|
| Reorder | Shift+Up/Down or Shift+J/K | Shift+Left/Right or Shift+J/K |
|
|
| Toggle mute | M | M |
|
|
| Edit fader or separator | E | E |
|
|
| Add/remove separator | A / D | A / D |
|
|
| Hide selected fader | Shift+H | Shift+H |
|
|
| Help | h or ? | h or ? |
|
|
|
|
Use `Tab` to open Config, `T` to cycle the theme, and `Q` to open the quit
|
|
confirmation. Fader editing exposes capture rules, group membership, separate
|
|
controller/Learn/Unlearn actions for volume and mute, size, and visibility.
|
|
|
|
## Documentation
|
|
|
|
The [documentation index](docs/README.md) contains installation instructions,
|
|
advanced configuration and process layouts, examples, troubleshooting notes,
|
|
architecture, project status, and related projects.
|
|
|
|
## License
|
|
|
|
See [LICENSE](LICENSE).
|