Lua scripting system platform, C++ Modding API, SDK generator, blueprint mod loader, live property editor and other dumping utilities for UE4/5 games.
.usmap mapping files for unversioned properties.umaps in-editorThe goal of UE4SS is not to be a plug-n-play solution that always works with every game. The goal is to have an underlying system that works for most games. You may need to update AOBs on your own, and there's a guide for that below.
The easiest installation is via downloading the non-dev version of the latest non-experimental build from Releases and extracting the zip content to /{Gameroot}/GameName/Binaries/Win64/.
If your game is in the custom config list, extract the contents from the relevant folder to Win64 as well.
If you are planning on doing mod development using UE4SS, you can do the same as above but download the zDEV version instead.
Generating UHT compatible headers
Creating Compatible Blueprint Mods
Unreal Engine Modding Discord Server Invite
git submodule update --init --recursive
Make sure your Github account is linked to your Epic Games account for UE source access.
Do not use the --remote option because that will force third-party dependencies to update to the latest commit, and that can break things.
You will need your github account to be linked to an Epic games account to pull the Unreal pseudo code submodule.There are several different ways you can build UE4SS.
xmake allows you to flexibly configure some build options to suit your specific needs. The following is a non-comprehensive list of configuration settings you might find useful.
[!IMPORTANT] All configuration changes are made by using the
xmake configcommand. You can also usexmake fas an alias for config.
After configuring xmake with any of the following options, you can build the project with xmake or xmake build.
The build modes are structured as follows: <Target>__<Config>__<Platform>
Currently supported options for these are:
Target
Game - for regular games on UE versions greater than UE 4.21LessEqual421 - for regular games on UE versions less than or equal to UE 4.21CasePreserving - for games built with case preserving enabledConfig
Dev - development buildDebug - debug buildShipping - shipping(release) buildTest - build for testsPlatform
Win64 - 64-bit windows[!TIP] Configure the project using this command:
xmake f -m "<BuildMode>".-mis an alias for --mode=\.
By default, the patternsleuth tool installs itself as an xmake package. If you do not intend on modifying the patternsleuth source code, then you don't have to configure anything special. If you want to be able to modify the patternsleuth source code, you have to supply the --patternsleuth=local option to xmake config in order to recompile patternsleuth as part of the UE4SS build.
By default, UE4SS generates a proxy based on C:\Windows\System32\dwmapi.dll. If you want to change this for any reason, you can supply the --ue4ssProxyPath=<path proxy dll> to the xmake config command..
By default, UE4SS uses Tracy for profiling. You can pass --profilerFlavor=<profiler> to the xmake config command to set the profiler flavor. The currently supported flavors are Tracy, Superluminal, and None.
By default, xmake will check if you have the minimum required version of Rust or MSVC installed (if you are using the MSVC toolchain). If you do not, it will throw an error on the configure step. If you want to ignore this check, you can pass --versionCheck=n to the xmake config command.
Once you set the flag, the option value be set until you specify otherwise.
Therefore, to not check versions when running xmake project -k vsxmake2022, you must first run the xmake config --versionCheck=n command, then run the xmake project -k vsxmake2022 command.
xmake commandsYou may encounter use for the some of the more advanced xmake commands. A non-comprehensive list of some useful commands is included below.
| Syntax | Aliases | Uses |
|---|---|---|
xmake <command> --yes |
xmake <command> -y |
Automatically confirm any user prompts. |
xmake --verbose <command> |
xmake -v <command> |
Enable verbose level logging. |
xmake --Diagnostic <command> |
xmake -D <command> |
Enable diagnostic level logging. |
xmake --verbose --Diagnostic --yes <command> |
xmake -vDy <command> |
You can combine most flags into a single -flagCombo. |
xmake config |
xmake f |
Configure xmake with any of these options. |
xmake clean --all |
xmake c --all |
Cleans binaries and intermediate output of all targets. |
xmake clean <target> |
xmake c <target> |
Cleans binaries and intermediates of a specific target. |
xmake build |
xmake b |
Incrementally builds UE4SS using input file detection. |
xmake build --rebuild |
xmake b -r |
Forces a full rebuild of UE4SS. |
xmake build <target> |
xmake b <target> |
Incrementally builds a specific target. |
xmake show |
Shows xmake info and current project info. | |
xmake show --target=<target> |
xmake show -t <target> |
Prints lots of information about a target. Useful for debugging scripts, compiler flags, dependency tree, etc. |
xmake require --clean |
xmake q -c |
Clears all package caches and uninstalls all not-referenced packages. |
xmake require --force |
xmake q -f |
Force re-installs all dependency packages. |
xmake require --list |
xmake q -l |
Lists all packages that are needed for the project. |
xmake project --kind=vsxmake2022 --modes="Game__Shipping__Win64" |
xmake project -k vsxmake2022 -m "Game__Shipping__Win64" |
Generates a Visual Studio project based on your current xmake configuration. You can specify multiple modes to generate by supplying -m "Comma,Separated,Modes". If you do not supply any modes, the VS project will generate all permutations of modes. |
To generate Visual Studio project files, run the xmake project -k vsxmake2022 -m "Game__Shipping__Win64" command.
Afterwards open the generated .sln file inside of the vsxmake2022 directory
Note that you should also commit & push the submodules that you've updated if the reason why you updated was not because someone else pushed an update, and you're just catching up to it.
[!WARNING] The vs. build plugin performs the compile operation by directly calling the xmake command under vs, and also supports intellisense and definition jumps, as well as breakpoint debugging. This means that modifying the project properties within Visual Studio will not affect which flags are passed to the build when VS executes
xmake. XMake provides some configurable project settings which can be found in VS under theProject Properties -> Configuration Properties -> Xmakemenu.[!CAUTION] If you have multiple Visual Studio versions installed, run
xmake f --vs=2022, otherwise you may encounter issues with the project generation.
[!TIP] Additional modes can be generated by running
xmake project -k vsxmake2022 -m "Game__Shipping__Win64,Game__Debug__Win64". Further explanation can be found in thexmakecommand table.
[!CAUTION] If you change your configuration with
xmake config, you may need to regenerate your Visual Studio solution to pick up on changes to your configuration. You can simply re-run thexmake project -k vsxmake2022 -m "<modes>"command to regenerate the solution.
If you want to update git submodules, you do so one of three ways:
git submodule update --init --recursive to update all submodules.git submodule update --init --recursive deps/<first-or-third>/<Repo>.
Do not use the --remote option unless you actually want to update to the latest commit.cd into the submodule directory for that dependency and execute git checkout <branch name or commit>.
The main dependency you might want to update from time to time is deps/first/Unreal.
All contributors since the project became open source: https://github.com/UE4SS-RE/RE-UE4SS/graphs/contributors