UE-ModDeployer

A lightweight Python utility script for UE4/5 automated post-build deployment of chunk assigned mods.
The script waits for a successful build then moves the mod files and launches the game for rapid mod deployment and testing.

Click here to download the latest script version.

Features

• Monitors the packaging log for successful builds.
• Moves and renames the generated mod files (.pak, .ucas, and .utoc) to the game's Paks folder.
• Launches the game automatically after files are in place.
• Continuous monitoring allows the tool to handle future builds.

Note

The script only moves the packaged files and doesn't support UnrealPak.

Installation:

1. Download the script (link above).
2. Configure the script with the correct folders (see below for more info).
3. Create a JSON file named mods.json in the same folder as the script, and add the JSON structure as shown below.
4. Execute the script by running python UE-ModDeployer.py

All configuration is done directly in the script via a few key constants.

Configuration

Required:

• PROJECT_DIR: Path to project root folder.
• PROJECT_NAME: The project's name (used for locating the log and build output).
• PAK_SOURCE_DIR: The project build path (typically inside a Build folder within the project directory)
• PAK_TARGET_ROOT: The game's Paks folder.
• GAME_EXE_PATH: Path to the game's executable.

Optional:

• WAIT_FOR_NEW_BUILD = True: Trigger only on the next detected successful build.
• CONTINUOUS_MODE = True: Continue waiting for future builds.
• LAUNCH_GAME_AFTER = True: Launch the game after all files are moved and renamed.

Tip

Having trouble? Check out the example script used for a game called RooftopsAndAlleys.

JSON File

All mod mappings are defined in a simple JSON file, as shown below:

[
  {
    "chunk_id": 1206,
    "mod_name": "jetpack_p",
    "relative_path": "outfits"
  },
  {
    "chunk_id": 1207,
    "mod_name": "mymod_P",
    "relative_path": ""
  }
]

Tip

Empty relative_path will place the mod inside the game's Paks folder.
Relative paths are appended to the game's Paks folder -> .../Paks/outfits/ (example 1)

---

Note

This is a private-use script for automating the most common procedure of modding.