Support and licensing
Where to report problems, and the terms the SDK is distributed under.
Report a problem
Open an issue in the SDK repository with the SDK version, your Node.js version and operating system, and the smallest code that reproduces the problem. Remove API keys, personal data and private room links before you post.
Report security issues privately through GitHub security advisories.
Supported platforms
Node.js 24 or newer is the supported host runtime. The native transport is verified on Node.js 24 on macOS (Apple silicon); treat other operating systems as experimental and test them before you depend on them. Bun runs the same package as a compatibility target.
License
The Ball2D SDK License grants a royalty-free license to run the unmodified SDK to build and operate integrations with the official Ball2D service, including commercial ones. You may adapt the public type declarations, documentation and examples for your integration. The license does not grant unlimited service access: rooms remain subject to your API key and room limits.
The SDK is proprietary, not open source. The package contains compiled JavaScript and WebAssembly, public type declarations and documentation; the game's source code is not included. Read the full terms in the SDK license.
Third-party components bundled with the SDK keep their own licenses, included in the package under dist/licenses.