These are the tools you need to manage your game deployments:

  • the Console
  • the CLI
  • the Launcher (outside of China)/Playtest Hub (in China)

Installing the SpatialOS tools is a prerequisite for using the Worker SDK and the GDKs for Unreal and Unity.

You get access to the Console when you sign up to SpatialOS, but you need to install the CLI and the Launcher. See the tools installation guides for Windows, macOS, and Linux.

Console

This is a web-based tool for debugging and managing games. The Console is made up of the Inspector, the Logs viewer, and the Metrics viewer.

CLI

A set of commands for managing and developing SpatialOS projects. See the CLI documentation
for details.

Launcher

The Launcher is a tool that can launch a platform-specific client to connect to your deployments. It’s great for quickly testing your latest build and sharing your project with others.

  • If you’re in China, you need to use the Playtest Hub instead of the Launcher.
    Only follow the in-China instructions if you are located in China and deploying your game to server nodes hosted in China. You can only deploy to server nodes hosted in China if you're located in China. For more information, contact your account manager or get in touch.
  • The Launcher can only launch clients built using the GDK for Unity or GDK for Unreal.
  • You can’t use the Launcher on Linux.

See the Launcher documentation for more details.

Updated 2 days ago


Welcome


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.