创作教程测试与发布
沉浸创作本地测试
通过 API Key 在本地环境测试沉浸创作游戏
沉浸创作的游戏需要上传前端代码(ZIP 包),本地开发时可以通过 API Key + 游戏 ID 直接在本地环境测试,无需每次打包上传。
准备工作
- 发布游戏:先在创作台将游戏发布为私有(确保游戏设定已保存到服务器)
- 获取游戏 ID:进入游戏详情页,点击右上角「...」菜单,选择「复制游戏 ID」
- 生成 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
}
})dev 模式下,SDK 会使用 API Key 鉴权,并从服务器读取你创建的游戏设定(游戏设定、高级配置、自定义属性等),所有功能与线上一致。
dev 模式说明
| 特性 | 说明 |
|---|---|
| AI 对话 | 正常工作,使用创作者的花园币 |
| 游戏状态 | 正常读写,但不会持久化保存 |
| 游戏设定 | 从服务器读取已保存的设定 |
| 消息记录 | 不保存到数据库 |
| 存档 | 不创建真实存档 |
游戏设定需要在创作台配置。如果修改了游戏设定,需要重新发布后本地测试才会生效。
调试技巧
开启 Debug 模式可以在浏览器控制台查看所有 SDK 请求和响应,方便排查问题:
window.__STORVIA__ = {
...window.__STORVIA__,
debug: true,
}更多 SDK 使用细节请参考 SDK 初始化。