Skip to content

插件开发指南

这里面向软件生态开发者,介绍 Qomicex 插件系统的架构、开发流程与全部接口。

插件是什么

Qomicex 插件(.qplugin)本质是一个 ZIP 压缩包,内含一份 manifest.json 清单和插件前端资源(HTML / JS / CSS)。安装后由启动器在受控的沙箱/内联环境中渲染并执行,可调用启动器暴露的插件 API 来读写配置、操作实例、请求网络、注入 UI 等。

插件能力

能力说明
注入侧边栏通过 contributes.menuItems 在侧边栏底部创建入口(跳转页面或打开悬浮窗)
悬浮窗通过 contributes.overlay 声明,创建可拖拽的独立小窗口
插件页面通过 entry.frontend 提供完整页面,挂载到 /plugins/p/:id
配置读写读写插件自己的 settings.jsongetSettings / setSettings
插件缓存读写插件自己的 cache.jsonsetCache / getCache,支持 TTL 过期)
网络请求直接请求后端 API(callBackend)或经 CORS 代理访问外网(proxyFetch / proxyFetchStream
插件间调用注册方法供其他插件调用(registerMethod / callPlugin
主题跟随自动跟随启动器明暗主题(CSS 变量注入)

前置插件(Libraries)

部分插件不提供 UI,只作为被依赖的能力库供其他插件调用(例如 MarkdownLib 提供 renderMarkdown)。这类插件不声明 contributes,因此不会创建侧边栏。见 插件依赖与互调用

目录