Vifu SDK

工具@vifu/[email protected]

Protocolcompanion.plugin.v1

运行环境Vifu Web iframe / iOS WKWebView

状态公开 alpha

@vifu/sdk 是面向 AI-native 游戏和互动应用的浏览器 SDK。游戏可以把安全的玩法上下文、事件和游戏拥有的动作暴露给 Vifu 宿主。它也是访问宿主管理的运行时资源和平台能力的唯一公开入口。

生产范围会刻意保持收敛：只支持由 Vifu Web 加载的浏览器游戏，以及 iOS WKWebView 运行环境。Node.js 和任意后端集成不属于这个 SDK 的公开契约。

兼容性

工具	协议	能力	运行环境
`@vifu/[email protected]`	`companion.plugin.v1`	`companion.plugin.v1`	Vifu Web iframe、iOS WKWebView

Context 是可读取的游戏状态，例如当前题目、分数、选中的单词或场景。
Command 是游戏自己拥有的动作，AI 伙伴可以请求游戏执行。
Observation 是游戏上报的简短事件或事实。
Signal 是游戏明确希望 AI 伙伴关注的少量关键时刻。
Reaction 是 signal 或 command 之后由游戏本地展示的反馈。
Resource 是通过 Vifu.resources.* 读取或解析的宿主管理运行时数据和媒体。
Invoke 是通过 Vifu.services.invoke(capabilityId, args) 请求宿主拥有的能力，例如 vifu.dictionary.lookup 或 host.game_state.persist。

传给 AI 伙伴的数据应该保持简短，并且只包含玩家可见的内容。不要暴露访问令牌、隐藏答案、私有用户笔记或实现细节状态。

平台能力统一使用 Vifu.services.invoke(capabilityId, args)。游戏代码不要直接请求 Vifu 后端、解析运行时令牌，或自己发送 window.parent.postMessage(...) 后端消息。