Unreal Module

The Unreal module handles all communication with Unreal Engine executables.

Usage

Registering Unreal Build

To use an Unreal Engine build within the Unreal Module, you must first register it.

Registering an Epic Games Store build is simple:

unreal = ci.Unreal.egs_build(5, 3)

EGS builds will first look for the UE_Major.Minor_DIR environment variable, and if that cannot be found, it will look within C:?Program Files/Epic Games/UE_Major.Minor/. If no build was found, the script will give an error.

To register a source or installed build:

unreal = ci.Unreal.custom_build(build_guid)

Custom builds will first look for the UE_build_guid_DIR environment variable, and if that cannot be found, it will look within HKCU:/SOFTWARE/Epic Games/Unreal Engine/Builds for the GUID. If no build was found, the script will give an error.

Editor

You can access the editor object via unreal.editor(). This object contains various utility functions for running editor operations.

UAT

You can access the editor object via unreal.uat(). This object contains various utility functions for running automation operations.