Skip to content

ubt.quick_build_unreal_project

Full path: schola.core.utils.ubt.quick_build_unreal_project

schola.core.utils.ubt.quick_build_unreal_project

quick_build_unreal_project

quick_build_unreal_project(project_folder, build_dir, ubt_path=None)

Build function with reasonable defaults to build an Unreal Engine project and return the path to the executable.

This function automates the process of building an Unreal project by:

  1. Finding the .uproject file
  2. Determining the UE version
  3. Locating the build tool
  4. Building the executable
  5. Returning the path to the built executable

Parameters

project_folder (str) : Path to the project folder containing the .uproject file.

build_dir (str) : Directory where the built executable will be staged.

ubt_path (Optional[str], optional) : Path to the Unreal Build Tool. If None, it will be auto-detected.

Returns

Path to the built executable file.

Return type: Path

Raises

  • FileNotFoundError - If the .uproject file is not found, or the UBT path cannot be determined from the project folder.
  • ValueError - If the UE version cannot be determined from the .uproject file.