Skip to content
Skip to content
Overview

Chorono runtimes and SDKs

Use a runtime to play an exported Chorono scene inside an application. JavaScript and Android packages are available today. Other platform projects are in development, with their current status listed below.

In this section

JavaScript / TypeScript

Install @chorono/runtime, load a runtime export into a canvas and control playback with the JavaScript and TypeScript API.

React

Mount a Chorono canvas player in React with cancellation, effect cleanup and the published @chorono/runtime package.

Vue

Mount a Chorono canvas player in Vue and release its clock and listeners when the component unmounts.

SDK downloads & status

Download the versioned Chorono JavaScript runtime from npm or CDN and check which additional SDK distributions are available.

Android / Compose

Install Chorono Android SDK 1.0.0 from Maven Central, load a scene in Jetpack Compose and download the published AAR and sources.

WebAssembly

Coming soon: a WebAssembly animation SDK with a shared C++ core. Review its partial renderer and the published JavaScript alternative.

Web Component

Coming soon: a custom element for embedding Chorono animations. See what is being built and how to use the JavaScript player today.

iOS / Swift

Coming soon: native Chorono animation playback for iOS and Swift. Review the CoreGraphics prototype and current rendering limitations.

Flutter

Coming soon: Chorono vector animation playback in Flutter. Explore the FFI and widget work underway before a public plugin is available.

React Native

Coming soon: a React Native component for native Chorono animation playback. Check bridge status and its difference from the React web guide.

Kotlin Multiplatform

Coming soon: a shared Kotlin API for Chorono animations. Review platform implementation status and the available Android SDK.

HarmonyOS

Coming soon: Chorono animation playback for HarmonyOS and ArkUI. See the ArkTS component and native bridge work still in development.

Desktop / SDL2

Coming soon: a C++ and SDL2 player for Chorono desktop animations. Check the prototype renderer and remaining playback work.

macOS / AppKit

Coming soon: Chorono animation playback in native macOS AppKit views. Review the view prototype and planned player connection.

Qt / QML

Coming soon: a Qt/QML component for Chorono animation scenes. Check QPainter integration status and how it differs from QML property animation.

Node.js

Coming soon: server-side Chorono animation rendering in Node.js. Review the native bridge and unfinished frame and video export paths.

Python

Coming soon: a Python interface for rendering Chorono animation scenes. Review native bindings, Pillow drawing and current limitations.

Samsung Tizen

Coming soon: Chorono animation playback in Samsung Tizen TV apps. Check runtime loading, remote input and packaging work underway.

LG webOS

Coming soon: Chorono animations in LG webOS TV apps. Review the application shell and remaining playback and Magic Remote work.

WeChat Mini Program

Coming soon: a Chorono animation component for WeChat Mini Programs. Check canvas playback, scene loading and player lifecycle status.

Choose a playback path#

TargetCurrent pathDistribution
JavaScript / TypeScriptCanvas playback and player API@chorono/runtime 0.1.0
ReactComponent lifecycle guideUses @chorono/runtime
VueComponent lifecycle guideUses @chorono/runtime
Plain HTMLVersioned browser-global scriptSame runtime, via CDN
Android / Jetpack ComposeNative Android SDKcom.grntsoftware:chorono-android-sdk:1.0.0 on Maven Central

Open SDK downloads for npm, the package archive and the browser files. React and Vue are usage guides for the published player, not separate SDK releases.

Platforms in development#

The runtime family also includes the following projects. Their source ranges from an initial API outline to a partial renderer; these entries do not mean a complete SDK is ready to install.

Platform familyProjectsCurrent stage
WebWebAssembly SDK, Web ComponentPartial WASM renderer; Web Component playback connection still in development
Mobile and shared app codeiOS, Flutter, React Native, Kotlin Multiplatform, HarmonyOSPartial iOS renderer; other platform bridges and drawing paths are being built
DesktopSDL2 desktop player, macOS, Qt/QMLEarly desktop drawing and view components; complete playback is not ready
Server and scriptingNode.js, PythonInitial rendering APIs; frame output and video export are unfinished
TVs and mini programsSamsung Tizen, LG webOS, WeChat Mini ProgramApp/component shells; playback and device input are unfinished

Each platform has its own guide below. See upcoming distributions for a compact status comparison. Public downloads will be added when a release is available and its supported behavior has been checked.

The shared C++ core and planned GPU renderer support the native runtime family. The separate Chorono Render project is a local 3D rendering tool, with its editor connection still in development; it is not a replacement for a 2D playback SDK.

How playback fits together#

For the published JavaScript player:

  1. Create the animation in the Editor.
  2. Keep an editable project.
  3. Export a runtime JSON package and inspect its warnings.
  4. Load the package and pass its runtime payload to ChronoPlayer.
  5. Render through CanvasRenderAdapter and control playback from your application.

The player uses milliseconds for playback time. Canvas dimensions should match the exported composition; CSS can scale its display size independently.

For Android, use the Maven installation instructions. JavaScript's ChronoPlayer and CanvasRenderAdapter calls are specific to the browser package; native SDKs have their own APIs and scene-loading requirements.

Authoring and playback are separate APIs#

JavaScript scene scripting runs in the editor's isolated MCP bridge and changes the editable scene. @chorono/runtime runs in your application to play a scene. Do not use editor scripting calls as playback SDK methods.

Check compatibility#

Pin the package version and test the exact exported scene. An editor release may support features that the published runtime does not yet reproduce. Review fonts, media loading, effects, interactions and the first and last frames on the target browser.

The quick-start examples use the website's reviewed title-card runtime export. They are a starting point for integration, not a claim that all editor features have identical output on every platform.

A good place to start
Getting started / Chorono documentationChorono documentationLearn Chorono with editable animation examples. Install the editor, edit keyframes, build loops and connect Claude Code or Codex through MCP. Cre…Getting started / Install ChoronoInstall ChoronoSet up the free, open-source animation editor on your computer and start a local browser session. This guide installs the browser editor, its loc…Getting started / Create your first editable animationCreate your first editable animationOpen an editable Chorono example, change its text and colors, inspect the timeline, then save and reopen your first 2D animation. Start with a re…Workspace / Chorono editor workspaceChorono editor workspaceFind the canvas, layers, properties, timeline and resource tools in the Chorono editor. Choose a guide for each part of your animation workflow.…Workspace / Canvas and drawing toolsCanvas and drawing toolsNavigate the canvas, draw shapes and splines, use snapping and edit motion keys in Chorono. Use the canvas to arrange the objects in your composi…Workspace / Choose a drawing or transform toolChoose a drawing or transform toolUse Select, Pan, Pen, Move, Rotate, Scale and Anchor tools without losing track of the active editing mode. Choose the tool that matches the edit…Workspace / Select exactly the objects you needSelect exactly the objects you needUse box, lasso, circle, paint and rule-based selection to work with several animation layers. When several objects overlap, clicking each one can…Workspace / Align objects with guides and snappingAlign objects with guides and snappingSet grid, object, point, guide, pixel, angle and scale snapping for precise placement in Chorono. Snapping helps a dragged object settle on an ex…Workspace / Edit Bézier points and spline curvesEdit Bézier points and spline curvesDraw editable paths, adjust points and handles, and extend or close a spline in Chorono. A curve is easier to control when you can see the points…Workspace / Edit animation positions on the canvasEdit animation positions on the canvasUse Motion Keys to adjust position keys, draw a movement and control how the path is timed. Motion Keys bring position editing onto the canvas. T…Workspace / Layers and scene hierarchyLayers and scene hierarchySelect, name, group and organize scene objects in Chorono using the Layers panel and Scene Explorer. A layer is an editable object in your Choron…Workspace / Draw and edit basic shapesDraw and edit basic shapesCreate rectangles, circles, polygons and procedural shapes, then adjust their geometry in Properties. Basic shapes are a useful starting point fo…
Explore the docs