Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

reaper-assets

Python package (reaper-assets, in this reaper-ip-tools repo) that writes REAPER .rpp session templates and matching docs. Stock FX chunks were copied from REAPER-saved projects; three of those are kept in tests/fixtures/ and the tests compare against them. No third-party dependencies (Python ≥ 3.9).

Install

uv sync --group dev        # or: pip install -e .
reaper-assets --version

CLI

# List named templates
reaper-assets templates

# Generate a template (RPP + docs)
reaper-assets generate --template podcast -o ./podcast_session

# Generate from a custom JSON spec
reaper-assets generate --spec my_spec.json -o ./out

# Idempotently add tracks to an existing project
reaper-assets merge ./existing.rpp --track "GUEST 3" --track "MUSIC BED"

# Validate a project (structural + optional REAPER round-trip)
reaper-assets validate ./out/podcast.rpp --round-trip

# Verify FX references resolve to real plugin UIDs
reaper-assets check-plugins --template podcast --map reaper_plugin_map.json

Python API

from reaper_assets import generate_rpp_string, catalog, validate

spec = catalog.get_template("podcast")
text = generate_rpp_string(spec)
assert validate.validate_rpp(text) == []
open("podcast.rpp", "w").write(text)

Templates

podcast, mixing, mastering, live, scoring (see catalog.py).

Project layout

src/reaper_assets/
  builder.py    ReaperProjectBuilder, write_track/master/envelope
  project.py    generate_rpp_string / generate_rpp_project (assembly)
  fx.py         verified stock Cockos FX + PluginResolver (real UIDs)
  routing.py    AUXRECV sends + folder (ISBUS) encoding
  markers.py    MARKER / REGION emission
  catalog.py    named session templates
  docsgen.py    session_map.md / routing_matrix.md / track_layout.csv
  merge.py      idempotent track insertion
  validate.py   structural + REAPER round-trip validation
  version.py    REAPER version detection
  cli.py        command-line interface

Companion scripts:

  • extract_reaper_uuids.py / .lua — dump plugin name -> uid from REAPER's ini.
  • extract_stock_fx.py — re-extract stock FX state from Project Templates.

ReaScripts (Lua, run inside REAPER; not covered by the Python tests): None shipped in this release. The Lua ReaScripts (extract_reaper_uuids.lua, plugin_map_generator.lua, fx_inserter.lua, generate_reaper_assets.lua, session_generator.lua, rpp_helpers.lua and podcast_template/bootstrap.lua) plus index.xml were removed so the ReaPack feed 404s (see commit d94f85a). The repo therefore cannot be installed via ReaPack as documented, and podcast_template/template.RPP is a stub that awaits bootstrap.lua to materialize it.

The one REAPER-targeted script that is shipped is the EEL2 asset emitted by generate_reaper_assets.py (clean_slate_reset.eel); its API calls are verified against the official ReaScript/EEL2 API in QA (see AUDIT_REPORT.md), but it is not execution-tested (no REAPER install in CI).

Tests

uv run pytest — 45 passed (checked 2026-10-31, Linux, Python 3.12). All CLI commands above were run on that date; validate --round-trip prints [SKIP] and exits 0 when no REAPER executable is found.

Notes / limitations

  • Third-party plugin state is not reproducible from reaper-vstplugins64.ini (identity only). PluginResolver prevents fabricated UIDs; full state emission is supported only for the verified stock Cockos plugins.
  • Folder depth is single-level (parent / child / end). Nested folders are not emitted.
  • REAPER round-trip is opt-in and requires a REAPER install; it renders the project headlessly and treats a clean exit as proof of successful parsing.

Licence

MIT. See LICENSE.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages