Introduction

Get started: Introduction

To get started with the SpatialOS GDK for Unreal, follow the instructions in this Get Started guide. It outlines how to:

  1. Get the dependencies: Install the required software and ensure that your hardware and platform meet the requirements for GDK for Unreal.

  2. Set up the fork and plugin: Download and build the SpatialOS Unreal Engine (UE) fork and the GDK plugin.

  3. Set up a project: Follow a quick-start tutorial to set up a sample project; the Example Project or the Starter Template project.

The steps take a couple of hours to complete. At the end of the process you will have:

  • A GitHub account connected to an Epic Games account.

  • A clone of the UE fork’s Git repository.

  • A cloned and installed SpatialOS GDK plugin.

  • A working example project or a blank template project. You can use either project as a base for your own projects.

Development platforms: Windows or macOS

The GDK for Unreal only supports macOS for the development and testing of game clients on iOS. If you are using macOS, you can only set up and run SpatialOS on your development machine, not in the cloud, which you need to do to fully test a game and run it in production.

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.

Sample Projects

You can set up either or both of the following sample projects:

  • The Example Project is a session-based FPS game for multiple players. The Example Project is the basis for most GDK tutorials which give you an overview of the GDK. The Example Project quick-start tutorial explains how to use SpatialOS to deploy the game locally on your development machine and in the cloud.
    You get this project from its own Example Project repository when you run the install script for the GDK’s Unreal Engine fork, which is part of the Get Started guide.

  • The Starter Template is a template project you can use as a base to create your own new project running on SpatialOS. The Starter Template quick-start tutorial also explains how to use SpatialOS to deploy the game locally on your development machine and in the cloud.
    You get this project as part of the GDK’s Unreal Engine fork download, as part of the Get Started guide.

Start with: Get started: 1. Get the dependencies.


2020-10-23 Page updated with editorial review: restructured page, removed Tutorials and guides and Feedback and ideas
2020-08-10 Page updated with editorial review: updated tutorial names
2020-06-23 Page updated with editorial review: added MacOS, mobile, UI and deployment workflow changes

Updated about a month ago


Introduction


Suggested Edits are limited on API Reference Pages

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