This is the documentation for Enlighten.

Rebuild Enlighten from source

Owned by sskk-enlighten
Last updated: Apr 23, 2020 by sskk-enlighten-engr
1 min read

The Enlighten libraries and tools are provided in prebuilt form. You don't need to rebuild from source unless you modify the core Enlighten SDK code.

After you modify Engine source code you can build the editor or game using UnrealBuildTool as usual.
When upgrading to an unsupported platform SDK, you may also need to rebuild the Enlighten libraries against the new SDK. In rare cases you might need to make changes to the Enlighten libraries.
You can find the Enlighten library source code within the UE4 third party source folder:

Engine/Source/ThirdParty/Enlighten


Modify and rebuild Enlighten libraries

You can add or edit the SDK versions that will be built by editing EnlightenBuildConfig.xml. To build libraries compatible with UE4, make sure this matches the SDK versions that you build UE4 against.
To build and install the Enlighten libraries and tools required by UE4:

  1. In a command prompt window, execute:

    cd Engine\Source\ThirdParty\Enlighten
BuildAndInstallEnlighten.bat

    This scripts returns an exit code of zero if the build succeeded. Otherwise, an error is printed in the console output. 

    To build Enlighten, you must install the June 2010 DirectX SDK

  2. Build the UE4 editor or game using UnrealBuildTool.

By default, UnrealBuildTool doesn't detect changes to third party headers during an incremental build. To work around this, delete the Engine/Intermediate/Build folder to force a full UE4 build.

If you make regular changes to Enlighten headers, to enable incremental builds, enable bCheckExternalHeadersForModification in your BuildConfiguration.xml.