README.md

Welcome to the SpatialOS SDK for Unity documentation

New to the platform? You can:

• read about what SpatialOS is (SpatialOS documentation)
• learn how to make a game with the Pirates tutorial

Need some help? Join us at forums.improbable.io for technical questions and issues.

Note: SpatialOS 13.0 is fine for local development and deployments using the small deployment template (SpatialOS documentation), but deployments using larger templates may be unstable.

License: See the license.

Installing and upgrading

• If you are installing SpatialOS and the SpatialOS SDK for Unity for the first time, see: Introduction to the SpatialOS SDK for Unity.
• If you have a version of SpatialOS and the SpatialOS SDK for Unity which is earlier than SpatialOS 13.0, you have a combined SpatialOS and SpatialOS SDK for Unity bundle. To get the separated version, see: Upgrading to SpatialOS 13.0 and migrating to SpatialOS SDK for Unity 1.0.0.

Documentation contents

Get started

• Introduction to the SpatialOS SDK for Unity
• Setup guides
  • Windows
  • macOS
• System requirements

Learning

• Learning resources
• Pirates tutorial
  • Introduction
  • 1 - Set up the game
  • 2 - Add enemy pirates
  • 3 - Update a component property
  • 4 - Trigger and receive a component event
  • 5 - Detect a collision
  • 6 - Add a component
  • 7 - Sink the ship
  • ext - Add a component command
  • ext - Play in the cloud
• C++ worker tutorial
  • Introduction
  • 1 - Add a C++ worker to your project
  • 2 - Give access to a component
  • 3 - Update a component property
  • 4 - Trigger a component event
• Recipes
  • Connection splash screen
  • Create an entity
  • Create an entity at runtime
  • Client connection lifecycle
  • Implement a command
  • Player movement
  • Player camera visualization
  • Voice over IP
  • Work with snapshots in the Unity Editor

Development process

• Setting up a project
• What and when to build
• Deploying

Interacting with the world

• Creating and deleting entities
• Creating entity ACLs
• Querying the world
• Getting information about local entities
• Interacting with entity components

Customising

• Logging
• Configuring the build process
• Connecting to SpatialOS
• Distribute with Steam
• Entity pipeline
• Entity spawning
• Integrate with Playfab
• Load from multiple scenes
• Using the new build system

Reference

• Which components your Unity worker will check out
• Local Entities API
• Monobehaviour lifecycle
• SpatialOS window
• Unity worker project structure
• Unity worker project anatomy

iOS

• Introduction
• Building for iOS targets

Releases

• Release notes