Skip to content

宿主接口清单 ​

api.hostApi.call(name, ...args) 可调用的宿主接口。讲解见调用宿主接口。

名称权限参数返回
instance.listhostapi:instance.listlibraryPath?: string实例数组
instance.gethostapi:instance.getinstanceId: string单个实例
library.listhostapi:library.list无多版本库信息
auth.default_usernamehostapi:auth.default_username无用户名或 null

全部是高风险权限,需要用户手动批准。

特性 ​

  • 只读:这四个接口都不改变启动器状态。
  • 白名单:调用其他名字抛 Unknown host API "xxx".
  • 返回 unknown:没有强类型,自己判断形状。

用法 ​

json
"permissions": ["hostapi:instance.list"]
ts
try {
	const raw = await api.hostApi.call('instance.list')
	const instances = Array.isArray(raw) ? raw : []
} catch {
	// 未授权,降级
}

每一项要单独声明——声明了 hostapi:instance.list 不代表能调 instance.get。


参考手册到此结束。去实例拆解看真实插件的写法,或者查 FAQ。

Celestial Launcher 基于 Modrinth App 构建,遵循其开源许可。