Install

The editor

Desktop app

Download the installer for your system from the latest release (all releases):

System	Files
Windows	`.msi`, `.exe`
macOS	`.dmg` for Apple Silicon and Intel
Linux	`.deb`, `.rpm`, `.AppImage`

The desktop app is the same editor as the web version, in a Tauri 2 shell, plus native open and save dialogs, folder export and live reloading of art you change in your paint or audio app.

From source

You need Node.js 20 or newer and pnpm.

git clone https://github.com/UXCentury/open-bone.git
cd open-bone
pnpm install
pnpm dev

The editor opens at http://localhost:5180 with the Walker example. To run or build the desktop app from source you also need Rust and the Tauri system dependencies (on Linux: webkit2gtk-4.1 and GTK 3):

pnpm desktop        # run it
pnpm desktop:build  # build installers

Releasing covers the installers, signing and the release workflow.

Runtime packages

Packages are published from every release. Pick your platform; each tab links to a quick start.

npm install @openbone/player

Or the engine packages: @openbone/pixi, @openbone/phaser, @openbone/three, @openbone/canvaskit, or the bare @openbone/runtime. → Web quick start

Package Manager → Add package from git URL: https://github.com/UXCentury/open-bone.git#upm, or openupm add com.openbone.runtime. Unity 2021.3 or newer. → Unity quick start

AssetLib tab → OpenBone, or unzip openbone-godot-<version>.zip from the releases into your project. Godot 4.4 or newer. → Godot quick start

flutter pub add openbone

Flutter 3.41+, on Android, iOS, macOS, Linux and Windows. → Flutter quick start

Xcode → Add Package Dependencies → https://github.com/UXCentury/open-bone, product OpenBone. iOS 15+, macOS 12+. → Swift quick start

implementation("io.openbone:openbone-runtime:0.3.0")
// + openbone-scripting, openbone-gdx, openbone-android

From Maven Central. → Android and libGDX quick start

dotnet add package OpenBone.Runtime
dotnet add package OpenBone.MonoGame        # renderer, player, sound
dotnet add package OpenBone.Scripting.Jint  # document scripts

→ MonoGame quick start

add_subdirectory(runtimes/cpp)   # from a checkout; QuickJS and nlohmann/json are vendored

→ C / C++ quick start

Tools

npx openbone --help      # the CLI
npx -y @openbone/mcp     # the MCP server

OpenBone is MIT licensed and made by UXCentury. The example art, voices and sounds are credited in the repository.