UEQuickStart User Guide

UEBuildToGO Tutorial

The project must have run successfully at least once on this machine, ensuring the build environment is configured.

1. Place UEBuildTool.exe in the project root, alongside .uproject
2. Double-click to run it
3. Wait for compilation to finish; the project opens automatically

Create UEBuildConfig.json in the project root to customize build behavior:

{
  "Build": {
    "Platform": "Win64",
    "Configuration": "Development",
    "AdditionalArgs": []
  },
  "AutoOpenProject": true,
  "AutoCloseOnSuccess": true,
  "CloseDelayMs": 1500
}

Cause: The tool is not in the UE project root.

Solution: Copy UEBuildTool.exe or Main.py + Source/ to the directory containing .uproject.

Cause: The engine was not installed through Epic Games Launcher, or its registry information is missing.

Solution:

1. Confirm the engine was installed through Launcher
2. Try verifying the engine files in Launcher
3. Reinstall the engine

Solution: Check the specific error messages in the log window and ask a programmer to help diagnose the issue.

Cause: Mac/Linux use LF (\n) or CR (\r) line endings, which MSVC on Windows may not process correctly.

Solution: Before building, the tool automatically scans source files and converts line endings to CRLF (\r\n). No manual action is required.

Scan scope:

• Source/ and ThirdParty/ directories
• All Source/ and ThirdParty/ directories found recursively under Plugins/

Supported file types: .h, .c, .cpp, .cs, .inl

Yes. The tool automatically detects the editor:

• UE5: UnrealEditor.exe
• UE4: UE4Editor.exe

Yes. The tool automatically recognizes GUID-format engine versions in .uproject and retrieves the corresponding engine path from the registry.

Not yet. Currently only Windows is supported; cross-platform functionality remains to be developed.