nvrl
b3ebe4d952
Check and Windows preview / check (anvil) (push) Successful in 2m8s
Check and Windows preview / check (crucible) (push) Successful in 1m32s
Check and Windows preview / check (lathe) (push) Successful in 2m13s
Check and Windows preview / check (patina) (push) Successful in 2m5s
Check and Windows preview / check (rivet) (push) Successful in 1m34s
Check and Windows preview / check (temper) (push) Successful in 2m12s
Check and Windows preview / previews (push) Successful in 1m19s
Check and Windows preview / windows (push) Successful in 2m13s
Independent plugin release / publish (push) Successful in 8s
Independent plugin release / plan (push) Successful in 6s
Independent plugin release / build (push) Successful in 2m57s
Lathe places EQ bands on harmonics 1-32 of the played note, so a cut on harmonic 3 stays on harmonic 3 on every note. Temper normalises each note's level before an oversampled shaper and tunes its floor, push and bright filters to the note, so every note distorts the same. The note tracker moves from Anvil into common-dsp, together with a state-variable filter, 4x oversampler and harmonic meter. Anvil's behaviour and editor render are unchanged. docs/ideas.md collects all plugin ideas and their status.
103 lines
5.1 KiB
Markdown
103 lines
5.1 KiB
Markdown
# Rivet & Patina
|
|
|
|
Six Rust CLAP plugins for writing, designing and mixing bass music.
|
|
|
|
| Plugin | Purpose | Guide |
|
|
| --- | --- | --- |
|
|
| **Rivet** | Tell a MIDI motif as a story on a storyboard of roles, with joined seams | [Rivet](docs/rivet/README.md) |
|
|
| **Patina** | Smooth harsh resonances while retaining tone and transient character | [Patina](docs/patina/README.md) |
|
|
| **Anvil** | Give every bass note the same clean sub: one level, one start phase | [Anvil](docs/anvil/README.md) |
|
|
| **Crucible** | Capture the last bars, slice them and export clean, key-labelled samples | [Crucible](docs/crucible/README.md) |
|
|
| **Lathe** | EQ the harmonics of the played note: a cut on harmonic 3 stays on harmonic 3 | [Lathe](docs/lathe/README.md) |
|
|
| **Temper** | Distort every note the same: level and tone filters follow the note | [Temper](docs/temper/README.md) |
|
|
|
|
The names come from metalwork: a **rivet** joins pieces; **patina** changes a
|
|
surface while leaving its character; an **anvil** is the solid base everything is
|
|
struck on; a **crucible** melts material down to be cast again; a **lathe** turns
|
|
a piece so each cut lands the same all the way round; **tempering** sets how hard
|
|
and how tough a metal ends up. They share a Rust foundation and keep their own
|
|
musical purpose, code, documentation, and version. Ideas for further plugins are
|
|
collected in [docs/ideas.md](docs/ideas.md).
|
|
|
|
## Install
|
|
|
|
Download the desired plugin's Windows ZIP from its Gitea release. Extract it
|
|
and copy its `.clap` file (`Rivet.clap`, `Patina.clap`, `Anvil.clap`,
|
|
`Crucible.clap`, `Lathe.clap` or `Temper.clap`) into:
|
|
|
|
```text
|
|
C:\Program Files\Common Files\CLAP\
|
|
```
|
|
|
|
In FL Studio 2024.1 or newer, open **Options → Manage plugins**, enable
|
|
**Verify plugins**, and **Find installed plugins**. Load Rivet in the Channel Rack;
|
|
load the others in mixer effect slots.
|
|
|
|
Normal branch/PR pipelines also provide a combined Windows preview ZIP in the
|
|
**windows** job. Releases are separate: tags such as `rivet-v0.4.0`,
|
|
`patina-v0.2.0`, `anvil-v0.1.0`, `crucible-v0.1.0`, `lathe-v0.1.0` and
|
|
`temper-v0.1.0` publish independently. See [release workflow](docs/releases.md).
|
|
|
|
These names replace Motif Storyboard and Resonance Compressor. Their CLAP IDs
|
|
and saved-state identifiers are preserved; replace old scanned copies and rescan.
|
|
|
|
## Repository
|
|
|
|
```text
|
|
plugins/
|
|
catalog.json Product metadata used by build and release tools
|
|
rivet/
|
|
core/ Motifs, harmony, variation, history, performance
|
|
midi/ Standard MIDI import/export
|
|
app/ Worker jobs and real-time audition control
|
|
preview/ Offline MIDI/WAV development tool
|
|
plugin/ CLAP wrapper, editor, optional standalone
|
|
patina/
|
|
core/ Spectral detector and attenuation engine
|
|
ui/ Patina's native editor
|
|
render/ Offline WAV evaluation
|
|
plugin/ CLAP audio-effect wrapper
|
|
anvil/
|
|
core/ Pitch tracking, crossover and sub oscillator
|
|
ui/ Anvil's native editor
|
|
plugin/ CLAP audio-effect wrapper with MIDI input
|
|
crucible/
|
|
core/ Input history, capture, slicing, cleanup and export
|
|
ui/ Crucible's native editor
|
|
plugin/ CLAP audio-effect wrapper
|
|
lathe/
|
|
core/ Harmonic band bank tuned to the tracked note
|
|
ui/ Lathe's native editor
|
|
plugin/ CLAP audio-effect wrapper with MIDI input
|
|
temper/
|
|
core/ Note-tracked filters, level normalising, oversampled shaper
|
|
ui/ Temper's native editor
|
|
plugin/ CLAP audio-effect wrapper with MIDI input
|
|
common/
|
|
ui/ Shared look: palette, embedded fonts, knobs and panels
|
|
dsp/ Shared filters, note tracking, oversampling, meters, WAV files
|
|
tools/editor-check/ Headless visual QA for all editors
|
|
scripts/ Shared build, packaging, release, and analysis tools
|
|
docs/<plugin>/ Guide, changelog and editor preview per plugin
|
|
references/ Local reference audio; excluded from distribution
|
|
```
|
|
|
|
The root Cargo workspace contains the engines and supporting tools. Each CLAP
|
|
wrapper has an independent workspace and lockfile so SDK dependencies stay
|
|
separate. [Development and testing](docs/development.md) covers the commands.
|
|
|
|
```sh
|
|
cargo test --workspace --locked
|
|
python scripts/build-plugin.py --plugin rivet --target x86_64-pc-windows-gnu
|
|
python scripts/build-plugin.py --plugin patina --target x86_64-pc-windows-gnu
|
|
python scripts/build-plugin.py --plugin anvil --target x86_64-pc-windows-gnu
|
|
python scripts/build-plugin.py --plugin crucible --target x86_64-pc-windows-gnu
|
|
python scripts/build-plugin.py --plugin lathe --target x86_64-pc-windows-gnu
|
|
python scripts/build-plugin.py --plugin temper --target x86_64-pc-windows-gnu
|
|
python scripts/package-windows.py
|
|
```
|
|
|
|
Windows is the release target. Linux remains useful for tests, cross-compilation,
|
|
and headless editor previews. FL Studio routing, native window behavior, and
|
|
artistic listening still require manual checks in the target setup.
|