Skip to content

Quick start

This page walks through the editor with one of the bundled examples. You need the editor: the desktop app, or pnpm dev from a checkout.

  1. Open an example. Choose ☰ Menu → Examples… and pick one. The Knight is a good start: a character with IK legs, a state machine, sounds and a script.

    The Examples dialog with cards for Windswept, Knight, Walker, Pip the fox, Robot, Tail, Rocket and Crash game, each with Open and Download buttons
    Menu → Examples… Each card says what the example shows. Download saves it as one self-contained .obone file.
  2. Play it. Press ▶ Play (or P). Play mode runs the file the way it will ship: the state machine, its inputs, scripts, sound and pointer listeners. Click the knight, press the input buttons in the Inputs panel and watch the log.

    Play mode on the Crash game: the rocket climbing, the 2.37x multiplier text, and the Inputs panel with start, crash and cashout triggers, the multiplier number and the state log
    Play mode: inputs on the right, the active state and a log of every state change, event and sound.
  3. Look at the animations. Press ■ Stop, switch to Animate (`) and pick an animation in the timeline’s list. Press Space to play it. Click a bone in the viewport or the skeleton tree: the Inspector shows its properties, and the dopesheet shows its keys.

    Walker's walk cycle in Animate mode, with the hip bone selected and its keys in the dopesheet
  4. Change something. With ● Rec on, drag a bone in the viewport: a key appears at the playhead. Drag the key in the dopesheet to retime it. Every change can be undone with Ctrl+Z (⌘+Z on macOS).

  5. Export it. Choose ☰ Menu → Export… (Ctrl+E). Pick a format on the left: the project, runtime data for an engine, images, video with sound, or a web page. The preview on the right is what you will get.

    The Export dialog with Project selected, the output options and a preview of the Walker

Press Ctrl+K (⌘+K) for the command palette and type what you want. Every action is there with its shortcut, and the shortcuts can be changed under ☰ Menu → Keyboard shortcuts.

The command palette with 'onion' typed and the Toggle onion skin command highlighted

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