RE-UE4SS：虚幻引擎4/5脚本系统完全指南

RE-UE4SS是一个专为虚幻引擎4和5游戏设计的注入式Lua脚本系统平台，提供C++ Modding API、SDK生成器、蓝图mod加载器、实时属性编辑器和其他dump工具。该项目旨在为游戏Mod开发者提供强大的工具集，让Mod开发变得更加简单高效。

核心特性

RE-UE4SS提供了一系列强大的功能，包括：

• Lua脚本API：基于UE对象系统编写Lua Mod
• 蓝图Mod加载：自动生成蓝图Mod，无需编辑或替换游戏文件
• C++ Modding API：基于UE对象系统编写C++ Mod
• 实时属性查看器和编辑器：搜索、查看、编辑和监视每个加载对象的属性，非常适合调试Mod或了解运行时值的变化
• UHT Dumper：生成Unreal Header Tool兼容的C++头文件
• C++头文件生成器：从反射类和蓝图中生成标准C++头文件（带偏移量）
• 通用UE Mod：解锁游戏控制台和其他通用Mod
• 文件解析dump工具：为非版本化属性生成.usmap映射文件
• UMAP重建Dumper：将所有加载的Actor转储到文件以在编辑器中生成.umaps

支持的UE版本

RE-UE4SS支持从UE4.12到UE5.5的所有版本。该项目并非旨在成为一个适用于每个游戏的即插即用解决方案，而是提供一个适用于大多数游戏的底层系统。用户可能需要自行更新AOB（Array Of Bytes）。

安装指南

基本安装

最简单的安装方法是下载最新非实验性构建的非开发版本，并将zip内容解压缩到{游戏目录}/GameName/Binaries/Win64/。

如果游戏在自定义配置列表中，还需要从相关文件夹中提取内容到Win64。

如果计划使用UE4SS进行Mod开发，可以执行相同的操作，但需要下载zDEV版本。

命令行选项

如果通过代理DLL安装RE-UE4SS，可以使用以下命令行选项：

• --disable-ue4ss - 通过使用此参数启动游戏来临时禁用UE4SS
• --ue4ss-path <path> - 指定UE4SS.dll的自定义路径

环境变量

RE-UE4SS支持以下环境变量：

• UE4SS_MODS_PATHS - 要加载的其他Mod目录的分号分隔列表

构建要求

要构建RE-UE4SS，需要满足以下要求：

• 运行Windows的计算机
• 支持C++23的MSVC版本
• Rust工具链>= 1.73.0
• CMake >= 3.22
• 构建系统：Ninja或MSVC

构建说明

克隆仓库和初始化子模块

首先克隆仓库并初始化子模块：

git clone https://gitcode.com/gh_mirrors/re/RE-UE4SS
cd RE-UE4SS
git submodule update --init --recursive

构建模式

构建模式结构为：<Target>__<Config>__<Platform>

支持的选项包括：

• Target: Game（常规游戏）、LessEqual421（UE4.21及以下）、CasePreserving（启用大小写保留的游戏）
• Config: Dev（开发构建）、Debug（调试构建）、Shipping（发布构建）、Test（测试构建）
• Platform: Win64（64位Windows）

基本构建命令

使用CMake构建UE4SS：

# 使用Ninja配置（推荐，构建速度更快，单配置）
cmake -B build_cmake_Game__Shipping__Win64 -G Ninja -DCMAKE_BUILD_TYPE=Game__Shipping__Win64

# 使用Ninja构建
cmake --build build_cmake_Game__Shipping__Win64

# 或使用MSVC配置（多配置，允许在不重新配置的情况下切换配置）
cmake -B build_cmake_Game__Shipping__Win64 -G "Visual Studio 17 2022"

# 使用MSVC构建（需要--config标志）
cmake --build build_cmake_Game__Shipping__Win64 --config Game__Shipping__Win64

配置选项

代理路径

默认情况下，UE4SS基于C:\Windows\System32\dwmapi.dll生成代理。要更改此设置，请设置CMake变量：

cmake -B build -DUE4SS_PROXY_PATH="<代理dll的路径>" -DCMAKE_BUILD_TYPE=Game__Shipping__Win64

分析器类型

默认情况下，UE4SS禁用分析（None）。要启用分析，需要分析器类型和包含STATS的构建配置：

cmake -B build -DPROFILER_FLAVOR=<Tracy|Superluminal|None> -DCMAKE_BUILD_TYPE=Game__Dev__Win64

配置设置

RE-UE4SS提供了丰富的配置选项，可以通过修改assets/UE4SS-settings.ini文件来自定义系统行为。

主要配置部分包括：

• Overrides：Mod文件夹路径设置
• General：常规设置，如热重载系统、缓存设置
• ObjectDumper：对象转储器设置
• CXXHeaderGenerator：C++头文件生成器设置
• UHTHeaderGenerator：UHT头文件生成器设置
• Debug：调试控制台和GUI设置
• Threads：线程设置
• Memory：内存使用限制
• Hooks：各种钩子设置
• CrashDump：崩溃转储设置
• ExperimentalFeatures：实验性功能设置

内置Mod示例

RE-UE4SS提供了多个内置Mod示例，包括：

• CheatManagerEnablerMod：启用作弊管理器功能
• SplitScreenMod：分屏功能Mod
• BPML_GenericFunctions：蓝图Mod加载器通用函数
• LineTraceMod：线性追踪功能
• Keybinds：按键绑定功能
• ConsoleCommandsMod：控制台命令Mod
• ConsoleEnablerMod：控制台启用Mod

这些Mod可以作为学习和开发自定义Mod的参考。

开发资源

RE-UE4SS提供了丰富的开发资源，包括详细的文档、API参考和示例代码。开发者可以通过查看项目中的文档文件夹来深入了解各个功能模块的使用方法。

项目还提供了共享的Lua脚本库，如UEHelpers.lua和Types.lua，这些库包含了常用的辅助函数和类型定义，可以大大简化Mod开发过程。

社区和支持

RE-UE4SS拥有活跃的开发者社区，用户可以通过相关论坛和社区平台获取帮助、分享经验和参与项目开发。

通过掌握RE-UE4SS，开发者可以为虚幻引擎4和5游戏创建强大的Mod和扩展功能，释放游戏的无限潜力。