SpatialOS SDK for Unity
Switch branches/tags
Clone or download

README.md

SpatialOS SDK for Unity

New from October 2018: The SpatialOS GDK for Unity
Check out the alpha release of our SpatialOS Game Development Kit (GDK) for Unity. Using the Unity Entity Component System (ECS), the GDK is the next evolution in developing SpatialOS games in Unity. The SpatialOS GDK for Unity is designed to replace the SpatialOS SDK for Unity and we recommend using it over using the SDK for new game projects. See our blog post anouncement for more information.


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.