openrv-web / PluginManifest

Interface: PluginManifest

Defined in: plugin/types.ts:23

Static metadata describing a plugin. Shipped as a JSON file or exported from the plugin module.

Properties

author?

optional author: string

Defined in: plugin/types.ts:33

Author name or organization

---

contributes

contributes: PluginContributionType[]

Defined in: plugin/types.ts:41

Which contribution types this plugin provides

---

dependencies?

optional dependencies: string[]

Defined in: plugin/types.ts:39

IDs of plugins this plugin depends on

---

description?

optional description: string

Defined in: plugin/types.ts:31

Short description

---

engineVersion?

optional engineVersion: string

Defined in: plugin/types.ts:37

Minimum OpenRV Web version required

---

id

id: string

Defined in: plugin/types.ts:25

Unique identifier (reverse-domain recommended)

---

license?

optional license: string

Defined in: plugin/types.ts:35

License identifier (SPDX)

---

name

name: string

Defined in: plugin/types.ts:27

Human-readable name

---

settingsSchema?

optional settingsSchema: PluginSettingsSchema

Defined in: plugin/types.ts:43

Optional settings schema for configurable plugins

---

version

version: string

Defined in: plugin/types.ts:29

Plugin version