Tutorials and guides
Port your project to SpatialOS
This guide shows you how to port your own Unreal project to the GDK; you will modify your project to make it compatible with the GDK and SpatialOS, and you will launch a local deployment to test your project.
Get to know the GDK before porting your game
We recommend following steps 1 to 3 of the Get started guide and setting up the Example Project before porting your project. This gives you an overview of the GDK and using SpatialOS.
Tip: Reference project
As you port your own Unreal project to SpatialOS, you could use our pre-ported Unreal Shooter Game as a reference. You should already have this project as it is included in the
Samples directory of the SpatialOS Unreal Engine fork which you downloaded as part of the Get started steps.
(If you want to see the game running, there’s a video on youtube to check out.)
Terms used in this guide
<GameRoot>- The directory containing your project’s
<ProjectRoot>- The directory containing your
<YourProject>- The name of your project’s
.uprojectfile (for example,
Before you start
Before porting your project you must follow:
- Get started 1 - Dependencies
- Get started 2 - Set up the fork and plugin
- Get started 3 - Set up a project: The Starter Template (Note that you must follow the Starter Template instructions and not the Example Project instructions.)
> Next: 1. Set up your project
2019-07-16 Page updated with editorial review.