Getting StartedWeChat

WeChat WeChat (JavaScript/TypeScript SDK)

WeChat is a popular messaging and social media platform in China, and it provides a rich set of APIs for building mini-programs and games. Colyseus can be integrated with WeChat to create real-time multiplayer experiences.

As the WeChat JavaScript runtime is not fully compatible with the browser, you will need to use the following polyfills to ensure compatibility.

⚠️

Feedback? Join the discussion on GitHub — https://github.com/colyseus/colyseus.js/pull/158

The JavaScript or TypeScript SDK are compatible with WeChat after applying the necessary polyfills and monkey-patches.

URL Polyfill

WeChat does not provide the URL standard, so you need to install a polyfill to use it.

If you are using a build system, you can install the url-polyfill package:

npm install --save url-polyfill

And import it in your entry file:

require('url-polyfill');

WebSocket monkey-patch

It has been reported that the WeChat JavaScript runtime does not support sending Uint8Array or Array data types directly through WebSocket. To work around this, you can monkey-patch the WebSocket.send method to convert these data types to a format that WeChat can handle.

const WebSocket_send = WebSocket.prototype.send;
WebSocket.prototype.send = function(data) {
    if (data instanceof Uint8Array) {
        WebSocket_send.call(this, data.slice().buffer);
    } else if (Array.isArray(data)){
        WebSocket_send.call(this, (new Uint8Array(data)).buffer);
    } else {
        WebSocket_send.call(this, data);
    }
}
Last updated on
Discord Activity Tutorials