Skip to content
SpatialOS GDK for Unreal
Branch: release
Clone or download
petemounce Scope to Windows (#749)
... since this makes it easier to eyeball what it needs, as well as lock that down for the future where we multiply the steps via a test-matrix.

**Contributions**: We are not currently taking public contributions - see our [contributions](CONTRIBUTING.md) policy. However, we are accepting issues and we do want your [feedback](../README.md#give-us-feedback).

-------

#### Description
Describe your changes here.

#### Release note
REQUIRED: Enter a simple message for this commit which will go in the release notes. Prefix with "Bugfix:" or "Feature:".
(Documentation changes are exempt)

#### Tests
How did you test these changes prior to submitting this pull request?
What automated tests are included in this PR?

STRONGLY SUGGESTED: How can this be verified by QA?

#### Documentation
How is this documented (for example: release note, upgrade guide, feature page, in-code documentation)?

#### Primary reviewers
If your change will take a long time to review, you can name at most two primary reviewers who are ultimately responsible for reviewing this request. @ mention them.
Latest commit e2c82df Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.buildkite Scope to Windows (#749) Mar 13, 2019
.github Updated template for release notes (#643) Feb 6, 2019
SpatialGDK
ci Added support for autogenerated launch configs (UNR-700) (#672) Feb 26, 2019
.editorconfig
.gitattributes
.gitignore
CONTRIBUTING.md Contribution Policy (#690) Feb 26, 2019
LICENSE.md
README.md Adjusted fork path (#674) Feb 26, 2019
RequireSetup UNR-996 Handcrafted Component ids start at 9999 and decrease. dynamic… Feb 26, 2019
Setup.bat
Setup.sh Added the scripts for iOS client build (#590) Jan 11, 2019

README.md

The SpatialOS Game Development Kit for Unreal (alpha)

The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine 4 (UE4) plugin (Unreal documentation) which allows you to host your game and combine multiple dedicated server instances across one seamless game world, whilst using the Unreal Engine networking API.

The GDK offers:

  • Multiserver support: leveraging our cloud platform SpatialOS (SpatialOS documentation), the GDK allows you to run multiple game servers in a single game instance so your Unreal-developed games can have more players, more Actors, and better gameplay systems than previously possible.

  • An Unreal-native experience: keeping traditional workflows and networking APIs that Unreal Engine developers are familiar with, the GDK introduces new native-feeling concepts that turn a single-server engine into a distributed one. This enables the GDK to retain the functionality of the networking features which Unreal offers out of the box, including transform synchronization, character movement, and map travel.

  • An easy onboarding experience: we have made sure it’s easy to get started with the GDK by including a Starter Project which you can use as a tour of SpatialOS and a base for your own game, as well as a guide to porting your current multiplayer Unreal game to run on SpatialOS.

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



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, stability and documentation 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.

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 related projects

The GDK and its related projects are available on GitHub.

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.


(c) 2018 Improbable

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.