This project is 99.99% LLM-Slop! This disclosure is probably the only human-written text in the whole thing.
muz is a code-driven music production engine. Write musical material and production
settings in .muz source, then check, audition, and render them with one Rust
program. The same source defines notes, performance timing, instruments, effects,
automation, and delivery variants.
Start with the getting-started guide, or use the documentation index to find a task or reference.
Linux is the exercised desktop platform. From this checkout, with the build prerequisites installed:
./install.sh
muz new ~/music/my-song
muz check ~/music/my-song/song.muz
muz render ~/music/my-song/song.muz -o out/my-song/mix.wavThe installer puts muz in Cargo's default binary directory and installs the
Muz CLAP plugin in the current user's default CLAP directory. Set CLAP_DIR to
choose a different plugin directory. It also copies contrib packs (and any assets
already downloaded in this checkout) to $XDG_DATA_HOME/muz/contrib, defaulting
to ~/.local/share/muz/contrib. Installed muz discovers that copy automatically;
no MUZ_CONTRIB_DIR export is needed. See pack setup
for downloading optional content into the installed tree.
The generated song uses native instruments and effects; it needs no downloaded samples or plugins. Offline checks and renders need no running audio service. Live playback uses PipeWire:
muz serve ~/music/my-song/song.muz --stoppedLeave that process running and use muz audition opening in another terminal.
Read the workflow guide for transport, live edits, inspection,
and render jobs. muz docs displays the documentation index offline.
| Task | Capabilities | Guide |
|---|---|---|
| Compose | Notes, harmony, drum grids, MIDI, reusable passages, and local revisions | Language |
| Shape a performance | Articulation, timing, pedals, note expression, and bounded piano checks | Performance |
| Choose or design sounds | Synths, samplers, programmable voice graphs, VST3 and CLAP plugins | Instruments, synthesis |
| Mix and deliver | Buses, effects, sidechains, automation, mixes, stems, and named batches | Production, workflow |
| Hand off to a DAW | Editable DAWProject export with a fidelity report | DAWProject |
| Embed the engine | Rust library with host-supplied source, assets, and audio output | Embedding |
This checkout holds the engine in src/, readable source libraries in
std/, and small technique demonstrations in examples/.
Optional third-party instrument setups live in contrib/.
Their recordings and plugin binaries are installed separately.
Projects can live wherever you keep your music; ~/music/my-song above is only
an example. This engine repository does not store personal pieces, generated
media, or external recordings. Contributors and agents working in this checkout
should read AGENTS.md and the
composer friction protocol for its local conventions.
muz is pre-alpha. Linux is the exercised desktop target, plugin coverage is limited, and musical searches and runtime resources are bounded. Compatibility and future-render reproducibility are not guaranteed. There is no graphical editor, recording or comping workflow, or time stretching. The friction log tracks unresolved engine and language issues encountered during composition.