Get SpatialOS

Sites

Menu
You are viewing the docs for 11.0, an old version of SpatialOS. 12.0 is the newest →

The SpatialOS Unreal integration is currently experimental. It's usable, but definitely has some sharp edges! We're very open to feedback - don't hesitate to get in touch on the forums if you have any thoughts.

Building changes in Unreal

There are two ways you can build Unreal workers after you’ve made changes to them:

Note: If you clean your Unreal project, building will rebuild Unreal Engine from source. This often takes a few hours. Just so you know!

Build using spatial

You can build Unreal workers using the spatial command-line tool, without having to go through an IDE.

To do this, from the root folder of your SpatialOS project:

  • To build for a local deployment, run spatial worker build --target=development
  • To build for a cloud deployment, run spatial worker build --target=production

You can now run either a local or cloud deployment using the instructions from the Setting up the example project page.

Build from Visual Studio

You can build a worker directly from Visual Studio. To do this:

  1. Navigate to the root folder of your SpatialOS project.
  2. In this directory, open a terminal and run spatial worker codegen.
  3. If you haven’t generated the Visual Studio project files for your worker yet, right-click on your .uproject file and select “Generate Visual Studio project files”.

    For the RPG demo, that looks like this:

    Generate visual studio project files

  4. Open the Visual Studio project for your worker. This should have the same name as your .uproject

    but with the extension .sln. For example, RpgDemo.sln.

    This will launch your worker project in Visual Studio.

  5. Once Visual Studio has loaded, set your solution configuration and your solution platform to your desired target.

  6. Build your project using the menu Build > Build Solution.

Once the build has succeeded, SpatialOS will package your worker. You can now run either a local or cloud deployment using the instructions from the Setting up the example project page.

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums