Manual-install: UE fork and plugin

When you follow the Get started guide’s steps on 2 - Set up the fork and plugin, we recommend you auto-install the fork and plugin.

If you prefer to manually install the the UE fork and plugin, follow these instructions to:

  • set up and build the SpatialOS Unreal Engine fork after cloning the Unreal Engine fork repository.
  • clone and install the SpatialOS GDK for Unreal plugin.

Tip: We recommend you use the auto-install option as this makes setting up the Example Project and following tutorials based on the Example Project quicker. If you manually install, you will need to take extra steps to follow tutorials.

Before starting

You must have followed the Get started guide:

Step 1: Build Unreal Engine

  1. In File Explorer navigate to the directory you cloned the Unreal Engine fork into.

  2. Double-click Setup.bat. This installs prerequisites for building Unreal Engine 4.
    This process can take a long time to complete.

    While running the Setup file, you should see Checking dependencies (excluding Mac, Android).... If it also says excluding Linux, make sure that you set the environment variable LINUX_MULTIARCH_ROOT correctly, and run the Setup file again.

  3. In the same directory, double-click GenerateProjectFiles.bat. This file automatically sets up the project files you require to build Unreal Engine 4.

    If you encounter the message, error MSB4036: The "GetReferenceNearestTargetFrameworkTask" task was not found when building with Visual Studio 2017, check that you have the NuGet Package Manager installed via the Visual Studio installer.

  4. In the same directory, open UE4.sln in Visual Studio.

  5. In Visual Studio, on the toolbar, navigate to Build > Configuration Manager; set your active solution configuration to Development Editor and your active solution platform to Win64.

  6. In the Solution Explorer window, right-click on the UE4 project and select Build (you may be prompted to install some dependencies first).

Visual Studio then builds Unreal Engine, which can take up to a couple of hours.

You have now built Unreal Engine 4 with cross-compilation for Linux.

> Next: 3 - Set up project

Choose either:

  • Set up the Example Project
    The Example Project is a session-based FPS game. It gives an overview of the GDK and using SpatialOS, including deploying your game to SpatialOS locally and in the cloud.
  • Set up the Starter Template
    Use as a base for creating your own project running on SpatialOS.

2019-09-27 Page updated without editorial reivew: remove duplicate clone GDK instructions, link to correct project setup guides.
2019-08-12 Page updated with editorial review: added to page orientation.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums