Skip to content

Publishing & Marketplace ​

After developing in the Dev environment and verifying, publish your plugin to npm and register it on the official marketplace (the framework's plugin market).

Publish to npm ​

bash
cd plugins/openvideo-plugin-hello
npm publish
  • Name it openvideo-plugin-* for discoverability
  • package.json must include main and the openvideoPlugin manifest
  • Client assets ship inside the package (lib/client/), no bundling needed
  • Not published yet? Install via npm install <local path> or npm install <github repo>

Marketplace ​

The registry is plugin-registry.json at the repo root (v2: versions + dependencies):

json
{
  "updated": "2026-08-08",
  "plugins": [
    {
      "name": "openvideo-plugin-hello",
      "description": "My first plugin",
      "author": "your-name",
      "homepage": "https://github.com/you/openvideo-plugin-hello",
      "tags": ["tools"],
      "versions": ["1.0.0", "0.9.0"],
      "dependencies": []
    }
  ]
}
FieldNotes
namenpm package name (installed via npm install <name>@<version>)
versionsavailable versions (descending, first = latest)
dependenciesdependent plugin packages (loaded in topological order)

Submit by opening a PR to the OpenVideoAPI repo adding an entry to plugin-registry.json.

Configurable Sources ​

Admin "Dependencies → Update & install config":

  • npm mirror: plugin.npmRegistry (or OPENVIDEO_NPM_REGISTRY env) — applies to market installs / plugin updates / dependency updates / app updates
  • Plugin registry URL: plugin.registry (or OPENVIDEO_PLUGIN_REGISTRY) — https:// or local file:// (Dev environment)

Framework Mapping ​

插件框架OpenVideoAPI
plugin naming conventionopenvideo-plugin-* naming
插件框架 marketplaceofficial plugin-registry.json (versions + dependencies)
one-click installadmin "Plugins → Market"
market reviewPR to registry

MIT License · Made with ♥ by yangyang8002