rm-NoobInCoding / UnrealReZen

UnrealReZen is a modding tool for packing utoc and ucas files (Unreal Engine Zen Loader archive files)
GNU General Public License v3.0
96 stars 9 forks source link
modding-games ucas unreal-engine unreal-engine-5 utoc

UnrealReZen

GitHub Stars GitHub Forks build and test [Github All Releases]()

A tool for creating and packing Unreal Engine .Utoc and .Ucas files.

How it works

First, it is better to know how ZenLoader files work ZenLoader consists of two parts

The important point of this structure is that you cannot add a new Asset to the game because each Asset contains a unique ID. And due to this unique ID, the tool must first read the game archives and then create the new archive.

The tool checks the game archives using the CUE4Parse library and after receiving the required information of the Assets, it creates a patch based on your edited files.

Usage

> UnrealReZen.exe --help
UnrealReZen 1.0.0
Copyright (C) 2024 UnrealReZen
USAGE:
Making a patch for a ue5 game:
  UnrealReZen.exe --content-path C:/Games/MyGame/ExportedFiles --compression-format Zlib --engine-version GAME_UE5_1
  --game-dir C:/Games/MyGame --output-path C:/Games/MyGame/TestPatch_P.utoc

  -g, --game-dir          Required. Path to the game directory (for loading UCAS and UTOC files).

  -c, --content-path      Required. Path of the content that the you want to pack.

  -e, --engine-version    Required. Unreal Engine version (e.g., GAME_UE4_0).

  -o, --output-path       Required. Path (including file name) for the packed utoc file.

  -a, --aes-key           AES key of the game (only if its encrypted)

  --compression-format    (Default: Zlib) Compression format (None, Zlib, Oodle, LZ4).

  --mount-point           (Default: ../../../) Mount point of packed archive

  --help                  Display this help screen.

  --version               Display version information.

Some important notes :

Examples

Lets mod a game. For example i wanna mod two assets in "The Casting of Frank Stone".

I will export the assets with FModel, edit them and put them in a folder that I named MyPatchedContent (with same path root for each asset).

Now Because the game is UE 5.1 and its not encrypted I run the tool with this args :

UnrealReZen.exe --content-path C:/TheCastingofFrankStone/MyPatchedContent --compression-format Zlib --engine-version GAME_UE5_1 --game-dir C:/TheCastingofFrankStone/SMG037UE5/Content/Paks  --output-path C:/TheCastingofFrankStone/SMG037UE5/Content/Paks/MyPatch_P.utoc

This will make three files (MyPatch_P.utoc / MyPatch_P.ucas / MyPatch_P.pak) in the "C:/TheCastingofFrankStone/SMG037UE5/Content/Paks/" folder. Now I can run the game!

*To find out the version of Unreal Engine used in a game, just check the version of the bootstap executable file of the game (executable file that is in the root of the game folder)

Contributing

We welcome contributions from the modding community to enhance UnealReZen's functionality and support for various Unreal Engine games. Feel free to fork the repository, make improvements, and submit pull requests.

License

GNU General Public License v3.0