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


This page is about deploying from the Unity Editor. If you want to build from the command line, see Deploying locally from the command line.

Run a local deployment

  1. In the Unity Editor, open the SpatialOS window (Window > SpatialOS).
  2. Under Run SpatialOS locally, click Run.

    This opens a console running spatial local launch.

When SpatialOS starts successfully, you should see SpatialOS ready in the console. At this point, you can access the Inspector at http://localhost:21000/inspector.

Connect a client

Once the deployment is running, to connect a Unity client:

  1. In Unity, open workers/unity (or the directory that contain the Unity client), and open the scene UnityClient.unity.

    UnityClient scene in Unity assets

  2. At the top, click Play ▶.

    The scene will open, looking something like this:

    Open scene in Unity

Deploying to the cloud

For information about deploying to the cloud, see Deploying to the cloud.

Unity cheat sheet

For a handy guide to how to deploy Unity projects to the cloud, see this cheat sheet:

Unity cloud cheat sheet

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums