# @colyseus/sdk 中文文档

规范地址：https://npmcn.com/package/%40colyseus/sdk/

版本：0\.18\.9
npm 元数据更新时间：2026-10-30T22:29:49.248Z
中文译文更新时间：2026-11-10T11:25:52.320Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40colyseus/sdk
原文对照：https://npmcn.com/package/%40colyseus/sdk/?lang=original
项目主页：https://github.com/colyseus/colyseus#readme
源码仓库：https://github.com/colyseus/colyseus

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.4 MB，323 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 12\.x
- 运行依赖：6 个
- peer 依赖：@colyseus/core 0\.18\.x
- 首次发布：2026-01-09T00:27:15.657Z
- 最新版本发布：2026-10-30T22:29:49.069Z
- 近 30 天下载量：441550（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：53（近 12 个月 53 个）

## 中文简介

JavaScript/TypeScript的多玩家 SDK

## 安装

```sh
npm install @colyseus/sdk
```

也可以使用：`pnpm add @colyseus/sdk`、`yarn add @colyseus/sdk`、`bun add @colyseus/sdk`

## README

[![](https://github.com/colyseus/colyseus/blob/master/media/logo.svg?raw=true)](https://github.com/colyseus/colyseus)  
  
 [![](https://img.shields.io/npm/dm/colyseus.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETESWYxR33AAAAtElEQVQoz4WQMQrCQBRE38Z0QoTcwF4Qg1h4BO0sxGOk80iCtViksrIQRRBTewWxMI1mbELYjYu+4rPMDPtn12ChMT3gavb4US5Jym0tcBIta3oDHv4Gwmr7nC4QAxBrCdzM2q6XqUnm9m9r59h7Rc0n2pFv24k4ttGMUXW+sGELTJjSr7QDKuqLS6UKFChVWWuFkZw9Z2AAvAirKT+JTlppIRnd6XgaP4goefI2Shj++OnjB3tBmHYK8z9zAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE5LTAyLTAxVDE4OjE3OjM3KzAxOjAwGQQixQAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOS0wMi0wMVQxODoxNzozNyswMTowMGhZmnkAAAAZdEVYdFNvZnR3YXJlAHd3dy5pbmtzY2FwZS5vcmeb7jwaAAAAAElFTkSuQmCC)](https://npmjs.com/package/colyseus)[![Discussion forum](https://img.shields.io/badge/discuss-on%20forum-brightgreen.svg?style=for-the-badge&colorB=0069b8&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETDROxCNUzAAABB0lEQVQoz4WRvyvEARjGP193CnWRH+dHQmGwKZtFGcSmxHAL400GN95ktIpV2dzlLzDJgsGgGNRdDAzoQueS/PgY3HXHyT3T+/Y87/s89UANBKXBdoZo5J6L4K1K5ZxHfnjnlQUf3bKvkgy57a0r9hS3cXfMO1kWJMza++tj3Ac7/LY343x1NA9cNmYMwnSS/SP8JVFuSJmr44iFqvtmpjhmhBCrOOazCesq6H4P3bPBjFoIBydOk2bUA17I080Es+wSZ51B4DIA2zgjSpYcEe44Js01G0XjRcCU+y4ZMrDeLmfc9EnVd5M/o0VMeu6nJZxWJivLmhyw1WHTvrr2b4+2OFqra+ALwouTMDcqmjMAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTktMDItMDFUMTg6MTM6MTkrMDE6MDAC9f6fAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE5LTAyLTAxVDE4OjEzOjE5KzAxOjAwc6hGIwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAAASUVORK5CYII=) ](https://discuss.colyseus.io/ "Discuss on Forum")[![](https://img.shields.io/discord/525739117951320081.svg?style=for-the-badge&colorB=7581dc&logo=discord&logoColor=white)](https://discord.gg/RY8rRS7)

### JavaScript/TypeScript的多玩家 SDK.  
[查看文档](https://docs.colyseus.io/client)

**测试了浏览器支持 :**

[![](https://npmcn.com/package/%40colyseus/sdk/media/browserstack-logo.png?raw=true)](https://www.browserstack.com/)

## 发布到 Cocos 仓库

Cocos 创建者 3 扩展名 (`cocos-creator-3-extension/`页:1 [Colyseus 多人游戏机 SDK](https://store.cocos.com/app/en/detail/5086)。该 Store 没有上传 API , 并且它的登录有 captcha , 因此提交本地运行, 而不是 CI .

1.  构建扩展包 :
    
    ```sh
    npm run build && npm run build-release-assets
    ```
    
    这个写着 `colyseus-sdk-cocos-creator.zip`,而扩展的版本取自此包。 CI在GitHub的释放上也附加了同样的拉链.
    
2.  在卖方门户网站上填写新版本:
    
    ```sh
    npm run submit-cocos-store
    ```
    
    这打开了门户网站上的Google Chrome. 第一次登录 Cocos 开发者中心; 会话保存在 `~/.colyseus/cocos-store-chrome` 为以后运行。 脚本上传了zip,设定了版本编号,从当前 Store 版本复制了最小的创建者版本,并填充了该版本的发布注释 `CHANGELOG.md` 节(被切入到 Store 的 1500 字符限制).
    
3.  审查窗体,单击 **保存预览**,然后提交版本供审查.
    

过 `-- --submit` 来保存和提交,而不使用手动步骤。 其他选项: `--notes`, (中文(简体) ), `--notes-cn`, (中文(简体) ), `--requirement` 财务报告和审定财务报表 `--zip` (见 `cocos-creator-3-extension/submit-to-store.mjs`) (中文(简体) ).

Cocos对每个版本进行手工审查,最多可花3个工作日. 一旦获得批准,它就成为了Story上目前的版本.

## 许可证

麻省理工学院

## 常见问题

### @colyseus/sdk 是什么？

JavaScript/TypeScript的多玩家 SDK

### 如何安装 @colyseus/sdk？

在项目目录运行 npm install @colyseus/sdk，或使用 pnpm add / yarn add / bun add。

### @colyseus/sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @colyseus/sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @colyseus/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 12\.x。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @colyseus/sdk 可以商用吗？

@colyseus/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @colyseus/sdk 的下载量有多少？

根据 npm 官方下载统计，@colyseus/sdk 在 2026/10/11 – 2026/11/09 这 30 天内被下载 441,550 次，日均约 14,718 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @colyseus/sdk 还在维护吗？

最新版本 0\.18\.9 发布于 2026/10/31（10 天前）；至今共发布 53 个版本，其中过去 12 个月发布了 53 个；首次发布于 2026/01/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。