This is the documentation for Enlighten.

Install Enlighten

Owned by Nathan Hunter (Unlicensed)
Oct 31, 2024
1 min read

Requirements

To run Enlighten's development tools, you need:

  • CPU: Intel Core (at least i3-2100), AMD FX/Ryzen (at least FX-4100).
  • System memory: 8GB
  • Windows 10 (64-bit) for the Enlighten precompute and visual tools
  • A graphics card with D3D11 support for tools and sample applications.
  • The Microsoft Visual Studio C++ 2015-2019 runtime components (found at Bin/VC_redist.x64.exe).

There are additional software requirements for Incredibuild support. See IncrediBuild for more information.

Download and install Enlighten

Enlighten is distributed as the following .zip archives:

  • A larger .zip archive containing the main SDK.
  • A series of smaller .zip archives specific to the various platforms that Enlighten supports.

To install Enlighten:

  1. Download EnlightenSDK-3.03.R.xxxxxx.zip plus the desired platform-specific and asset .zip archives.
  2. Unzip EnlightenSDK-3.03.R.xxxxxx.zip to a new directory, and unzip the platform-specific .zip archives into the same directory.
  3. Save your Enlighten license file to the root of your Enlighten SDK directory.
The path to the Enlighten SDK can't contain spaces.

The sample programs for all platforms are in the Bin/<platform> directories.

Use Enlighten with platform SDKs

The Enlighten SDK automatically detects installed platform SDKs, using the following environment variables:

  • PlayStation 4: SCE_ORBIS_SDK_DIR
  • PlayStation 5: SCE_PROSPERO_SDK_DIR
  • Xbox One: DurangoXDK
  • Xbox Series X: GameDK
  • Android: ANDROID_NDK_ROOT, ANDROID_SDK_ROOT, JAVA_HOME, ANT_HOME

Compile Enlighten

The Enlighten SDK ships with all libraries and sample applications prebuilt and ready to use. You don't need to compile anything to use the SDK. You should only consider this if you intend to make your own modifications to the sample framework or supporting libraries, or build the runtime libraries against a different platform SDK.

You can also build the Enlighten runtime libraries and sample applications from the provided source code. For details, see Code compilation.