Storvia
创作教程测试与发布

沉浸创作本地测试

通过 API Key 在本地环境测试沉浸创作游戏

沉浸创作的游戏需要上传前端代码(ZIP 包),本地开发时可以通过 API Key + 游戏 ID 直接在本地环境测试,无需每次打包上传。

准备工作

  1. 发布游戏:先在创作台将游戏发布为私有(确保游戏设定已保存到服务器)
  2. 获取游戏 ID:进入游戏详情页,点击右上角「...」菜单,选择「复制游戏 ID」
  3. 生成 API Key:进入「设置 → API 密钥」页面,点击「生成密钥」

API Key 仅在生成时显示一次,请立即复制保存。不要将 API Key 提交到代码仓库,上传 ZIP 时平台会自动扫描并拦截含有密钥的文件。

本地初始化

在本地代码中传入 dev 配置,SDK 会自动进入 dev 模式:

const storvia = await createStorviaSDK({
  dev: {
    apiKey: 'sk-storvia-xxxxxx',   // 你的 API Key
    gameId: 'your-game-uuid',      // 游戏 ID
    model: '双子 · 3.1',           // 可选,初始模型(展示名);不传则用第一个可用模型
  }
})

dev 模式下,SDK 会使用 API Key 鉴权,并从服务器读取你创建的游戏设定(游戏设定、高级配置、自定义属性等),所有功能与线上一致。

线上由平台界面负责模型选择;本地 dev 没有平台界面,用 model 参数指定初始模型(填模型展示名),不传则使用第一个可用模型。model 需与创作者可用模型列表里的展示名完全一致,填错或模型改名将静默回退到第一个可用模型。

dev 模式说明

特性说明
AI 对话正常工作,使用创作者的花园币
游戏状态正常读写,但不会持久化保存
游戏设定从服务器读取已保存的设定
消息记录不保存到数据库
存档不创建真实存档

游戏设定需要在创作台配置。如果修改了游戏设定,需要重新发布后本地测试才会生效。

调试技巧

目前 SDK 不开放 debug 日志开关——window.__STORVIA__ 仅供平台侧初始化通信使用,向其中写入 debug: true 不会生效(dev 模式不读取该对象,平台模式下宿主也不会下发 debug 配置)。排查问题时建议直接使用浏览器开发者工具的 Network 面板查看 SDK 请求和响应。

更多 SDK 使用细节请参考 SDK 初始化

On this page