Unreal Engine 4

Unreal Engine 4/5 Scripting System

Supports the Lua scripting system platform, C++ Modding API, SDK generator, blueprint module loader, real-time property editor and other drop functions of UE4/5 games.

Main features

• Lua Scripting API: Write lua mods based on the UE object system
• Blueprint Modloading: Automatically load blueprint modules without editing/replacing game files
• C++ Modding API: write C++ mods based on the UE object system
• Live Property Viewer and Editor: Search, view, edit properties of loadable objects, and observe how values ​​are modified at runtime, ideal for debugging mods or finding out how values ​​are modified at runtime
• UHT Dumper: Generate C++ header files compatible with Unreal Header Tool for your game and create an image .uproject
• C++ Header Dumper: Generate standard C++ headers from reflection classes and blueprints, including offsets
• Universal UE Mods: Unlock game consoles and other universal mods
• Dumpers for File Parsing: Generate `.usmap` mapping files for versionless attributes
• UMAP Recreation Dumper: Dump all loaded actors to a file to generate `.umaps` in-editor
• Other features, including sometimes experimental functionality

Targeted UE version: from 4.12 to 5.2

The goal of UE4SS is not to be a plug-and-play solution that will always work with every game.

The goal is to have a basic system that works for most games.

You may need to update AOBs yourself, there is a guide below.

Basic installation

The easiest way to install is by downloading the latest non-experimental build of xinput and extracting the zip contents to `/{Gameroot}/GameName/Binaries/Win64/`.

If your game is in the custom configuration list, also extract the contents of the relevant folder to `Win64`.

Link

Complete installation guide

Fix compatibility issues

Lua API - Overview

Generate UHT compatible header files

Custom game configuration

Create a compatible blueprint module

UE4SS Discord server invitation

Unreal Engine Modding Discord Server Invitation

Build requirements

• A computer with Windows operating system is required.

-Linux support may happen at some point in the future, but not anytime soon.

• MSVC version that supports C++20 (including std::format).
• Visual Studio 2019 (recent version), and Visual Studio 2022 are both available.
• Looking forward to supporting more compilers.

Build Guide

• Clone the repository.
• Execute the following command: `git submodule update --init --recursive`

Make sure your Github account is linked to your Epic Games account to gain access to the UE source code.

Never use the `--remote` option as it will force updates of third-party dependencies to the latest commit, which may break things.

You need to link your github account to an Epic games account to pull the Unreal pseudocode submodule.

• You can build UE4SS in one of the following three ways.
• Execute the following command: `build_auto.bat`, for example: `build_auto.bat Release ue4ss`

Valid Build modes are `Release` and `Debug`, valid targets are `ue4ss` and `xinput1_3`.

Supports parallel compilation.

• Open the root UE4SS directory in CLion, select `ue4ss` or `xinput1_3` in the target list and click the Build button.

Parallel compilation is not supported in this method.

• Execute `VS_Solution/generate_vs_solution.bat` to generate the Visual Studio solution file.

Open the solution using Visual Studio 2019 or Visual Studio 2022, select the build type and build the `ue4ss` project.

Parallel compilation is supported in this approach.

Update dependencies

If you want to update dependencies, you can do so in one of three ways:

• You can execute `remote_update_first_party_submodules.bat` to update all first-party dependencies.
• You can also choose to update dependencies one at a time by executing `git submodule update --init --recursive vendor//`.

Remember not to use the `--remote` option unless you actually want to update to the latest commit.

• If you prefer to selec …