Skip to content

README.md

Latest commit

 

History

History
20 lines (14 loc) · 1.01 KB

README.md

File metadata and controls

20 lines (14 loc) · 1.01 KB

ExamplePlugins

This directory contains example OpenVCS plugins.

The OpenVCS plugin system is component-only and defined by the WIT contracts under Core/wit/. For a current, working plugin scaffold, use PluginTemplate/.

Current example:

  • example.status/: demonstrates host set-status + get-status APIs.
    • Uses use openvcs_core::prelude::*; and status::set/get helpers.
    • Manifest capability: status.set (which also implies status.get).
  • example.settings/: demonstrates v1.1 plugin menus, action handling, and automatic host-managed plugin settings persistence.
    • Contributes two menus with optional order hints (Some(5) and Some(10)) to demonstrate host-side menu ordering.
    • Uses settings_defaults + settings_on_apply hooks while the host persists settings.json under plugin-data/<plugin-id>/.

Notes:

  • Keep examples in sync with the current openvcs-core API and host capabilities.
  • The SDK builds plugin runtime assets for npm packages; see SDK/README.md for current commands.