HaloForge Plugin API

Build native plugins for HaloForge — the Game Dev Team Workbench & AI Assistant.

This repository contains both the Rust crate and the JavaScript/TypeScript SDK that plugin authors need.

• SDK repository: https://github.com/HaloForgeAI/haloforge-plugin-api
• Main HaloForge application: https://github.com/loyio/HaloForge

Packages

Quick Start (Rust Backend)

# Cargo.toml
[lib]
crate-type = ["cdylib"]

[dependencies]
haloforge-plugin-api = "0.1"
serde_json = "1"

use haloforge_plugin_api::*;

pub struct MyPlugin;

impl MyPlugin {
    pub fn new() -> Self { Self }
}

impl HaloForgePlugin for MyPlugin {
    fn metadata(&self) -> PluginMetadata {
        PluginMetadata {
            id: "com.example.my-plugin".into(),
            name: "My Plugin".into(),
            version: "0.1.0".into(),
            description: "A sample HaloForge plugin".into(),
            author: "You".into(),
            abi_version: PLUGIN_ABI_VERSION,
        }
    }

    fn on_load(
        &mut self,
        _ctx: &dyn PluginContext,
        ipc: &mut dyn IpcRegistrar,
    ) -> Result<(), PluginError> {
        ipc.register("hello", Box::new(|args, _ctx| {
            let name = args["name"].as_str().unwrap_or("World");
            Ok(serde_json::json!({ "message": format!("Hello, {name}!") }))
        }))?;
        Ok(())
    }

    fn on_unload(&mut self) -> Result<(), PluginError> {
        Ok(())
    }
}

declare_plugin!(MyPlugin, MyPlugin::new);

Quick Start (Frontend)

import { definePlugin, registerPlugin, invokePlugin } from "@haloforge/plugin-sdk";

const plugin = definePlugin({
  id: "com.example.my-plugin",
  slots: {
    "devkit.toolbar": () => <button onClick={handleClick}>Greet</button>,
  },
});

async function handleClick() {
  const result = await invokePlugin<{ message: string }>("hello", { name: "HaloForge" });
  alert(result.message);
}

registerPlugin(plugin);

Plugin Manifest

Every plugin needs a manifest.json. See the built-in plugins for examples.

Capability Levels

License

MIT