@colyseus/sdk

Multiplayer SDK for JavaScript/TypeScript.
View documentation

Browser support tested with:

Publishing to the Cocos Store

The Cocos Creator 3 extension (cocos-creator-3-extension/) is listed as Colyseus Multiplayer SDK. The Store has no upload API and its login has a captcha, so submitting runs locally, not in CI.

1. Build the extension package:

   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:

   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