UE4SS for Brickadia

This tool patches Brickadia to add support for UE4SS, allowing you to run lua/blueprint mods and custom scripts.

NOTICE

1. You will not make unsafe systems that can be used to distribute malware automatically.
2. You will not use this to compete with current or future Brickadia Business.
3. You will not create or help people make cheats, trolling tools, or nuisance mods.
4. You will not post content that do not work for the vanilla game to the gallery or host servers that do not work with vanilla clients to server list.
5. You will not complain if this tool stops working in a future game version.
6. You will not submit crash reports which are caused by this tool or mods.

Usage

1. Download the latest release
2. Re-read 👀 the NOTICE
3. Run br_patcher.exe
4. Enjoy!

Setup is manual at the moment...

Manual Setup

This project depends on compiling UE4SS from source for the dlls. The CI will automatically do this but due to licensing, the complete source cannot be provided here.

1. Setup Accounts

Create a Github and Epic account. Link them at epicgames.com.

This is required to access Re-UE4SS/UEPseudo, a fork of EpicGames/UnrealEngine, required to compile the UE4SS binaries.

After you've linked your account, generate an ssh-key (I recommend -t ed25519) and add it to your github account. This is required to git-clone-submodules from the private repositories.

2. Compile UE4SS

Skip this step by downloading the dwmapi.dll and UE4SS.dll from the latest release and copying them to the assets directory.

1. Download Visual Studio 2022 and install a version of MSVC that supports C++23 (Desktop C++)
2. Install Rust
3. Download xmake and add to a folder in the a directory in your PATH environment variable
4. Download git
5. git clone git@github.com:UE4SS-RE/RE-UE4SS.git (and cd to this dir)
6. git submodule update --init --recursive

8. (Optional?) Copy raw_pbd_xmake.lua to RE-UE4SS/deps/third-repo/packages/r/raw_pdb/xmake.lua
9. xmake project -k vsxmake2022 -m "Game__Shipping__Win64
10. Open vsxmake2022/RE-UE4SS.sln in Visual Studio
11. In the "Build" menu, select "Build UE4SS" to compile the UE4SS binaries (This may take a while)
12. Copy RE-UE4SS/Binaries/Game__Shipping__Win64/proxy/dwmapi.dll to assets/dwmapi.dll
13. Copy RE-UE4SS/Binaries/Game__Shipping__Win64/UE4SS/UE4SS.dll to assets/UE4SS.dll

3. Compile and Run

1. cargo run (You should already have Rust installed from step 2)
2. Re-read 👀 the NOTICE
3. select Y to patch Brickadia and copy the files