NOTE: This repository uses a deprecated version of the Rive Unreal plugin. It is being kept visibile for those using old versions of the plugin. The rive-unreal-demos repository contains examples using the newer Rive Unreal plugin and API.

Clone the project.

git clone [email protected]:rive-app/rive-unreal-examples.git
cd rive-unreal-examples
git submodule init
git submodule update

RiveExamples_-_Unreal_Editor_2024-03-02_16-18-28.1.mp4

a. How to start the project

• Download the release from GitHub https://github.com/rive-app/rive-unreal/releases/tag/0.1.0.
• Install UE 5.3 - Epic Games Launcher.
• Install Visual Studio for Windows Visual Studio Guide or Xcode for Mac.

💡 If you are using Windows, you would need to set the RHI interface to use DX11.

💡 If you are making an Android Build, make sure using OpenGL instead of Vulcan.

• Open the project and play the DemoRoom game. /Content/Rive/DemoRoom.umap

• DemoRoom input control

Keybind	Explanation
Mouse XY 2D-Axis	Look
W	Move Forward
A	Move Left
S	Move Backward
D	Move Right
Space	Jump
Shift	Speed Up
Esc	Exit Game

b. How to use Rive in Unreal Engine

• Import .riv assets into Unreal Engine

1. Create asset in Rive Editor
2. Download asset

3. Import file - Drag and Drop into UE

• Create UMG Widget asset with Rive Widget

• Create Rive Instance from Rive File

• Assign Rive File as material to 3D geometry

• Spawn Rive Widget Actor

• Adjust Rive File Properties

You can adjust settings of a Rive file using the following properties.

• Artboard Name
• State Machine Name
• Rive Fit Type
• Size

c. How to use Rive blueprints

See example blueprints under /Content/Rive/RiveExampleContent/Blueprints/

• Runtime single artboard workflow

Initialize 1 artboard in runtime. See example, BP_SingleArtboard for complete blueprint logic.

• Runtime Multiple artboard workflows

1. Initialize 3 artboards in runtime. See example, BP_MultiArtboards for complete blueprint logic.

2. transform/translate/align

3. Create runtime widget

4. Resize the texture

• Sending condition events from UE to Rive

See example, BP_3DConditionsEvent for complete blueprint logic.

1. Create event and bind events to transition in Rive Editor

2. Create binding event in UE so it can change conditions in Rive

• Receiving reported events

See example, BP_3dReportedEvents for complete blueprint logic.

1. Create event and event properties in Rive Editor

2. Listen to reported events in UE

• UE 3D widget User Input interaction

See example, BP_3dUserInput for complete blueprint logic.

1. Create Inputs in Rive Editor

2. Create Blueprint Set Bool Value/Set Number Value/ Fire Trigger