wide-video / rive-wasm

Wasm/JS runtime for Rive

Rive Web

A JavaScript/TypeScript and Web Assembly (WASM) runtime library for Rive.

This library allows full control over Rive files with a high-level API for hooking up many simple interactions and animations, as well as a low-level API that allows you to drive your own render loop to create multiple artboards, animations, and state machines all in one canvas.

Table of contents

• ⭐ Rive Overview
• 🚀 Getting Started & API docs
• 🔍 Supported Browsers
• 📚 Examples
• 🏃 Migration Guides
• 👨‍💻 Contributing
• ❓ Issues

Rive Overview

Rive is a real-time interactive design and animation tool that helps teams create and run interactive animations anywhere. Designers and developers use our collaborative editor to create motion graphics that respond to different states and user inputs. Our lightweight open-source runtime libraries allow them to load their animations into apps, games, and websites.

🏡 Homepage

📘 General help docs

🛠 Learning Rive

Getting Started

Follow along with the link below for a quick start in getting Rive JS integrated into your web applications.

Getting Started with Rive in Web

API documentation

Supported Browsers

Rive can be used in all major browsers. We're constantly working to improve performance with our renderer so that animations playback smoothly for all.

Examples

Check out some of the examples/ projects in this codebase, as well as some of the CodeSandboxes below to see examples of using rive-wasm:

High-level API usage

• Simple displaying animation
• Rive with Listeners
• Rive with State Machines

Low-level API usage

• Constructing a render loop
  • Source code
• Centaur game
  • Source code
  • Rive community post - Inspect and download the accompanying Rive file for this example in the Rive community

Awesome Rive

For even more examples and resources on using Rive at runtime or in other tools, checkout the awesome-rive repo.

Migration Guides

Using rive-js or an older version of the runtime and need to learn how to upgrade to the latest version? Check out the migration guides below in our help center that help guide you through major version bumps; breaking changes and all!

Migration guides

Contributing

We love contributions! Check out our contributing docs to get more details into how to run this project, the examples, and more all locally.

Issues

Have an issue with using the runtime, or want to suggest a feature/API to help make your development life better? Log an issue in our issues tab! You can also browse older issues and discussion threads there to see solutions that may have worked for common problems.