How to upgrade to SpatialOS 13.0
This page explains how to upgrade a project from SpatialOS 12 to 13.0. If you are new to SpatialOS and plan to develop on Unity or Unreal, we recommend you use the GDK for Unity or the GDK for Unreal.
If you’re already using the SDK for Unity or Unreal
As of SpatialOS 13.0, SpatialOS no longer includes the Unity and Unreal SDKs. The Unity and Unreal SDKs are now released separately and hosted on GitHub.
If you upgrade to 13.0, you’ll need to migrate to the GitHub-hosted SDKs.
For instructions, see:
- Guide to migrating your project to the GitHub-hosted Unity SDK 1.0.0
- Guide to migrating your project to the GitHub-hosted Unreal SDK 1.0.0
If you’re not already using the SDK for Unity or Unreal
SpatialOS projects are developed against a specific version of the SpatialOS SDK.
The SDK version your project builds against is defined in the
file at the root of the project, in the
You must upgrade through major SDK versions in order. For example, to
13.0.0, you must upgrade to
12, then to
To find upgrade guides for older versions, look at the documentation for that version of
Note: It’s very important you start by running
spatial clean. Otherwise, intermediate files won’t be cleaned up properly and may cause issues with the new version.
- Open a terminal in the root directory of your project.
- Open the
spatialos.jsonfile at the root of your project.
- Replace the
sdk_versionvalue and the
versionvalue of all dependencies with
- Replace all other instances of the version number in the file.
spatial worker build.
Apart from the SDK split, there aren’t any changes in SpatialOS 13.0, so this command should succeed as usual.
You’ve now upgraded to SpatialOS 13.0.