Forking and Cloning Unreal from GitHub

Prerequisite Topics

This page assumes you have prior knowledge of the following topics. Please read them before proceeding.

Forking and cloning our source code from GitHub is a great way to get started with Unreal.

Choose Your Operating System

Windows

Mac OS

Linux

  1. Install GitHub for Windows .

  2. Fork and Clone our repository .

    UnrealRepo.png

  3. If you already haven't done so, install Visual Studio 2013. Although MFC libraries are included in Visual Studio's default installation settings, make sure that MFC libraries are included for ATL support.

    Developers build UE4 with all desktop editions of Visual Studio, including Microsoft's free version (Visual Studio Community 2013 ).

  4. Open your source folder in Explorer and run Setup.bat.

    Our Setup batch file downloads binary content for the engine, installs prerequesites, and sets up Unreal file associations. Downloading engine binaries may take some time because they currently take up three to four gigabytes of disk space. Subsequent checkouts generally take less time to download.

    A warning from SmartScreen may appear in Windows 8. Click 'More Info', then click 'Run Anyway' to continue running our Setup batch file.

  1. Install GitHub for Mac .

  2. Fork and Clone our repository .

    UnrealRepo.png

  3. If you haven't already done so, install the latest version of Xcode .

  4. Open your source folder in Finder and run Setup.command.

    • Our Setup command file downloads binary content for the engine, installs prerequesites, and sets up Unreal file associations. Downloading engine binaries may take some time because they currently take up three to four gigabytes of disk space. Subsequent checkouts generally take less time to download.

    • Close the Terminal window after Setup.command downloads binary content for the engine, installs prequisites, and sets up Unreal file associations.

Our developers and support teams currently use the latest version of Ubuntu; as a result, we may not be able to provide support for other Linux distributions (including other versions of Ubuntu).

  1. Set up Git .

  2. Fork and Clone our repository .

    UnrealRepo.png

  3. Inside the root folder, run Setup.sh from the terminal to download the engine's binary content. RunSetupShellScript_Linux.png

    • Our Setup shell script downloads binary content for the engine and installs prerequesites. Downloading engine binaries may take some time because they currently take up three to four gigabytes of disk space. Subsequent checkouts generally take less time to download.

    • If you don't see a **SUCCESS** message after running this step, refer to the 'BuildThirdParty.log' file for more information. 'BuildThirdParty.log' is located in the [UE4Root]/Engine/Build/BatchFiles/Linux directory.

Next Steps

Now that you've downloaded and set-up Unreal Engine, you're ready to build the engine from source .