Sites

Menu

Tutorials and guides

Port your project to SpatialOS

Please be aware of the GDK’s support level of different Unreal features. If you need to port your game, please contact us via our forums, or Discord so we can best support you.

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 .uproject file and Source directory.
  • <ProjectRoot> - The directory containing your <GameRoot>.
  • <YourProject> - The name of your project’s .uproject file (for example, \<GameRoot>\TP_SpatialGDK.uproject).

Before you start

Before porting your project you must follow:

  1. Get started 1 - Dependencies
  2. Get started 2 - Set up the fork and plugin
  3. 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.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums