Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 5.11 KB

README.md

File metadata and controls

109 lines (73 loc) · 5.11 KB
Raw

Discord badge Twitter handle

Rive Unity

rive x unity image

A Unity runtime library for Rive. 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.

Rendering support

Currently supported platforms and backends include:

  • WebGL
  • Metal on Mac
  • Metal on iOS
  • D3D11 on Windows
  • OpenGL on Windows
  • OpenGL on Android

Planned support for:

  • D3D12
  • Vulkan

Feature support

The rive-unity runtime uses the latest Rive C++ runtime.

Feature Supported
Animation Playback ✅
Fit and Alignment ✅
Listeners ✅
Setting State Machine Inputs ✅
Listening to Events ✅
Updating text at runtime ✅
Out-of-band assets ✅
Procedural rendering ✅
PNG images ✅
WEBP and JPEG images ✅

Table of contents

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 Unity docs

🛠 Learning 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 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 as a git dependency, for example (replace 0.0.0 with the latest release):

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.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):

{
  "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 repo.

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.