rive-bevy

A Bevy runtime library for Rive.

For comprehensive guides, refer to the rive-bevy documentation.

Note

This runtime uses Vello as a render back-end, which has certain limitations. Refer to Known Issues for details. Efforts are underway to incorporate the Rive Renderer as another back-end.

Table of contents

• ⭐️ Rive Overview
• 🚀 Getting Started
• 👨‍💻 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 · Rive Bevy docs

🛠 Learning Rive

👾 Rive for Game UI

Getting Started

The Rive Bevy runtime makes use of the Rive Rust runtime.

You will need a Rust toolchain and a C compiler to build. You can can install the Rust toolchain using [rustup].

Run one of the example projects:

git clone https://github.com/rive-app/rive-bevy
cd rive-bevy/
cargo run --example ui-on-cube

There are a number of demos/games in the examples folder that showcase various Rive features.

See the Rive Bevy documentation for additional guides.

Awesome Rive

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

Contributing

We love contributions!

If you need to make changes to the underlying Rive Rust runtime code you'll need to update your dependencies to point to a local version of the package.

rive-rs = { path = "/loca/path/to/rive-rs", features = [
    "vello",
] }

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.

Known Issues

The existing Vello render back-end may lead to some inconsistencies in comparison to the original design:

• Image meshes: They can exhibit small inconsistencies at triangle borders, there can be gaps between triangles, transparent meshes will overdraw at triangle borders.
• Very high number of clips: Vello is currently rendering very high numbers of clips incorrectly.
• All strokes will have round joins and caps.

Efforts are being made to make the Rive Renderer available. You'll then have the choice to select your preferred renderer.