Check and Windows preview / check (patina) (push) Successful in 2m20s
Check and Windows preview / check (rivet) (push) Successful in 1m38s
Check and Windows preview / previews (push) Successful in 1m6s
Check and Windows preview / windows (push) Successful in 1m50s
Independent plugin release / publish (push) Successful in 8s
Independent plugin release / plan (push) Successful in 7s
Independent plugin release / build (push) Successful in 2m21s
71 lines
3.0 KiB
Markdown
71 lines
3.0 KiB
Markdown
# Rivet & Patina
|
|
|
|
Two Rust CLAP plugins for writing and refining bass music.
|
|
|
|
| Plugin | Purpose | Guide |
|
|
| --- | --- | --- |
|
|
| **Rivet** | Join motifs into connected phrases, preserve identity, and explore branches | [Rivet](docs/rivet/README.md) |
|
|
| **Patina** | Smooth harsh resonances while retaining tone and transient character | [Patina](docs/patina/README.md) |
|
|
|
|
The names come from metalwork: a **rivet** joins pieces; **patina** changes a
|
|
surface while leaving its character. They share a Rust foundation and keep
|
|
their own musical purpose, code, documentation, and version.
|
|
|
|
## Install
|
|
|
|
Download the desired plugin's Windows ZIP from its Gitea release. Extract it
|
|
and copy `Rivet.clap` or `Patina.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 Patina in a mixer effect slot.
|
|
|
|
Normal branch/PR pipelines also provide a combined Windows preview ZIP in the
|
|
**windows** job. Releases are separate: `rivet-v0.3.0` and `patina-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/ Shared native editor and embedded fonts
|
|
render/ Offline WAV evaluation
|
|
plugin/ CLAP audio-effect wrapper
|
|
tools/editor-check/ Headless visual QA for both editors
|
|
scripts/ Shared build, packaging, release, and analysis tools
|
|
docs/rivet/ Rivet guide, theory, research, and editor previews
|
|
docs/patina/ Patina guide, research, and editor preview
|
|
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/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.
|