跳到正文

快速开始

这个指南会把一个本地浏览器游戏部署成可玩的 Vifu 云端游戏。

1. 注册并登录

先在 vifu.ai 创建 Vifu 账号。

先安装 CLI,然后在终端登录:

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

使用和 vifu.ai 相同的邮箱和密码。CLI 会保存本地登录状态用于部署。

2. 创建或选择项目

创建一个 starter:

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

或者使用已有浏览器游戏:

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

setup 会检测项目,并让你确认游戏名称和检测到的构建设置。只有检测不正确时才需要覆盖。如果跳过这一步,deploy 会在构建前启动同一个设置流程。CI 中可以用 vifu deploy --yes 接受检测到的默认值。

3. 试用 Examples

bash
git clone --recurse-submodules https://github.com/vifu-labs/vifu-examples
cd vifu-examples

先看这两个例子:

进入任意 example 目录后运行:

bash
vifu deploy

4. 添加 SDK

npm

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

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

const vifu = createVifuSDK();
await vifu.ready();

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>

5. 调用 Vifu AI

ts
const result = await vifu.ai.generateText({
  model: "basic",
  messages: [
    { role: "user", content: "Give the player a short hint." }
  ]
});

showHint(result.content);

basic 适合低成本玩法文本和简单分类。quality 适合故事回合或更复杂的推理。游戏不选择后端提供方名称,也不携带提供方 API key。

Vifu AI 默认可通过 SDK 使用。普通 vifu.ai.generateText(...) 调用不要添加 manifest 配置。

6. 部署

bash
vifu deploy

vifu deploy 会在需要时运行项目设置,验证项目,构建游戏,检查构建输出,只在内容变化时上传,并输出可玩的 URL。

如果部署被阻止,先看错误中的文件、行号、URL 和修复建议。最常见原因是 CDN JavaScript import、浏览器 bundle 里残留外部 AI / API 直接调用,或本地专用提供方。

部署选项和游戏管理命令见 部署 部分。

本地行为

在 Vifu 外部,Vifu AI、存档和其他 Vifu 能力可能不可用。游戏仍然应该能用本地备用逻辑加载和游玩。