The SpatialOS GDK for Unreal consists of:
- The SpatialOS Unreal Engine fork
- The GDK plugin (includes the Starter Template, a blank starter project)
- The Example Project
These repositories all follow the same versioning scheme, as described below:
MAJOR: indicates the major version, currently 0 as the GDK is in Alpha. We do not provide any long term support and stability guarantees on any versions, and do not backport fixes. The major version will turn to 1 when we enter Beta.
MINOR: indicates the minor version. Released about once a month and containing significant features. Not backward compatible while the GDK is in Alpha.
PATCH: indicates updates containing significant patch releases. Not backwards compatible while the GDK is in Alpha.
When setting up the GDK for your project, you need to decide which branch of each of the repositories (listed above) to clone.
The most stable version is always the
release branch, which is set as the default branch for each repository.
The Unreal Engine fork follows the versioning and branches pattern described above, but the branch names have
X.XX-SpatialOSUnrealGDK following prepended to them (where
X.XX is the Unreal Engine version of the fork).
Each GDK version has two associated Unreal Engine versions: the "supported version" and the "legacy version".
Supported version: The Unreal Engine fork repository’s default branch, and the version included in the Get started documentation. The Example Project and Test Gyms are supported on this version. We recommend that you always use the supported version if possible.
Legacy version: When we introduce support for a new Unreal Engine version, we also support the previous engine version in parallel, for one or more GDK releases. This is to facilitate a smooth upgrade for your project. The Example Project and Test Gyms are not supported on this version.
To update your Unreal Engine fork and GDK plugin, see Update your GDK.
We endeavour to support the latest stable and recommended version of Unreal Engine less than 3 months after it's released. To see when a new version will be supported, check out the Development Roadmap.
2020-09-07 Page updated with limited editorial review: added link to Update your GDK.
2020-07-16 Page updated with limited editorial review: added GDK version 0.11.x to Unreal Engine version support table.
2020-06-25 Page updated: simplified structure, removed mentions of the preview branch.
2020-02-05 Page updated: added Unreal Engine versions table.
2019-08-07 Page updated: clarified what the GDK consists of.
2019-07-21 Page added with limited editorial review.
Updated about a year ago