# @colyseus/sdk

> Colyseus Multiplayer SDK for JavaScript/TypeScript

Latest version **0.18.5** (published 2026-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @colyseus/sdk
pnpm add @colyseus/sdk
yarn add @colyseus/sdk
bun add @colyseus/sdk
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.18.5 |
| Published | 2026-10-03 |
| First published | 2026-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 12.x |
| Dependencies | 6 |
| Unpacked size | 6.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Endel Dreyer |
| Maintainers | endel |
| Keywords | colyseus, multiplayer, netcode, realtime, networking, websockets |

## Links

- npm: https://www.npmjs.com/package/@colyseus/sdk
- Repository: https://github.com/colyseus/colyseus
- Homepage: https://github.com/colyseus/colyseus#readme
- Issues: https://github.com/colyseus/colyseus/issues
- Funding: https://github.com/sponsors/endel
- npm.io page: https://npm.io/package/@colyseus/sdk

## Dependencies (6)

- [ws](https://npm.io/package/ws.md) ^8.13.0
- [tslib](https://npm.io/package/tslib.md) ^2.1.0
- [msgpackr](https://npm.io/package/msgpackr.md) ^2.0.1
- [@colyseus/schema](https://npm.io/package/@colyseus/schema.md) ^5.0.8
- [@colyseus/better-call](https://npm.io/package/@colyseus/better-call.md) ^1.3.1
- [@colyseus/shared-types](https://npm.io/package/@colyseus/shared-types.md) ^0.18.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.18.5 (latest) — 2026-10-03
- 0.18.2 (next) — 2026-08-20
- 0.18.4 — 2026-09-23
- 0.18.3 — 2026-09-21
- 0.18.1 — 2026-07-21
- 0.17.43 — 2026-06-14
- 0.18.0 — 2026-05-22
- 0.17.42 — 2026-04-24
- 0.17.41 — 2026-04-19
- 0.17.40 — 2026-04-15
- 0.17.39 — 2026-04-08
- 0.17.38 — 2026-04-08
- 0.17.37 — 2026-04-03
- 0.17.36 — 2026-04-02
- 0.17.35 — 2026-03-11
- … 34 more at https://npm.io/package/@colyseus/sdk/versions

## README

<div align="center">
  <a href="https://github.com/colyseus/colyseus">
    <img src="https://github.com/colyseus/colyseus/blob/master/media/logo.svg?raw=true" width="40%" height="100" />
  </a>
  <br>
  <br>
  <a href="https://npmjs.com/package/colyseus">
    <img src="https://img.shields.io/npm/dm/colyseus.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETESWYxR33AAAAtElEQVQoz4WQMQrCQBRE38Z0QoTcwF4Qg1h4BO0sxGOk80iCtViksrIQRRBTewWxMI1mbELYjYu+4rPMDPtn12ChMT3gavb4US5Jym0tcBIta3oDHv4Gwmr7nC4QAxBrCdzM2q6XqUnm9m9r59h7Rc0n2pFv24k4ttGMUXW+sGELTJjSr7QDKuqLS6UKFChVWWuFkZw9Z2AAvAirKT+JTlppIRnd6XgaP4goefI2Shj++OnjB3tBmHYK8z9zAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE5LTAyLTAxVDE4OjE3OjM3KzAxOjAwGQQixQAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOS0wMi0wMVQxODoxNzozNyswMTowMGhZmnkAAAAZdEVYdFNvZnR3YXJlAHd3dy5pbmtzY2FwZS5vcmeb7jwaAAAAAElFTkSuQmCC">
  </a>
  <a href="https://discuss.colyseus.io" title="Discuss on Forum">
    <img src="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=" alt="Discussion forum" />
  </a>
  <a href="https://discord.gg/RY8rRS7">
    <img src="https://img.shields.io/discord/525739117951320081.svg?style=for-the-badge&colorB=7581dc&logo=discord&logoColor=white">
  </a>
  <h3>
     Multiplayer SDK for JavaScript/TypeScript. <br /><a href="https://docs.colyseus.io/client">View documentation</a>
  <h3>
</div>

**Browser support tested with:**

<a href="https://www.browserstack.com/"><img src="media/browserstack-logo.png?raw=true" width="300" /></a>

## Publishing to the Cocos Store

The Cocos Creator 3 extension (`cocos-creator-3-extension/`) is listed as [Colyseus Multiplayer SDK](https://store.cocos.com/app/en/detail/5086). The Store has no upload API and its login has a captcha, so submitting runs locally, not in CI.

1. Build the extension package:

   ```sh
   npm run build && npm run build-release-assets
   ```

   This writes `colyseus-sdk-cocos-creator.zip`, with the extension's version taken from this package. CI attaches the same zip to the GitHub release.

2. Fill in the new version on the seller portal:

   ```sh
   npm run submit-cocos-store
   ```

   This opens Google Chrome on the portal. The first time, log in to the Cocos developer center; the session is kept in `~/.colyseus/cocos-store-chrome` for later runs. The script uploads the zip, sets the version number, copies the minimum Creator version from the current Store version, and fills the release notes from this version's `CHANGELOG.md` section (trimmed to the Store's 1500-character limit).

3. Review the form, click **Save And Preview**, then submit the version for review.

Pass `-- --submit` to save and submit without the manual step. Other options: `--notes`, `--notes-cn`, `--requirement` and `--zip` (see the header of `cocos-creator-3-extension/submit-to-store.mjs`).

Cocos reviews each version by hand, which can take up to 3 business days. Once approved, it becomes the current version on the Store.

## License

MIT

---
_Source: https://npm.io/package/@colyseus/sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._