GDK for Unreal Documentation

The SpatialOS GDK for Unreal is in alpha. It is ready to use for development of games using a single server, or multiserver offloading functionality. We do not recommend development using multiserver zoning functionalty. For more information on multiserver zoning availability, see the development roadmap and Unreal features support page.

The SpatialOS Game Development Kit (GDK) for Unreal is an Unreal Engine fork and plugin with associated projects; it provides features of SpatialOS, within the familiar workflows and APIs of Unreal.

You can get started immediately or find out more before diving in.

SpatialOS provides:

  • Global hosting: Scalable dedicated hosting for your game in every major gaming region.
  • Easy playtesting: Deploy and test your game from the start of development, and distribute it to your team and players quickly and easily with a ready-made link. Scale-test your build by connecting simulated players.
  • Profiling and debugging tools: Logs and metrics out of the box to help you quickly understand any bugs and performance issues.
  • Single and multiserver networking: Use one instance of server software or multiple instances of server software to compute your game world. Multiple servers enable a greater numbers of Actors, players and gameplay systems in your game.
    Multiserver is available through either:
    • server offloading (available in alpha), in which Unreal server functionality is split between multiple servers and those servers compute different functionality across the whole game world, or
    • server zoning (available in pre-alpha only), in which the game world is split into several geographical areas and each area has a dedicated Unreal server computing all the functionality for it.

Get started

If you’re an Unreal game developer and you’re ready to try out the GDK, follow the Get started guide, or you can find out more before diving in.

The Get started guide takes you through setting up the GDK and getting the Starter Template project or the Example Project running in the cloud, as well as running locally on your computer. The Example Project gives an overview of the GDK and using SpatialOS, and is the basis for tutorials, and you can use the Starter Template as a basis for your own projects.

After you set up the SpatialOS GDK and the Example Project, you can learn more about the GDK’s functionality with tutorials and guides:

  • 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.
  • The porting guide: Port your existing UE project to SpatialOS.

Find out more

  • Learn more about how the GDK works and how it fits into your game stack.
    Read the Technical overview (10-minute read).

  • If you aren’t already familiar with SpatialOS, you can find out about the concepts which enable it to support game worlds with more persistence, scale, and complexity than previously possible.
    Read the SpatialOS concept docs (10-minute read).

  • We’d love to hear your game ideas and answer any questions you have about making games on SpatialOS.
    Join the community on our forums, or on Discord.

> Next: Get started

2019-10-18 Page updated with editorial review: removed mention of the deprecated tutorial - multiple deployments for session-based games
2019-08-09 Page updated with editorial review
2019-08-08 Page updated with editorial review: renamed “multiserver shooter tutorial” to “multiserver zoning tutorial”
2019-07-31 Updated with limited editorial review

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums