Unreal Engine 5 Documentation has been moved to the Epic Developer Community

UnrealBuildTool

UnrealBuildTool (UBT) manages the process of building UE4 source code across a variety of build configurations.

Choose your operating system:

Windows

macOS

Linux

UnrealBuildTool (UBT) is a custom tool that manages the process of building Unreal Engine 4 (UE4) source code across a variety of build configurations. Read BuildConfiguration.cs to explore various user-configurable build options.

Modular Architecture

UE4 is split into many modules. Each module has a .build.cs file that controls how it is built, including options for defining module dependencies, additional libraries, include paths, etc. By default, these modules are compiled into DLLs and loaded by a single executable. You can choose to build a monolithic executable in the BuildConfiguration.cs file.

It is important to understand that the build process executes independently of any project files for the development environment, such as .sln or .vcproj files (for Visual Studio). These files are useful to have for editing purposes though, so there is a tool being provided to generate them dynamically (based on the contents of your project directory tree). You can run this tool with the GenerateProject.bat file located in your [Root UE4] directory.

Note: Running GenerateProject.bat from time-to-time will keep your code editor up-to-date with files that are being added to (or being removed) from disk.

Topics

placeholder_topic.png

Targets

An overview of UBT Targets, including property descriptions.

placeholder_topic.png

Modules

An overview of UBT Modules, including property descriptions.

topic_buildConfigProps.png

Build Configuration

Configure how the engine is built.

topic_IWYU.png

IWYU

A brief overview of the updated code base for UE4, now using an Include-What-You-Use (IWYU) dependency model.

topic_prjFileGen.png

Project Files for IDEs

Process for automatically generating project files for games and modules in the current workspace.

placeholder_topic.png

Versioning of Binaries

Reference for Unreal Engine's BuildID system, which mitigates potential errors that may result from outdated DLL files.

placeholder_topic.png

Third-Party Libraries

Integrating third-party libraries into Unreal Engine

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss