Colyseus SDK 的 Cocos Creator 3 扩展构建与 Cocos Store 发布流程指南

发布时间:2026/10/6 12:29:06
Colyseus SDK 的 Cocos Creator 3 扩展构建与 Cocos Store 发布流程指南 后端游戏开发【免费下载链接】colyseus⚔ Multiplayer Framework for Node.js项目地址https://gitcode.com/gh_mirrors/co/colyseus点击查看免费下载Colyseus 作为面向 JavaScript/TypeScript 的多人在线游戏框架其官方 SDK 不仅以 npm 包形式分发还提供了面向 Cocos Creator 3 引擎的扩展cocos-creator-3-extension/帮助 Cocos 开发者直接在编辑器中接入 Colyseus 客户端能力。本指南以 packages/sdk/README.md 为骨架完整讲解从本地构建扩展安装包到提交 Cocos Store 审核上架的端到端流程并结合仓库源码说明每一步背后的构建工具链、产物结构与脚本行为读完即可独立完成一次 SDK 版本的商店发布。一、背景为什么 Cocos Creator 3 扩展需要走本地发布流程Colyseus SDK 的 Cocos Creator 3 扩展已作为「Colyseus Multiplayer SDK」正式上架 Cocos Store。它的作用是在 Cocos Creator 3 编辑器中以扩展插件的形式提供 Colyseus 的浏览器运行时runtime/目录下的colyseus.js与配套类型声明并通过asset-db挂载机制让项目可以直接引用这些脚本无需手动拷贝 npm 产物。发布流程之所以在本地运行而非 CI 执行是因为 Cocos Store 存在两个硬性限制Store 没有上传 API无法通过脚本在服务器上直接推送扩展包Store 登录带有验证码captcha自动化流程无法在无人工干预的情况下完成身份认证。因此构建产物可以由 CI 生成并附带发布但「填写卖家门户并提交版本」这一步必须在开发者的本地机器上完成。二、构建扩展安装包两条命令产出可上传的 zip2.1 构建命令扩展包需要先从 SDK 源码构建出浏览器可用的运行时产物再打包成 zip。README 给出的命令是npm run build npm run build-release-assets这两条命令的定义位于 packages/sdk/package.json 的scripts字段中命令定义作用buildrollup -c rollup.config.mjs调用 Rollup 按 packages/sdk/rollup.config.mjs 的配置产出dist/与build/两套产物build-release-assetszip --junk-paths colyseus-sdk dist/colyseus*把dist/目录下所有以colyseus开头的构建产物打包为发布用 zipREADME 中描述的最终发布文件名为colyseus-sdk-cocos-creator.zip扩展的版本号取自 SDK 包自身的package.json当前快照中 SDK 版本为 0.18.5从而保证「SDK 发版 ↔ 商店扩展版本」一一对应。此外仓库中的 CI 脚本build-citsc npm run build npm run build-dist-dts npm run build-release-assets也会执行同样的打包步骤并把同一个 zip 作为发布资产附加到对应的 GitHub Release 上——这意味着CI 负责“造包”本地负责“上架”两者各司其职。2.2 构建产物里到底有什么理解打包内容有助于排查「上传的 zip 是否完整」。从 packages/sdk/rollup.config.mjs 可以看到dist/目录主要包含两类文件dist/colyseus.js以 UMD 格式输出的浏览器独立包name: Colyseus源码入口为 packages/sdk/src/index.ts其中导出了ColyseusSDK、Client、Room、Auth、序列化器SchemaSerializer/NoneSerializer以及预测库Predict、Reconciler等等完整 APIdist/colyseus.d.ts配套的 TypeScript 类型声明供编辑器智能提示使用dist/debug.js独立的调试工具包IIFE 格式通过补丁全局Colyseus对象提供网络模拟、状态检查等开发辅助能力。该 Rollup 配置对浏览器包做了三项关键处理直接影响扩展在 Cocos 中的可用性与体积依赖替换将ws替换为ws/browser.js浏览器版 WebSocket 实现将colyseus/schema替换为其 ESM 构建以便 Rollup 摇树tree-shake掉仅服务端使用的导出Encoder、StateView、builder DSL 等压缩通过 esbuild 对dist/下的 CDN/独立包做 minify同时保留 MIT 许可头与版本横幅产物瘦身根据 packages/sdk/CHANGELOG.md 的记录浏览器包压缩后约为58 KBgzip此前未压缩版本约 191 KBpackages/sdk/test/tree-shaking.test.ts 也持续守护着「不需要的导出不被打进包」这一约束。三、扩展包在编辑器中的形态runtime 挂载与入口打包进 zip 并安装到 Cocos Creator 3 后扩展目录结构如下仓库中的实际位置为 packages/sdk/cocos-creator-3-extension/colyseus-sdk/ ├── browser.js # 扩展生命周期入口空实现 ├── package.json # 扩展清单 └── runtime/ # 只读挂载的运行时资源 ├── colyseus.js ├── colyseus.js.meta ├── colyseus.d.ts └── colyseus.d.ts.meta扩展清单 packages/sdk/cocos-creator-3-extension/colyseus-sdk/package.json 中值得关注的两个字段main: browser.js——指向扩展入口 packages/sdk/cocos-creator-3-extension/colyseus-sdk/browser.js该文件是符合 Cocos 扩展约定的生命周期壳methods/load/unload均为空实现实际能力全部由 runtime 中的 SDK 提供contributions[asset-db].mount——声明将./runtime以readonly: true方式挂载进资源数据库。这意味着colyseus.js会以「引擎自带资源」的形式出现在编辑器资源面板中开发者可直接引用而不会被误改。运行时文件的同步由copy-cocos-creator-files脚本完成在完整构建build-alltsc npm run build npm run build-dist-dts npm run copy-cocos-creator-files npm run copy-construct3-files时把dist/colyseus.js、dist/debug.js与dist/colyseus.d.ts复制进cocos-creator-3-extension/colyseus-sdk/runtime/。可见商店中分发的扩展本质上是 SDK 构建链路的二次产物——先构建、再拷贝、最后 zip。四、提交到 Cocos Store脚本自动化 一次人工确认4.1 提交命令与会话本地提交使用npm run submit-cocos-store该命令会启动 Google Chrome 打开 Cocos 卖家门户seller portal。首次运行时需要手动登录 Cocos 开发者中心登录会话会被持久化保存在~/.colyseus/cocos-store-chrome目录中供后续发布复用不必每次都重新登录。4.2 脚本自动完成的四件事根据 README 的说明提交脚本在门户页面上会自动完成以下操作上传 zip将上一节构建出的colyseus-sdk-cocos-creator.zip上传到商店后台设置版本号版本取自 SDK 包自身的版本保证商店版本与 npm 发布版本一致复制最低 Creator 版本从当前商店在售版本中读取并沿用「最低支持的 Cocos Creator 版本」避免新版本误放宽或收紧引擎兼容范围填充发布说明从本版本对应的 packages/sdk/CHANGELOG.md 小节截取变更内容作为商店 release notes并按商店1500 字符上限截断。4.3 人工审核确认脚本填充完表单后并不会自动提交流程停在表单预览阶段。发布者需要人工完成最后两步复核表单内容版本号、最低 Creator 版本、发布说明、zip 附件点击Save And Preview保存并预览随后正式提交版本进入商店审核队列。Cocos 官方会对每个版本进行人工审核最长可能需要3 个工作日。审核通过后该版本即成为商店中的当前版本Cocos 开发者即可在编辑器内直接检索并安装更新。4.4 完全自动化-- --submit与其它 CLI 选项如果发布者对表单内容有十足把握可以跳过人工预览步骤使用npm run submit-cocos-store -- --submit--后的参数会透传给提交脚本传入--submit时脚本在填充完表单后直接保存并提交不再等待人工点击。除了--submit提交脚本还支持以下选项各选项的详细说明位于扩展目录中提交脚本submit-to-store.mjs的头部注释README 明确指出了这一查阅位置选项作用--notes指定英文发布说明来源默认从 CHANGELOG.md 对应小节读取--notes-cn指定中文发布说明Cocos Store 支持中英双语描述--requirement指定最低 Cocos Creator 版本要求--zip指定要上传的 zip 文件路径默认使用构建出的标准产物五、一次完整的发布节奏实操清单综合以上各节一次「SDK 新版本 → 商店上架」的标准节奏是本地验证构建npm run build确认 packages/sdk/src/index.ts 导出的 API 均能正确产出CI 产出发布资产npm run build-ci执行tsc类型检查、Rollup 构建、d.ts 合并build-dist-dts与 zip 打包build-release-assets同一 zip 被附加到 GitHub Release同步运行时产物如需本地完整构建npm run build-all触发copy-cocos-creator-files将新构建写入runtime/目录本地提交npm run submit-cocos-store首次登录 Cocos 开发者中心会话保存于~/.colyseus/cocos-store-chrome复核与提交检查自动填充的版本号、最低 Creator 版本与发布说明1500 字符截断点击Save And Preview后提交审核信任脚本可加-- --submit跳过该步骤等待审核人工审核最长 3 个工作日通过后商店版本自动更新为当前版本。六、许可证Colyseus SDK 及其 Cocos Creator 3 扩展均采用MIT 许可证发布这意味着在遵守许可声明的前提下开发者可以自由地将扩展集成进自己的 Cocos Creator 项目中包括闭源商业项目无需额外的授权费用。延伸阅读构建管线细节见 packages/sdk/rollup.config.mjs完整命令清单见 packages/sdk/package.json版本变更与体积优化记录见 packages/sdk/CHANGELOG.md客户端 API 与扩展入口源码位于 packages/sdk/src/Client.ts 与 packages/sdk/src/Room.ts。赞分享后端游戏开发【免费下载链接】colyseus⚔ Multiplayer Framework for Node.js项目地址https://gitcode.com/gh_mirrors/co/colyseus点击查看免费下载相关推荐Colyseus与主流游戏引擎集成Unity、Unreal和Cocos Creator终极指南Colyseus与主流游戏引擎集成Unity、Unreal和Cocos Creator终极指南 想要构建稳定可靠的多人在线游戏Colyseus作为业界领先的后端游戏开发cocos-engine 源码指南Cocos Creator 运行时引擎的架构特性与本地开发构建实战cocos engine 源码指南Cocos Creator 运行时引擎的架构特性与本地开发构建实战 Cocos Creator 是 Cocos 家族的新一代游戏开发图形学3D渲染Cocos Creator 引擎实验性 API 规范发布、修订与召回全流程指南Cocos Creator 引擎实验性 API 规范发布、修订与召回全流程指南 实验性 API 是 Cocos Creator 引擎在功能正式定型前向开发者游戏开发图形学3D渲染上一篇如何移除FLAG_SECURE截图限制Enable Screenshot模块完整指南下一篇fairseq 潜层深度 TransformerLatent Depth基于层选择后验分布的多语言机器翻译训练与推理实战创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考