Installation

Get the MusterBox SDK into your project — every packaging target.

The SDK is distributed as locally packaged artifacts in this release cycle. It is not yet published to npm or crates.io, so installation means vending the tarball for your platform.

Package publication (@musterbox/sdk-js, @musterbox/sdk-wasm, crates.io) is on the roadmap. Until then, pin the exact 1.0.0 artifact and keep a vendor copy in your build.

Artifacts (dist/)

Artifact	Format	For
musterbox-unity-1.0.0.tgz	npm tarball	Unity Package Manager
musterbox-godot-1.0.0.*	zip (per OS)	Godot GDExtension
musterbox-bevy-1.0.0.tar.gz	Cargo dependency	Rust / Bevy
musterbox-unreal-1.0.0.zip	plugin zip	Unreal Engine 5.3/5.4
musterbox-cocos-1.0.0.tgz	Cocos extension	Cocos Creator 3.8
musterbox-defold-1.0.0.zip	Defold library	Defold 1.6.5+
musterbox-js-1.0.0.tgz, musterbox-ts-1.0.0.tgz	npm tarball	Web (TypeScript/JS)
musterbox-wasm-1.0.0.tgz	npm tarball	WebAssembly core
musterbox-cli-1.0.0.*	binary tarball	MusterBox CLI
native/<triple>/	C ABI archive	Linux/macOS/Windows (+ iOS/Android)

Web (TypeScript / JavaScript)

npm install ./musterbox-js-1.0.0.tgz ./musterbox-wasm-1.0.0.tgz

The JS wrapper depends on the Wasm core:

import { createMusterBox } from "@musterbox/sdk-js";

See Web engines for details.

Unity (2020.3+)

Via the Package Manager, add package from tarball:

# menu: Window > Package Manager > + > Add package from tarball...
# select dist/musterbox-unity-1.0.0.tgz

The C# wrapper exposes the MusterBoxSdk singleton. Native FFI plugins are included per-platform, including WebGL template support.

Godot (4.2+)

Copy the musterbox-godot GDExtension into your project and enable it in the Project Settings. The Rust adapter is a NativeScript-class GDExtension with these targets: desktop (macOS/Linux/Windows), Android, and iOS.

Rust / Bevy

cargo add musterbox-sdk --path ./dist/musterbox-bevy-1.0.0
# or point Cargo.toml at the unpacked crate

Unreal Engine (5.3/5.4)

Extract musterbox-unreal-1.0.0.zip into <Project>/Plugins/MusterBox. Enable the plugin in the Editor. A Blueprint-friendly MusterBox module is provided.

Cocos Creator (3.8) and Defold (1.6.5+)

Cocos: import musterbox-cocos-1.0.0.tgz as a project dependency. Defold: add musterbox-defold-1.0.0.zip to game.project dependencies. See the Cocos and Defold pages.

Verifying the build

Every package reports its SDK version (1.0.0) and C ABI version (1.2.0). Confirm the ABI against native builds — mismatched ABI versions fail fast with a clear MismatchedVersion error.

Next: Configuration.