虚幻引擎 4/5 脚本系统

Lua 脚本系统平台、C++ Modding API、SDK 生成器、蓝图 mod 加载器、实时属性编辑器和其他适用于 UE4/5 游戏的转储实用程序。

• Lua Scripting API : 基于 UE 对象系统编写 lua mods

• 蓝图模块加载：无需编辑/替换游戏文件即可自动生成蓝图模块

• C++ Modding API：基于 UE 对象系统编写 C++ 模组

• 实时属性查看器和编辑器：搜索、查看、编辑和观察每个加载对象的属性，非常适合调试模块或弄清楚运行时值是如何变化的

• UHT Dumper：生成与 Unreal Header Tool 兼容的 C++ 头文件，用于为您的游戏创建镜像 .uproject

• C++ Header Dumper：从反射类和蓝图生成标准 C++ 头文件，带有偏移量

• 通用 UE 模组：解锁游戏机和其他通用模组

• 文件解析转储器：为未版本化的属性生成.usmap映射文件

• UMAP 娱乐转储器.umaps：将所有加载的演员转储到文件以在编辑器中生成

• 其他功能，有时包括实验性功能

UE4SS 的目标并非打造一个适用于所有游戏的即插即用解决方案。我们的目标是打造一个适用于大多数游戏的底层系统。您可能需要自行更新 AOB，下方提供了相关指南。

最简单的安装方法是从Releases下载最新非实验版本的非开发版本，并将 zip 内容提取到{game directory}/GameName/Binaries/Win64/。

如果您的游戏在自定义配置列表中，请从相关文件夹中提取内容Win64。

如果您计划使用 UE4SS 进行 mod 开发，您可以执行与上述相同的操作，但下载 zDEV 版本。

完整安装指南

解决兼容性问题

Lua API 概述

生成 UHT 兼容标头

自定义游戏配置

创建兼容的蓝图模块

UE4SS Discord 服务器邀请

虚幻引擎改装 Discord 服务器邀请

• 运行 Windows 的计算机。

• Linux 支持可能会在某个时候出现，但不会很快出现。

• 支持 C++23 的 MSVC 版本：

• MSVC 工具集版本 >= 14.39.0

• MSVC 版本 >= 19.39.0

• Visual Studio 版本 >= 17.9

• 希望将来能够支持更多的编译器。

• Rust 工具链 >= 1.73.0

• xmake >= 2.9.3

1. 克隆 repo。

2. 执行此命令：git submodule update --init --recursive 确保您的 Github 帐户已关联到您的 Epic Games 帐户，以便访问 UE 源代码。请勿使用该--remote选项，因为这会强制第三方依赖项更新到最新提交，这可能会造成问题。您需要将您的 Github 帐户关联到 Epic Games 帐户才能提取虚幻伪代码子模块。

您可以通过多种不同的方式构建 UE4SS。

xmake允许您灵活配置一些构建选项以满足您的特定需求。以下是一些您可能会觉得有用的配置设置的非完整列表。

使用以下任意选项进行配置后，您可以使用或xmake构建项目。xmakexmake build

构建模式的结构如下：<Target>__<Config>__<Platform>

目前支持的选项有：

• Target

• Game- 适用于高于 UE 4.21 版本的常规游戏

• LessEqual421- 适用于低于或等于 UE 4.21 版本的常规游戏

• CasePreserving- 适用于启用保留大小写功能的游戏

• Config

• Dev- 开发构建

• Debug- 调试构建

• Shipping- 发货（发布）构建

• Test- 为测试而构建

• Platform

• Win64- 64 位 Windows

默认情况下，patternsleuth 工具会以 xmake 包的形式自行安装。如果您不打算修改 patternsleuth 源代码，则无需进行任何特殊配置。如果您希望能够修改 patternsleuth 源代码，则必须提供选项--patternsleuth=local，xmake config以便将 patternsleuth 作为 UE4SS 构建的一部分重新编译。

默认情况下，UE4SS 根据 生成代理C:\Windows\System32\dwmapi.dll。如果您出于任何原因想要更改此设置，可以将 添加到命令--ue4ssProxyPath=<path proxy dll>中xmake config。

默认情况下，UE4SS 使用 Tracy 进行性能分析。您可以传递--profilerFlavor=<profiler>给该xmake config命令来设置性能分析器风格。目前支持的风格包括Tracy、Superluminal和None。

默认情况下，xmake 会检查你是否安装了最低要求的 Rust 或 MSVC 版本（如果你使用了 MSVC 工具链）。如果没有，则会在 configure 步骤抛出错误。如果你想忽略此检查，可以将其传递--versionCheck=n给xmake config命令。

一旦设置了标志，选项值就会被设置，直到您另行指定为止。

因此，为了在运行时不检查版本xmake project -k vsxmake2022，必须先运行该xmake config --versionCheck=n命令，然后再运行该xmake project -k vsxmake2022命令。

您可能会遇到一些更高级的xmake命令。下面列出了一些有用的命令（非完整列表）。

要生成 Visual Studio 项目文件，请运行该xmake project -k vsxmake2022 -m "Game__Shipping__Win64"命令。

然后打开目录.sln中生成的文件vsxmake2022

请注意，如果您更新的原因不是因为其他人推送了更新，而您只是在追赶它，那么您还应该提交并推送您已更新的子模块。

我们仅正式支持使用msvc-wine进行交叉编译。
请确保您已安装 winbind（Arch 上支持 libwbclient 和 samba）。

您需要使用rustup安装x86_64-pc-windows-msvc目标（而非目标）。 调用 时，必须设置、和。 您还必须使用、 和 禁用版本检查。 以下项目在交叉编译时不受支持，并会自动禁用：windows-gnu
xmake f--plat--arch--sdk
--ue4ssCross=msvc-wine

proxy
proxy_generator
UVTD

调用xmakebuild 命令时，patternsleuth 将自动构建，无需 xmake。
二进制文件位于 中deps/first/patternsleuth_bind/target/x86_64-pc-windows-msvc。当设置为
时，xmake 会自动使用它们。 以下是在 Linux 机器上构建 Windows 二进制文件的完整命令示例：--ue4ssCrossmsvc-wine

xmake f -m "Game__Shipping__Win64" -p windows -a x64 --sdk=/home/<username>/my_msvc/opt/msvc --versionCheck=n --ue4ssCross=msvc-wine

可以使用 进行调试winedbg。
您还可以调试小型转储：

winedbg crash_2024_12_26_07_39_15.dmp

请记住，调试符号不会存储在 dmp 文件中，您必须拥有与构建 UE4SS.dll 时完全相同的符号文件 (PDB)。
确保符号正确的最简单方法是构建生成 dmp 文件的同一提交。

如果你想更新 git 子模块，你可以使用以下三种方式之一：

1. 您可以执行git submodule update --init --recursive来更新所有子模块。

2. 您也可以选择通过执行 来逐个更新子模块。除非您确实想更新到最新的提交，否则git submodule update --init --recursive deps/<first-or-third>/<Repo>请不要使用该选项。--remote

3. 如果您宁愿选择一个特定的提交或分支来更新子模块，然后cd进入该依赖项的子模块目录并执行git checkout <branch name or commit>。您可能想要不时更新的主要依赖项是deps/first/Unreal。