Unity

The com.openbone.runtime package imports .obone and .obonb files and plays them with the C# runtime: animation and state-machine components, meshes, pointer listeners, scripts (Jint) and sound through AudioSources. Tested in Unity 6.

Install

Package Manager → + → Add package from git URL:

https://github.com/UXCentury/open-bone.git#upm

or with OpenUPM:

openupm add com.openbone.runtime

Export from the editor

Export your project as JSON or Binary (☰ Menu → Export…), or save the .obone project itself. Keep the images next to it, or pack an atlas, or embed them.

Play it

1. Put hero.obone (and its images, unless they are embedded) in Assets/.
2. Create a GameObject and add OpenBone → OpenBone Animation (or OpenBone State Machine). Set Asset to the imported file.
3. Set Start Animation or State Machine, and Pixels Per Unit (default 100).
4. Add OpenBone → OpenBone Audio to the same object to hear the document’s sounds.
5. Point an orthographic camera at the component’s StageBounds: the stage as framed in the editor.

using OpenBone.Unity;
using UnityEngine;

public class Hero : MonoBehaviour
{
    public OpenBoneAnimation anim;
    public OpenBoneStateMachine machine;

    void Start()
    {
        anim.Play("walk");                       // loop on track 0
        anim.Queue("jump", loop: false);         // after walk completes
        anim.onEvent.AddListener((name, i, f, s) => Debug.Log($"event {name}"));

        machine.SetBool("walk", true);
        machine.Fire("attack");
        machine.onStateChanged.AddListener((layer, state) => Debug.Log($"{layer}: {state}"));
    }
}

Pointer listeners work through the EventSystem (the default): the scene needs an EventSystem and the camera a Physics 2D Raycaster; a BoxCollider2D is added at start if the object has none.

Tip

Only need pre-rendered frames? The Export dialog’s Unity engine pack makes a sprite sheet and an editor script that creates Animation clips. See Exporting.

Reference: Unity package · C# runtime · OpenBone.Runtime on NuGet