Get SpatialOS



Setting up a project


  • You’ve gone through the SDK setup guide for Windows and have everything installed.
  • You have a project. You can use one of the examples at the SpatialOS GitHub repository.

Set up the project

  1. Open a terminal, navigate to the root folder of your project and run spatial worker codegen.

    If you are not using one of our starter projects, you have to add "SpatialOS" to your PublicDependencyModuleNames in your Build.cs file. This will set up your include paths next time you generate VS project files.

  2. Locate the Unreal project file for your project. This can be found in PROJECT_ROOT/workers/unreal/Game.

  3. Right-click on your project’s .uproject file and select Switch Unreal Engine version.

  4. Switch engine versions to the source-built version you just built.

  5. Run spatial worker build. This may take an hour or more.

This will build an assembly used for both local and cloud SpatialOS deployments.

If you open your project with another version of Unreal Engine, it will rebuild the entire project.

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums