Getting Started Version 1.0Updated 26 Sep 2026

plugin.json manifest

plugin.json describes the plugin package and tells Yrendr which Python file to load.

Example manifest

JSON

{
  "id": "woaby.example",
  "name": "Example Plugin",
  "version": "1.0.0",
  "author": "Woaby",
  "description": "Example Yrendr plugin package.",
  "entrypoint": "plugin.py",
  "enabled": true
}

Supported fields

Field	Required	Behavior
`id`	Recommended	Stable package identifier. If omitted, Yrendr derives an ID from the package directory name.
`name`	No	Human-readable package name. Defaults to the normalized plugin ID.
`version`	No	Package version. Defaults to `0.0.0`.
`author`	No	Author shown by Plugin Manager. Defaults to `Unknown`.
`description`	No	Short package description.
`entrypoint`	No	Python entry file. Defaults to `plugin.py`.
`enabled`	No	Initial enabled state. Defaults to `true` unless a saved user override exists.

Choose a stable ID

Plugin IDs are normalized to lowercase and may contain letters, numbers, ., _ and -.

Choose a namespace you control, for example vendor.product.
Keep the package ID stable across releases.
Keep registered effect and processor IDs stable as well.

Project effect references use:

<plugin_id>:<effect_id>

Caution: Renaming either side changes the stable full ID and can make existing project effect instances unresolved.