https://github.com/rive-app/rive-unity
https://github.com/rive-app/rive-unity
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/rive-app/rive-unity
- Owner: rive-app
- License: mit
- Created: 2023-10-31T03:49:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-20T22:58:21.000Z (4 months ago)
- Last Synced: 2026-02-21T00:41:19.016Z (4 months ago)
- Language: C#
- Size: 7.97 GB
- Stars: 192
- Watchers: 11
- Forks: 17
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Rive Unity
A Unity runtime library for [Rive](https://rive.app). This is currently a **technical preview** for Mac and Windows installs of Unity. We're hoping to gather feedback about the API and feature-set as we expand platform support.
## Unity Version Support
The package supports Unity LTS versions from 2021 upwards (including Unity 6).
### Rendering support
Currently supported platforms and backends include:
- [WebGL](WEBGL.md)
- Metal on Mac
- Metal on iOS
- D3D11 on Windows
- OpenGL on Windows
- OpenGL on Android
- Vulkan on Windows
- Vulkan on Android
- Vulkan on Linux (x86_64)
Planned support for:
- D3D12
### Feature support
The rive-unity runtime uses the latest Rive C++ runtime.
| Feature | Supported |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [Animation Playback](https://rive.app/community/doc/animation-playback/docDKKxsr7ko) | ✅ |
| [Fit and Alignment](https://rive.app/community/doc/layout/docBl81zd1GB) | ✅ |
| [Listeners](https://rive.app/community/doc/listeners/docRlEVvrCZW) | ✅ |
| [Setting State Machine Inputs](https://rive.app/community/doc/state-machines/docHnjaSeIIr) | ✅ |
| [Listening to Events](https://rive.app/community/doc/rive-events/docvlavjXfq8) | ✅ |
| [Updating text at runtime](https://rive.app/community/doc/text/docn2E6y1lXo) | ✅ |
| [Out-of-band assets](https://rive.app/community/doc/loading-assets/doc1etuJJdEC) | ✅ |
| [Procedural rendering](https://rive.app/community/doc/procedural-rendering/docF2fNqCP1W) | ✅ |
| PNG images | ✅ |
| WEBP and JPEG images | ✅ |
## Table of contents
- ⭐️ [Rive Overview](#rive-overview)
- 🚀 [Getting Started](#getting-started)
- 👨💻 [Contributing](#contributing)
- ❓ [Issues](#issues)
## Rive overview
[Rive](https://rive.app) 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](https://rive.app/)
📘 [General help docs](https://rive.app/community/doc/introduction/docvphVOrBbl) · [Rive Unity docs](https://rive.app/community/doc/unity/doc31LHoppdv)
🛠 [Learning Rive](https://rive.app/learn-rive/)
## Getting started
See the official examples repository to easily run a project locally: https://github.com/rive-app/rive-unity-examples
See the [Rive Unity docs](https://rive.app/community/doc/unity/doc31LHoppdv) for more information.
You will need a Unity editor that supports OpenGL or D3D11 for Windows, or a Mac with ARM64 (M1, M2, etc) architecture and OS 11.0 or later.
Select either D3D11/OpenGL for Windows, or Metal for Mac/iOS as the Graphics API under Project Settings -> Player in Unity.
You can install the Rive package for Unity by opening the Package Manager (Window -> Package Manager) and adding the [latest release](https://github.com/rive-app/rive-unity/releases) as a git dependency, for example (replace 0.0.0 with the [latest release](https://github.com/rive-app/rive-unity/releases)):
```
git@github.com:rive-app/rive-unity.git?path=package#v0.0.0
```
Or through HTTP (replace 0.0.0 with the [latest release](https://github.com/rive-app/rive-unity/releases)):
```
https://github.com/rive-app/rive-unity.git?path=package#v0.0.0
```
You can also add it manually to your projects `Packages/manifest.json` file (replace 0.0.0 with the [latest release](https://github.com/rive-app/rive-unity/releases)):
```json
{
"dependencies": {
"app.rive.rive-unity": "git@github.com:rive-app/rive-unity.git?path=package#v0.0.0"
}
}
```
### Awesome Rive
For even more examples and resources on using Rive at runtime or in other tools, checkout the [awesome-rive](https://github.com/rive-app/awesome-rive) repo.
## Contributing
We love contributions! Check out our [contributing docs](./CONTRIBUTING.md) 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](https://github.com/rive-app/rive-unity/issues) tab! You
can also browse older issues and discussion threads there to see solutions that may have worked for
common problems.