> ## Documentation Index
> Fetch the complete documentation index at: https://rive.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Adding Rive to your Unity project.

[YouTube video player](https://www.youtube.com/embed/DpmsragqAxM)

New to Rive? Start with the [Rive Editor](https://rive.app/docs/editor/fundamentals/overview) to create your graphics, then [export for runtime](https://rive.app/docs/editor/exporting/exporting-for-runtime.md) when you're ready to bring them into Unity.

> [card] [Rive Editor basics](https://rive.app/docs/editor/fundamentals/overview)
>
> Create, rig, and build interactive Rive graphics in the editor.

> [card] [Unity runtime overview](https://rive.app/docs/game-runtimes/unity/unity.md)
>
> Supported Unity versions, graphics backends, and feature support.

## Example projects

To quickly experiment with Rive in Unity, run one of our [example projects](https://github.com/rive-app/rive-unity-examples).

## Installation

The Rive Unity package is available on the Unity Asset Store and on GitHub.

The **Unity Asset Store** has a simpler installation process and only includes the stable package releases. Installing from **GitHub** gives you access to stable releases as well as canary tags, which are updated more frequently and may include [newer/early access features](https://rive.app/docs/feature-support.md) before they land in a stable release.

> [tab] Unity Asset Store
>
> Install the package from the Unity Asset Store:
>
> * [Rive for Unity (Asset Store)](https://assetstore.unity.com/packages/tools/gui/rive-350858)
>
> **Step 1**
>
> Open Window -> Package Manager
>
> **Step 2**
>
> Select My Assets
>
> **Step 3**
>
> Find Rive and select Download / Import

> [tab] GitHub
>
> The [rive-unity package](https://github.com/rive-app/rive-unity) is also available to install from GitHub using a git dependency.
>
> Add it via **Window -> Package Manager** and choose **Add package from git URL...** (replace `0.0.0` with the [latest release](https://github.com/rive-app/rive-unity/releases)):
>
> ```bash theme={null}
> https://github.com/rive-app/rive-unity.git?path=package#v0.0.0
> ```
>
> **Step 1**
>
> Paste the URL with a version tag ![Add package from git URL field in the Package Manager](https://mintcdn.com/rive/IMrXM-oXoMvrTV9Y/images/game-runtimes/unity/929bb6b6-2e4a-45c0-a09b-0c3d4f7c5361.webp?fit=max\&auto=format\&n=IMrXM-oXoMvrTV9Y\&q=85\&s=ae3f4b185d107820ea4c219c2aa25388)
>
> > [!NOTE]
> >
> > Unity can occasionally crash when upgrading the packages while the Editor is running. If you experience this, close Unity first, update the version in `Packages/manifest.json`, then reopen the project.
>
> You can add it manually to your project's `Packages/manifest.json` (replace `0.0.0` with the [latest release](https://github.com/rive-app/rive-unity/releases)):
>
> ```json theme={null}
> "app.rive.rive-unity": "https://github.com/rive-app/rive-unity.git?path=package#v0.0.0"
> ```

## Adding a Rive file to Unity

See our documentation on [Exporting](https://rive.app/docs/editor/exporting/exporting-for-runtime.md) graphics for runtime.

Once you have a `.riv` file, drag it into the Unity **Project** window. Unity will import it and automatically create a **Rive Asset** you can reference from components and scripts.

On the [Marketplace](https://rive.app/marketplace), you can find Rive files that can be remixed.

## Displaying a Rive file

**Drag-and-Drop**

To display a Rive file in UI, drag it into the **Scene Hierarchy**. This creates a screen-space setup inside a uGUI Canvas.

<video controls src="https://ucarecdn.com/c6749dc5-66bb-4125-925c-363c32357881/" />

> [!NOTE]
>
> The `com.unity.ugui` package must be installed to use these components. This is usually included by default in new Unity projects.

To display a Rive file on a mesh, drop the Rive file onto an existing GameObject with a `MeshRenderer`. This creates a **Rive Panel** and adds a **Rive Texture Renderer** component to the mesh GameObject.

<video controls src="https://ucarecdn.com/433ea352-657b-4ebb-bb90-9c228423e018/" />

**Quick Creation Menu**

Right-click in the scene hierarchy to create the following:

* `Rive > Rive Panel` - Creates a standalone panel
* `Rive > Rive Panel (Canvas)` - Creates a UI-ready panel
* `Rive > Widgets > Rive Widget` - Adds a standard Rive widget

## Next steps

> [card] [Fundamentals](https://rive.app/docs/game-runtimes/unity/fundamentals.md)
>
> How files, artboards, and state machines are represented in Unity.

> [card] [Components](https://rive.app/docs/game-runtimes/unity/components.md)
>
> Rive Panel, Rive Widget, and recommended component-based workflows.

> [card] [Data Binding](https://rive.app/docs/game-runtimes/unity/data-binding.md)
>
> Bind your C# scripts to your Rive graphics for UI and gameplay-driven updates.

> [card] [Best Practices](https://rive.app/docs/game-runtimes/unity/best-practices.md)
>
> Performance and usage considerations for Rive in Unity.
