Skip to content

Open-VCS/PluginTemplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PluginTemplate: Hello, World!

This folder is a starter template for building OpenVCS plugins.

It includes a single WASI/Rust module (src/main.rs) that prints a message when the plugin starts.

Build (.ovcsp)

From PluginTemplate/, run:

cargo openvcs dist

This bundles the plugin into dist/*.ovcsp.

If cargo openvcs is not installed, you can run the SDK packager directly:

cargo run --manifest-path ../OpenVCS-SDK/Cargo.toml --bin openvcs-plugin -- --plugin-dir PluginTemplate --out PluginTemplate/dist

Notes:

  • These plugins build for wasm32-wasip1. If needed: rustup target add wasm32-wasip1.

What it does

  • When enabled/loaded, it logs one line:
    • Hello, World from PluginTemplate!

Files

  • openvcs.plugin.json: Plugin manifest (id + module exec).
  • Cargo.toml, src/main.rs: Rust/WASI module executable.

Customizing for your own plugin

  1. Pick a new plugin id (example: com.yourname.my-plugin).
  2. Update these in sync:
  • PluginTemplate/openvcs.plugin.json (id, and any file names you change)
  • PluginTemplate/src/main.rs (the startup message and any method names you add)
  1. If you rename the module executable, update:
  • PluginTemplate/openvcs.plugin.jsonmodule.exec
  • PluginTemplate/Cargo.toml[[bin]].name

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages