Getting started

Run Rive on your platform of choice.

The Rive runtimes are open-source libraries that allow you to load and control your animations in apps, games, and websites. Dive into each of the subpages to get started!

How to use this guide

In this section you'll find runtime subpages that provide all the needed information and resources to get started on your platform of choice. See Installation and Getting Started below.

You'll also find pages dedicated to controlling your animation at runtime. For example, updating a state machine input or text run. See Animation Control and Interaction below.

Installation and Getting Started

Make sure to check out the additional documentation provided under each runtime section. These documents provide platform-specific considerations, migration guides, and advanced usage information.

8 articles

Web (JS)

This guide documents how to get started using the Web runtime library.

5 articles

React

This guide documents how to get started using the React runtime library.

7 articles

React Native

This guide documents how to get started using the React Native runtime library.

5 articles

iOS/macOS

This guide documents how to get started using the iOS/macOS runtime library.

Android

This guide documents how to get started using the Android runtime library.

5 articles

Flutter

This guide documents how to get started using the Flutter runtime library.

8 articles

Unity

This guide documents how to get started using the Unity runtime library.

5 articles

Bevy

This guide documents how to get started using the Bevy runtime library.

Unreal

This guide documents how to get started using the Unreal runtime library.

Animation Control and Interaction

These sections provide details on how to interact with your Rive animations at runtime. Here, you'll find documentation and code samples for all of Rive's official runtimes.

Animation Playback

Configuring runtime animation playback properties.

Layout

Controlling your Rive graphic's layout (fit and alignment) at runtime.

State Machine

Interacting with Rive state machines from runtime.

Text

Update Rive text at runtime.

Playing Audio

Runtime audio properties and controls.

Rive Events

Subscribe to Rive events at runtime.

Loading Assets

Loading and replacing assets (images, fonts, audio) dynamically at runtime.

Caching a Rive File

Cache and reuse a Rive file object across multiple Rive instances.

Other Sections

2 articles

Choose a Renderer

Specify the desired renderer to use at runtime. Each runtime provides different options. We recommend using the Rive Renderer.

Format

The Rive File format.

Feature Support

Runtime support for Rive features.

Versioning

As we publish updates to our Rive editor, we will occasionally push updated runtimes to support the new features. See for the required minimum runtime version needed for specific features.

In most cases, the newest runtimes will also support previous versions of your Rive assets, so you will not need to re-export assets to update to the latest runtimes.

There are a number of ways to export your Rive files in cases where re-exporting is necessary to take advantage of the latest features. Check out our documentation on for more information.

Official runtimes

Check out the runtime subpages for steps on how to get started!


Web	All web runtimes are distributed by npm: (Recommended) canvas canas-lite canvas (advanced) webgl webgl (advanced) See for more on the differences between these dependencies
React	All React runtimes are distributed by npm: (Recommended) canvas canvas-lite webgl GitHub
iOS/macOS	The iOS/macOS runtime is distributed by: Swift Package Manager Cocoapods GitHub
Android	maven, GitHub
Flutter	pub.dev, GitHub
C++ (Mac/Linux/Windows)	GitHub
C#	(Recommended) UWP WinUI (High-level API) RivePlayer Github (Low-level API) RiveSharp Github
Tizen	GitHub
React Native	npm, GitHub

Community Runtimes

Runtime	Author	Link
Vue.js	Dan Nelson	GitHub
Angular	François Guezengar	GitHub
QtQuick	basysKom	Github
AWTK	Li XianJing	GitHub

Handling .riv Files

When checking in .riv files with Git, consider adding a .gitattributes file and marking .riv files as binary files to prevent Git from changing line endings when these files are checked in. Otherwise, some platforms may accidentally corrupt the .riv file where there are line returns (i.e. Windows CRLF line endings vs LF line endings) and cause issues at runtime when the file is read.

.gitattributes

*.riv binary

Licensing

Our official runtimes are all open-source and licensed under the MIT License. You're free to use them for personal and commercial applications.

Contributing

Since all the runtimes are open-source, we encourage you to dive in and take a look around! If you see something missing or feel you can improve upon it, then fork it!

Tagging

Web (JS)