Skip to content
TransBoxTransBox

Steam 创意工坊打包与发布

完成后如何把 MOD 变成玩家可订阅的工坊物品。请按当前客户端真实能力操作,避免使用未实现的 CLI。


1. 发布前自检

  • [ ] 根目录有合法 mod.jsonid 唯一
  • [ ] entrypoint 指向真实文件(及类名)
  • [ ] 推荐提供 icon.svg / icon.png
  • [ ] 数据文件 UTF-8 保存
  • [ ] 未写入本机绝对路径、API Key、隐私数据
  • [ ] 已在本地扩展工坊中启用并验证功能
  • [ ] 词库类:文本分隔符为 = 或 Tab(不用 ->

2. 在客户端导出 Zip

  1. 启动 TransBox → 设置 → 扩展工坊

扩展工坊面板

  1. 找到你的本地 MOD 卡片
  2. 点击 导出
  3. 得到文件名类似:
    transbox_mod_<id中点号替换为下划线>_v<version>.zip
    (例如 myteam.mt.demotransbox_mod_myteam_mt_demo_v1.0.0.zip

导出实现会打包插件目录内容,供上传工坊使用。


3. 上传到 Steam 创意工坊

  1. 打开 Steam 客户端,进入 TransBox 创意工坊(AppID 1316080)。
  2. 使用 Steam 创意工坊的发布入口上传你的 zip / 文件(或按官方说明使用 Steamworks 后台)。
  3. 补充标题、说明、截图、预览图。
  4. 可见性改为 公开
  5. 玩家在工坊点 订阅 后,TransBox 扩展工坊 → 刷新 即可加载。

设置页也有 浏览 Steam 创意工坊 快捷入口。


4. 不要使用的过时命令

旧文档中的:

powershell
python -m transbox.plugins.steam_ugc --upload path/to/mod.zip

当前代码不存在该 CLI 与上传 APIsteam_ugc.py__main__、无 argparse、无 ISteamUGC 上传)。

模块真实能力包括:

  • 探测 Steam 环境与工坊安装路径
  • discover_workshop_mod_paths() 扫描已订阅 MOD
  • export_mod_for_workshop(source_dir, output_zip) 打 zip
  • AppID 默认 1316080(可用环境变量 TRANSBOX_STEAM_APP_ID 覆盖)

上传请走 Steam 官方创意工坊流程。若将来客户端加入上传按钮或 CLI,以新版本手册为准。


5. 玩家侧订阅说明(可贴进工坊描述)

  1. 在 Steam 创意工坊订阅本物品;
  2. 启动 TransBox;
  3. 打开 设置 → 扩展工坊
  4. 确认 MOD 出现在列表,打开开关启用;
  5. 引擎类:到语音识别 / 机器翻译 / 语音合成里选中对应引擎;
  6. 主题/语言包:启用后立即生效(可能与其它 full 主题/语言包互斥)。

6. 安全与合规

  • 不包含木马、挖矿、破坏磁盘、未授权上传隐私的代码;
  • 不篡改主程序全局配置;
  • 脚本类插件与主程序同权限,应在描述中说明权限与网络行为;
  • 违规内容可被工坊下架。

7. 版本升级

  1. 递增 mod.jsonversion
  2. 重新导出 zip
  3. 在 Steam 上传新版本(更新原物品)
  4. 提醒订阅者:客户端内点刷新或重启 TransBox

TransBox - 赋能全人类无界限跨语言交流