跳到主要内容

开始接入(Getting Started)

本页带你完成:安装插件 → 构建项目 → 导入 .riv → 创建 Widget → 绑定 ViewModel。

前置条件

  • Unreal Engine 5.6 或以上。
  • C++ 工具链。Rive 插件是 C++ 插件,因此无论你以哪种方式安装,它都会作为项目的一部分进行编译:
    • Windows:Visual Studio 2022,并安装 Game development with C++ 工作负载(包含 Unreal 所需的 Windows SDK 和 .NET 组件)。
    • macOS:Xcode,并安装命令行工具(xcode-select --install)。

1)安装插件

Fab(推荐)

  1. 打开 Epic Launcher 或 Unreal Editor
  2. 打开 Fab
  3. 搜索 Rive,或直接访问:
  4. 安装到引擎或项目
  5. 按提示重启 Unreal

GitHub

git clone https://github.com/rive-app/rive-unreal.git

Rive 插件目录放到项目的 Plugins/ 目录中。

2)构建项目

Rive 插件是 C++ 插件,因此项目必须先完成编译,编辑器才能加载它。

Windows

  1. 右键点击 .uproject 文件,选择 Generate Visual Studio project files
  2. 在 Visual Studio 2022 中打开生成的 .sln
  3. 将配置设为 Development Editor / Win64,然后构建项目。

macOS

  1. 右键点击 .uproject 文件,选择 Generate Xcode project
  2. 在 Xcode 中打开生成的项目,并构建 editor target。

你也可以直接双击 .uproject 文件;如果插件模块尚未构建,Unreal 会询问是否重新构建,点击 Yes 即可。

3)启用插件

  1. 打开 Edit -> Plugins
  2. 在 Runtime 下找到 Rive
  3. 启用并重启编辑器(如提示)

4)导入 Rive 文件

.riv 拖进 Content Browser。Unreal 会创建 Rive File 资产。

注意:Rive File 是资产对象,本身不会直接渲染。

Unreal 目前不支持 Referenced 资源,请在 .riv 中使用 Embedded 资源。

5)创建 Widget

右键 Rive File 资产,选择 Create Rive Widget

你可以双击查看生成的 Widget 配置。

6)在 Blueprint 使用

和普通 Widget 一样把它加进 Blueprint / UMG。

7)绑定 ViewModel

若文件未启用自动绑定(autobinding),需要手动通过 Make View Model 创建并绑定实例。

完成后就可以在应用中驱动 Rive 内容。下一步建议看: