1. Get the dependencies

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. The three steps below guide you through this.

Step 1: Login

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

Your location
The process you follow depends on where you are located: outside China or in China.

  • If you are located in China, use the in-China instructions.
  • Only use the in-China instructions if you are located in China, using hosting in China.
  • Note that in the documentation, "China" refers to mainland China only.

Outside China

  • If you have already signed up to SpatialOS, make sure you are logged in to Improbable.io. If you are logged in, you should see your picture in the top right of the home page at Improbable.io. If you are not logged in, select Login at the top of the home page and follow the instructions.
  • If you have not signed up before, you can sign up here.

In China

  • If you have already signed up to SpatialOS China, make sure you are logged in to spatialoschina.com. If you are logged in, you should see your picture in the top right of this page.
  • If you have not signed up to SpatialOS China, contact your account manager or get in touch.

Step 2: Hardware

  • Ensure your machine meets the minimum hardware requirements for Unreal Engine.
    See the Unreal Engine hardware recommendations for further information.
  • Recommended storage: 145GB+ available space

Step 3: Software

We support development using the GDK for Unreal on both Windows and macOS. You need to follow different instructions for each platform and install a different set of required software.

Note:

  • If you are using macOS, you can only set up and run SpatialOS on your development machine, not in the cloud.
  • To set up and run SpatialOS games in the cloud, you need to use a Windows machine for development. We recommend using a Windows machine as your main development environment and macOS for developing and testing game clients on iOS.

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

  • Windows 10 with Command Prompt or PowerShell.
    Note: The GDK for Unreal is only supported on Windows 10.
  • Ports to keep free
    You must keep the following ports free:
  • Git version control system
    In order to clone the GDK and Unreal Engine repository from GitHub, you need to have Git installed. We recommend using a Git client such as GitHub Desktop. If you are not familiar with Git, take a look at GitHub’s guides.
  • SpatialOS
  • Linux Cross-Compilation toolchain
    You must download and install Unreal's Linux Cross-Compilation toolchain. The Worker SDK needs it to build Linux server-workers using your Windows machine. Use the Unreal documentation link above to install -v16 clang-9.0.1-based, the appropriate toolchain for Unreal Engine 4.25.
  • Visual Studio 2019 v16.7.
    Note: There is a known issue using Unreal Engine with Visual Studio 2019 v16.8 and above. This means you need to download and install Visual Studio 2019 v16.7.
    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++

Upgrading from Visual Studio 2017

If you want to upgrade an existing project from Visual Studio 2017, you must follow these steps before you open your Unreal Engine 4 project in Visual Studio 2019:

  1. In Unreal Editor, select Edit > Editor Preferences > General > Source Code > Source Code Editor > Visual Studio 2019.
  2. In File Explorer, right-click your .uproject file and select Generate Visual Studio project files.

Note: Because the GDK for Unreal only supports macOS for the development and testing of game clients on iOS, there are limited GDK features available on macOS. This Get Started guide and the Sample Project tutorials note where features are not available on macOS development machines.

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

  • XCode
    • UE 4.25 or 4.24: XCode 11 and macOS Catalina
  • Ports to keep free
    You must keep the following ports free:
    • 31000 and 9876 for the local API service.
    • 7777 for the Receptionist (which is one way of connecting to a SpatialOS deployment).
    • 12000 for authenticating using spatial auth login.
  • Git version control system
    In order to clone the GDK and Unreal Engine repository from GitHub, you need to have Git installed. We recommend using a Git client such as GitHub Desktop. If you are not familiar with Git, take a look at GitHub’s guides.

  • SpatialOS

macOS Catalina

We’re in the process of notarizing all SpatialOS tools for use on Catalina. Until this is complete, if you're using Catalina, you can't open the SpatialOS installer package directly from your browser. Instead, you need to open it from Finder. To do this:

  1. Select the arrow next to the package name and then select Show in Finder.
  2. In Finder, right-click the package and select Open.
  3. In the next dialog box, select Open again.

2021-02-16 Page updated with editorial review by removing dependency on DirectX
2020-11-23 Page updated with note that PC developers need to download Visual Studio 2019 v16.7
2020-09-23 Page updated with editorial review: changed wording for downloading and installing Unreal's Linux Cross-Compilation toolchain
2020-08-10 Page updated with editorial review: added guidance for VS2017 upgrade and Catalina information
2020-08-03 Page updated with editorial review: added reference to clang-9.0.1.

Updated 7 months ago


1. Get the dependencies


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.