Getting Started Version 1.1Updated 26 Sep 2026

Package layout

A Yrendr plugin package is a directory containing a manifest and a Python entrypoint. Plugin Manager can install the directory from a supported ZIP layout.

Minimal package

my_plugin/
├── plugin.json
└── plugin.py

Additional assets can live beside the entrypoint:

my_plugin/
├── plugin.json
├── plugin.py
└── assets/
    └── impulse.npy

Build an installable ZIP

  1. Create plugin.json and the configured entrypoint, normally plugin.py.
  2. Keep supporting assets inside the plugin directory.
  3. Zip either the files directly at archive root or one top-level plugin directory containing plugin.json.
  4. Install the ZIP through Plugin Manager.
  5. Confirm that the package loads and its registered effects/processors appear.

Note: Yrendr loads the configured entrypoint directly from its file path rather than importing the plugin as a normal Python package. Do not rely on implicit package-relative imports unless you explicitly make that structure work.

Replacement and precedence

Installing a user package with an existing plugin ID replaces the previous user package with that ID. Bundled plugins take precedence if both bundled and user packages declare the same ID.