Get started


Get started with the SpatialOS GDK for Unreal by building the GDK’s Unreal Engine fork and setting up a project. You can set up either or both of the following projects:

  • The Example Project is a session-based FPS game. It gives an overview of the GDK and using SpatialOS, including deploying your game to SpatialOS in the cloud and locally on your development machine - useful for testing during development. The Example Project is the basis for the GDK tutorials.

  • The Starter Template is a template project you can use as a base to create your own new project running on SpatialOS.

> Next: 1 - Get the dependencies

Tutorials and guides

After you set up the GDK and the Example Project, you can check out the following tutorials:

  • Multiserver offloading: Learn how to offload groups of Actors so Unreal server functionality is split between multiple servers using the Example Project.
  • Multiserver zoning: Implement shooting across the boundaries of different servers computing one game world using the Example Project. (Note: Zoning is in preview.)
  • Database sync worker: Learn how to integrate server database synchronization into your project using the Example Project.

You can also find out how to port a project to the GDK:

  • The porting guide: Port your existing UE project to SpatialOS.

Your feedback and ideas

We’d love to hear from you - drop into our forums or discord to give us feedback on your getting started experience, our documentation, our development roadmap, or anything else!

Find us on the SpatialOS Discord in the #unreal channel. You can get Discord here.

The SpatialOS forums
Visit the feedback section in our forums and use the unreal-gdk tag. This link takes you there and pre-fills the category and tag.

GitHub issues
Create an issue in this repository.

2019-10-18 Page updated with editorial review: removed depricated tutorial - multiple deployments for session-based games
2019-08-09 Page updated with editorial review: added new tutorials
2019-05-23 Page updated with editorial review

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums