The SpatialOS Games Development Kit for Unreal (alpha)

This is an alpha (SpatialOS website) release of the SpatialOS Unreal GDK, pending stability and performance improvements. The API may change as we learn from feedback - see the guidance on Recommended use, below.

The SpatialOS Games Development Kit (GDK) for Unreal is an Unreal Engine 4 (UE4) plugin made by [Improbable](. You can use the GDK to make use of multiple Unreal servers in a single game instance using the SpatialOS platform, unlocking the ability to implement large-scale, complex and persistent worlds. Find out more about the GDK in our blogpost.

Installation and setup (on the documentation website)
Documentation (on the documentation website)
Development roadmap (Trello board)
Community: Discord - Forums - Mailing list

Recommended use

We are releasing the GDK in alpha so we can react to feedback and iterate on development quickly. To facilitate this, during our alpha stage we don't have a formal deprecation cycle for APIs and workflows. This means that everything and anything can change. In addition, documentation is limited and some aspects of the GDK are not optimized.

Given this, for now we recommend using the GDK in projects in the early production or prototype stage. This ensures that your project's requirements are in line with the GDK's timeline.

Although the GDK is not fully ready in terms of performance and stability yet, this is a great time to get involved and shape it with us. We are committed to improving the GDK rapidly, aiming for a beta release in Q1 2019.

See the full feature list on the documentation website.

Contributions

We are not currently accepting public contributions - see our contributions policy. However, we are accepting issues and we do want your feedback.

Run into problems?

Unreal Engine changes

In order to transform Unreal from a single server engine to a distributed model, we had to make a small number of changes to UE4 code. We will attempt to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in our forked Unreal Engine repo, 4.20-SpatialOSUnrealGDK branch.

You may get a 404 error from this link. To get access, see these instructions

Give us feedback

We have released the GDK for Unreal this early in development because we want your feedback. Please come and talk to us about the software and the documentation via: Discord - Forums - GitHub issues in this repository.

Where to get the GDK and starter projects

The GDK and its starter projects are available on GitHub.

GDK: github.com/spatialos/UnrealGDK
Starter Project
Third Person Shooter Game (Not actively developed)
The Test Suite
The SpatialOS Unreal Engine fork
NOTE: This link may give you a 404. In order to get access to this fork, you need to link your GitHub account to a verified Epic Games account, and to have agreed to Epic's license. You will not be able to use the GDK for Unreal without doing this first. To do this, see the Unreal documentation.

License: use of the contents of this repository is subject to the Improbable license
(Your access to and use of the Unreal Engine is governed by the Unreal Engine End User License Agreement. Please ensure that you have agreed to those terms before you access or use the Unreal Engine.)
Version: alpha (stability and performance improvements pending)
GDK repository: github.com/spatialos/UnrealGDK