What's new

+ Upgrading

These are the docs for 13.2, an old version of SpatialOS.The docs for this version are frozen: we do not correct, update or republish them.14.0 is the newest →

Upgrading to a new patch or minor version

SpatialOS only introduces breaking changes between major versions (for example, 11 to 12). There should
be no breaking changes between patch versions (for example, 11.0.0 to 11.0.3) or minor versions (for example,
11.0 to 11.2).

The exception is experimental features and SDKs, which can have breaking changes more often.

How to upgrade

To upgrade your project to a new patch version:

Open a terminal in the root directory of your project.

Run spatial update.

(This might not always be necessary, but it’s a good time to do it.)

Run spatial worker clean.

Open the spatialos.json file (in the root directory of your project).

Replace the sdk_version value with the new version number (for example, 13.0.0).

Replace all other instances of the version number in the file.

Run spatial worker build.

When it asks: You don't appear to have the SDK CLI downloaded for your current SDK version (x.x.x),
would you like to download? [y/N], say y.

This is optional, but we recommend checking for any deprecations and upgrading to the new APIs.

You’ve now upgraded to the new version. You may want to read the
release notes to find out what is new.