Fast test implementation of a midi-fader based software
Go to file
Dandaedre db41daaaf8
refactor: simplify TUI quick help
Keep the footer focused on non-obvious actions, split Add/Edit/Delete labels, and move Home/End guidance into the detailed keyboard popup.

Tests: cargo fmt --all -- --check; cargo check --workspace --all-targets --all-features; cargo test --workspace --all-targets --all-features; cargo test --workspace --doc --all-features; cargo clippy --workspace --all-targets --all-features -- -D warnings; cargo build --workspace --release --all-features (all pass; real-daemon tests remain opt-in).
2026-10-18 11:13:07 +02:00
config feat: add confirmed TUI profile reset 2026-10-18 11:10:41 +02:00
core feat(M1.4): reserve stateful relative groups 2026-10-15 03:14:36 +02:00
docs docs(M12.4): record verified RC publication and build provenance 2026-10-16 21:11:50 +02:00
examples/profiles feat: configure pickup status presentation 2026-10-16 19:11:40 +02:00
fader_master feat: add confirmed TUI profile reset 2026-10-18 11:10:41 +02:00
midi feat: reflect confirmed mute state over MIDI 2026-10-15 23:55:29 +02:00
scripts release(M12.4): mark 0.1.0-rc.1 candidate 2026-10-16 20:00:42 +02:00
sound feat(M7.4): make runtime polling configurable 2026-10-15 03:54:10 +02:00
tui refactor: simplify TUI quick help 2026-10-18 11:13:07 +02:00
.gitignore build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
AGENTS.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
CHANGELOG.md docs(M12.4): record verified RC publication and build provenance 2026-10-16 21:11:50 +02:00
Cargo.lock release(M12.4): mark 0.1.0-rc.1 candidate 2026-10-16 20:00:42 +02:00
Cargo.toml release(M12.4): mark 0.1.0-rc.1 candidate 2026-10-16 20:00:42 +02:00
Cross.toml build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
Jenkinsfile ci: export native backend parameter 2026-10-15 19:44:04 +02:00
LICENSE Cargo init + license 2025-03-24 15:31:04 +01:00
README.md feat: add confirmed TUI profile reset 2026-10-18 11:10:41 +02:00
architecture.md refactor: simplify TUI quick help 2026-10-18 11:13:07 +02:00
checklist.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
release.sh build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
rust-release.toml build(M12.4): prepare guarded Gitea release wrapper 2026-10-16 19:59:16 +02:00
rust-toolchain.toml build(M0.1): pin reproducible Rust foundation 2026-10-05 07:47:49 +02:00
task.md refactor: simplify TUI quick help 2026-10-18 11:13:07 +02:00

README.md

fader_master

Version Tests Coverage

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.

Horizontal mixer showing application, group, and output faders

The horizontal layout puts bottom-up faders side by side, with dividers and flexible spacers between sections. Switch to Vertical in Config for stacked cards, including one-row Slim and Bordered slim faders:

Vertical mixer showing stacked faders and separators

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, separators, and empty spacers directly in the mixer. Choose Slim, Bordered slim, Standard, or Thick faders, and hide detail faders behind a group when useful.
  • Size separators independently and choose Plain, Line, Double line, or Box. Fill separators share spare space; names are optional.
  • Use horizontal or vertical layouts and six built-in terminal themes.
  • Choose Detailed, Compact, Symbol, Color, or Hidden pickup feedback in Config. Hiding the indicator keeps pickup protection active.
  • 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.
  • Switch among valid managed profiles from a popup in the Config view; the default switch adopts live audio without writing saved volume state.
  • Reset the active profile from Config after an explicit confirmation. The TUI preserves the previous file as <profile>.toml.reset.bak before installing and activating a safe Master-output profile.

Quick start

With cargo-binstall installed, download the current release candidate without compiling:

cargo binstall --git https://proxy.dandaedre.com/gitea/MadGobblins/fader_master \
  --version '=0.1.0-rc.1' --strategies crate-meta-data fader_master
fader_master

This installs the combined launcher plus fader_master_server and fader_master_client. Ensure Cargo's binary directory (usually ~/.cargo/bin) is on your PATH. No repository checkout or sample configuration is needed.

Prebuilt binaries currently target x86-64 GNU/Linux and require ALSA, libpulse and libudev runtime libraries, plus PulseAudio or pipewire-pulse. They are built with an Ubuntu 24.04-based image; older distributions are not yet qualified. This is an RC, not a stable release.

Without cargo-binstall, download the archive containing all three executables from the release page, verify it against the accompanying SHA256SUMS, and extract the executables into a directory on your PATH.

First launch

The combined executable connects to an existing per-user server when possible and starts an embedded one otherwise. Running without --config creates a default profile with a Master-output fader. A sole detected MIDI input is adopted as the default controller; otherwise choose a detected input in Config, add it, and Save. Edit the Master fader with E to learn volume and mute controls.

Build from source (alternative)

For development or systems without compatible prebuilt binaries, follow the build prerequisites. From a source checkout, run:

cargo run --locked -p fader_master

See advanced configuration for explicit profiles and separate server/client operation.

The screenshots use reproducible example state rendered by the actual TUI; they do not represent a live hardware session.

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. Config → Active profile opens the profile switcher. Config → Reset active profile provides an emergency return to safe defaults; confirming it immediately saves and activates the reset and keeps a .reset.bak copy beside the profile. Separator editing offers an optional name, size, and decoration; an empty name with Plain + Fill creates flexible blank space. Press Enter to accept popup edits, then use Config → Save to persist the draft.

After updating the binaries, restart the server as well as the client. The combined launcher reuses an already-running server.

Documentation

The documentation index contains installation instructions, advanced configuration and process layouts, examples, troubleshooting notes, architecture, project status, and related projects.

License

See LICENSE.