Unreal Getting Started

Getting Started

Adding Rive to your Unreal project.

The rive-unreal package is currently in Technical Preview for macOS and Windows. It currently only supports Unreal v5.3

Build requirements

Specific platform dependencies and build tools are needed to compile the Rive plugin.

These steps are only a temporary requirement before the plugin is distributed through Unreal's Marketplace.

Unreal Version

  • Install UE 5.3.2 - Epic Games Launcher.

  • Ensure that 5.3.2 is set as the current version:

  • Ensure Engine Source is checked from the Options launcher shown above:

Work is underway to support newer (and older) versions of Unreal. If you require a specific version of Unreal to be supported, please reach out to us on our support channel.

MacOS

The plugin should work on M-Series chips and Intel. Please file an issue on Github if you're encountering difficulties and share you environment details.

Steps:

  • Install XCode for MacOS.

Windows

At the moment Rive-Unreal only supports DX11 on Windows. Work for direct RHI integration, DX12, and Vulkan is in progress.

Steps:

  1. Install Visual Studio for Windows.

  2. Follow these instructions for setting up Visual Studio for Unreal development.

  3. Ensure your project RHI is set to DirectX 11:

Debug steps:

Follow these additional steps if you're encountering issues building.

  • For the Visual Studio Installer within the Game development with C++ section, be sure to also check:

    • Unreal Engine installer

    • Unreal Engine Test Adapter

    • Unreal Engine uproject support (Preview)

  • Ensure Visual Studio and toolchains are updated to the latest versions.

  • Ensure you're using a supported version of MSVC. You may run into Windows Toolchain issues, for example:

"UnrealBuildTool has banned the MSVC 14.39.33519-14.39.99999 toolchains due to compiler issues. Please install a different toolchain such as 14.38.33130 by opening the generated solution and installing recommended components or from the Visual Studio installer.

Example projects

To quickly experiment with rive-unreal, take a look at our example project. This sample project demonstrates various Rive features and ways to render Rive content. The blueprint code provides additional instructions and comments on using Rive-Unreal.

Follow these steps:

  1. Ensure you've completed the steps outlined in Build requirements above.

  2. Download the latest project from the Github releases tab (named rive-unreal-examples.zip).

  3. Extract the project and run RiveExamples.uproject.

  4. Wait a bit until a popup appears, asking to build missing modules. Select yes.

  5. It may take a while to open the project the first time and appear as if nothing is happening. It shouldn't take longer than a few minutes.

  6. Play the DemoRoom game (/Content/Rive/DemoRoom.umap).

Debug steps:

  • See the debug steps in Build requirements.

  • If you encounter difficulties compiling, please report the issue on our Github.

Add Rive to an existing project

We plan to distribute the Rive Unreal plugin as a free asset on the Unreal Marketplace. Until then, the following steps are needed to add Rive to an existing project.

Steps:

  1. Ensure you've completed the steps outlined in Build requirements above. Shut down the Unreal Editor if it is open.

  2. Download the latest version of the plugin from the Github releases tab (named rive-unreal.zip)

  3. Extract the zip and copy the content to your Unreal project in the file system folder Your-Project-Name/Plugins/Rive/

  4. Open your project .uproject file.

  5. Wait a bit until a popup appears, asking to build missing modules. Select yes.

  6. It may take a while to open the project the first time and appear as if nothing is happening. It shouldn't take longer than a few minutes.

  7. Once the project is open, ensure that the Rive plugin is enabled: Settings->Plugins and search for Rive.

Now you can add Rive content!

Debug steps:

  • See the debug steps in Build requirements.

  • For Windows, ensure the RHI is set to DirectX 11.

  • If you encounter difficulties compiling, please report the issue on our Github.

Adding a Rive file to Unreal

See our documentation on real-time content.

Once you have a .riv file, you can simply drag it into the Unreal asset panel, which will automatically create a RiveFile object, a Material, and a Widget Blueprint. On our Community Page, you can find Rive content that can be remixed and used in your project. 

See the following sections on using the RiveFile object.