Get started

1 - Get the dependencies

To start using the GDK for Unreal, you need to ensure you have the correct software installed and that your machine is capable of running Unreal Engine.

Step 1: Login

Before you start, make sure you are logged in to your SpatialOS account.

  • If you have already signed up to SpatialOS, make sure you are logged into If you are logged in, you should see your picture in the top right of this page. If you are not logged in, select Sign in at the top of this page and follow the instructions.

  • If you have not signed up before, you can sign up here.

Step 2: Hardware

  • Ensure your machine meets the minimum hardware requirements for Unreal Engine.
    See the Unreal Engine hardware recommendations for further information about the minimum hardware requirements.

  • Recommended storage: 60GB+ available space

Step 3: Software

To build the GDK for Unreal you need the following software installed on your machine:

  • Windows 10 with Command Prompt or PowerShell.
    • Note: The GDK for Unreal is currently only supported on Windows 10.
  • A Git client
    • In order to clone the GDK and Unreal Engine repos, we recommend using a Git client such as Git for Windows
  • SpatialOS
  • The DirectX End-User Runtimes (June 2010)

    • You need the DirectX End-User Runtime to run Unreal Engine 4 clients.
  • Visual Studio 2017.
    To access and download the Visual Studio 2017 installer you must sign up for a Microsoft account and sign up to the free Visual Studio Dev Essentials.

  • During the installation of Visual Studio, select the following items in the Workloads tab:

    • Universal Windows Platform development
    • .NET desktop development
      • You must also select the .NET Framework 4.6.2 development tools
    • Desktop development with C++
    • Game development with C++, including the optional Unreal Engine installer component.

Make sure you install Visual Studio 2017. The GDK does not currently support any other version.

  • Linux Cross-Compilation toolchain
    • You need to download and install Unreal’s Linux Cross-Compilation toolchain in order to build Linux server-workers using your Windows machine. Use the Unreal documentation link above to install -v13 clang-7.0.1-based, the appropriate toolchain for Unreal Engine 4.22.

> Next: 2 - Set up the fork and plugin

2019-08-08 Page updated with editorial review: text clarification only. 2019-07-22 Page updated with limited editorial review

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums