breathxhe / unrealgdk

SpatialOS GDK for Unreal Plugin

The SpatialOS GDK for Unreal Plugin

The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine fork and plugin with associated projects. It gives you the features of SpatialOS, within the familiar workflows and APIs of Unreal Engine. For more information, please see the GDK's documentation website.

This is the repository for the GDK plugin, which includes the Starter Template (a blank starter project).

In addition to the plugin, the GDK also includes:

• The SpatialOS Unreal Engine fork

  You must be a member of the Epic Games organization on GitHub to access this. If you aren't, the link returns a 404 error.

• The Example Project

If you’re an Unreal game developer and you’re ready to try out the GDK, follow the Get started guide.

SpatialOS Unreal Engine fork changes

In order to transform Unreal from a single-server engine to a distributed model, we made a number of small changes to Unreal Engine code. We are attempting to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in the SpatialOS Unreal Engine fork repository.

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.

Recommended use

To understand the feature-completeness, stability, performance, and support levels you can expect from the GDK, see the product maturity lifecycle page. For more information, visit the development roadmap and Unreal features support pages, and contact us via our forums, or on Discord.

Versioning and support

Please visit this page for a description of the GDK's versioning scheme, and which branches to use when developing.

Contributions

We welcome Github issues from all users, and accept public contributions subject to the signing of our Contributors License Agreement - please see our contributions policy for more details.

Run into problems?

• Troubleshooting
• Known issues

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.

---

• 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.

(c) 2020 Improbable