SpatialOS SDK for Unity

April 2019: Stopped development for the SDK for Unity.

We have stopped development for the SDK for Unity and will not support new projects using the SDK. If you want to get started with SpatialOS using Unity, please use the SpatialOS Game Development Kit (GDK) for Unity. The GDK is publicly available, integrates with the Unity ECS and provides faster iteration times. Check out the FPS Starter Project or the Blank Starter Project to get started quickly!

Existing SDK for Unity customers can continue development of their current SpatialOS projects, but are strongly encouraged to upgrade to the GDK as soon as possible. Please contact us on Discord or our Forums, if you have any questions.

About the SpatialOS SDK for Unity

• Repository: github.com/spatialos/UnitySDK
• By: Improbable
• Use of the contents of this repository is subject to the Improbable license
• Your access to and use of the Unity Engine is governed by the Unity Engine End User License Agreement. Please ensure that you have agreed to those terms before you access or use the Unity Engine.

Use the SpatialOS SDK for Unity to create games with persistent online worlds. Together with the SpatialOS spatial CLI, the SpatialOS SDK for Unity allows you to use Unity to create games for the SpatialOS platform. To help you get started, there are tutorials to follow and example games to experiment with. In addition to the SpatialOS SDK for Unity documentation in this repository, you can find out more about SpatialOS at docs.improbable.io.

Requirements

Software: To use the SpatialOS SDK for Unity, you need the following software:

• The SpatialOS SDK for Unity
• Unity
• The spatial CLI for SpatialOS

See System requirements: software for details.

Operating system: System requirements: Operating systems

Hardware: System requirements: Hardware

Network settings: System requirements: Network settings

Installing and upgrading

New install: If you are installing SpatialOS and the SpatialOS SDK for Unity for the first time, see: Introduction to the SpatialOS SDK for Unity.

Upgrade and migration: If you have a version of SpatialOS which is earlier than 13.0, you have a combined SpatialOS and SDK for Unity bundle. To get the separated version, see Upgrading to SpatialOS 13.0 and migrating to the SpatialOS SDK for Unity 1.0.0.

Documentation

SpatialOS SDK for Unity documentation: This repository in GitHub

SpatialOS documentation: docs.improbable.io.

Community

Visit: Join us at forums.improbable.io for technical questions and issues.