跳到正文

安装

先安装 CLI。只有当游戏代码需要 Vifu API 时,再添加 SDK。

CLI

CLI 用于创建、运行、测试、构建、生成和发布 AI-native 游戏。

bash
curl -fsSL https://vifu.dev/cli | bash
vifu --help

安装脚本会下载 macOS、Linux 或 Windows shell 的原生 vifu 二进制。Agent skill 单独安装,见 Vifu Agent Skill。原生安装不可用时,可以使用 npm:

bash
npm install -g @vifu/cli@alpha
vifu --help

项目内 CLI 使用方式:

bash
npm install --save-dev @vifu/cli@alpha
npx vifu --help

创建项目

bash
npm create @vifu/vifu my-game -- --template vanilla --no-interactive
cd my-game
vifu deploy --yes

npm create @vifu/vifu 是受支持的项目初始化命令。公开 CLI 不提供 vifu createvifu new 命令。

已有浏览器游戏可以这样开始:

bash
cd path/to/your-game
vifu deploy --yes

deploy 也会在缺少项目设置时自动启动设置流程。CI 中可以用 vifu deploy --yes 接受检测到的默认值。

Vifu SDK

SDK 用在浏览器游戏内部,向 Vifu 暴露安全的会话上下文、事件和游戏拥有的动作。

npm

使用打包工具或构建步骤的游戏,通过 npm 安装:

bash
npm install @vifu/sdk@alpha
ts
import { createVifuSDK } from "@vifu/sdk";

CDN

可以从 jsDelivr 加载浏览器 build。部署游戏时使用精确版本:

html
<script src="https://cdn.jsdelivr.net/npm/@vifu/[email protected]/dist/browser/vifu-sdk.js"></script>
<script>
  const vifu = window.vifu;
</script>

登录后部署

先在 vifu.ai 创建账号,然后运行:

bash
vifu login

然后从游戏目录部署:

bash
vifu deploy

下一步