Vifu SDK
@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)でホスト所有の能力を要求する API です。例:vifu.dictionary.lookup、host.game_state.persist。
AI パートナーに渡すデータは小さく、プレイヤーに見えるものに限定します。アクセストークン、隠し答え、私的なユーザーメモ、実装詳細の状態は公開しないでください。
プラットフォーム機能には Vifu.services.invoke(capabilityId, args) を使います。ゲームコードから Vifu バックエンドを直接呼び出したり、ランタイムトークンを解析したり、独自の window.parent.postMessage(...) バックエンドメッセージを送らないでください。
次に読むページ
- クイックスタート は最小のインストールと連携パスを示します。
- SDK API リファレンス は公開メソッドを説明します。
- Manifest リファレンス は
companion.plugin.v1を説明します。 - トラブルシューティング はランタイムの問題を扱います。