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

# Getting Started

> Adding Rive to your Unity project.

export const YouTube = ({id, timestamp}) => {
  const videoSrc = timestamp ? `https://www.youtube.com/embed/${id}?start=${timestamp}` : `https://www.youtube.com/embed/${id}`;
  return <iframe width="100%" height="400" src={videoSrc} title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen />;
};

<YouTube id="DpmsragqAxM" />

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

<CardGroup cols={2}>
  <Card title="Rive Editor basics" href="/editor/fundamentals/overview">
    Create, rig, and build interactive Rive graphics in the editor.
  </Card>

  <Card title="Unity runtime overview" href="/game-runtimes/unity/unity">
    Supported Unity versions, graphics backends, and feature support.
  </Card>
</CardGroup>

## 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](/feature-support) before they land in a stable release.

<Tabs>
  <Tab title="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)

    <Steps>
      <Step>
        Open Window -> Package Manager
      </Step>

      <Step>
        Select My Assets
      </Step>

      <Step>
        Find Rive and select Download / Import
      </Step>
    </Steps>
  </Tab>

  <Tab title="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
    ```

    <Steps>
      <Step>
        Paste the URL with a version tag <img src="https://mintcdn.com/rive-transitions-2/V0qymUioAXT1aguO/images/game-runtimes/unity/929bb6b6-2e4a-45c0-a09b-0c3d4f7c5361.webp?fit=max&auto=format&n=V0qymUioAXT1aguO&q=85&s=4f524af39160f6b822a3e810d0d9d264" alt="Image" width="430" height="338" data-path="images/game-runtimes/unity/929bb6b6-2e4a-45c0-a09b-0c3d4f7c5361.webp" />
      </Step>
    </Steps>

    <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.
    </Note>

    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"
    ```
  </Tab>
</Tabs>

## Adding a Rive file to Unity

See our documentation on [Exporting](/editor/exporting/exporting-for-runtime) 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 className="w-full aspect-video" 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.
</Note>

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 className="w-full aspect-video" 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

<CardGroup cols={2}>
  <Card title="Fundamentals" href="/game-runtimes/unity/fundamentals">
    How files, artboards, and state machines are represented in Unity.
  </Card>

  <Card title="Components" href="/game-runtimes/unity/components">
    Rive Panel, Rive Widget, and recommended component-based workflows.
  </Card>

  <Card title="Data Binding" href="/game-runtimes/unity/data-binding">
    Bind your C# scripts to your Rive graphics for UI and gameplay-driven updates.
  </Card>

  <Card title="Best Practices" href="/game-runtimes/unity/best-practices">
    Performance and usage considerations for Rive in Unity.
  </Card>
</CardGroup>