These are the docs for 12.2, an old version of SpatialOS. The docs for this version are frozen: we do not correct, update or republish them. 14.5 is the newest →

The SpatialOS Unreal integration is currently in beta. We’re very open to feedback - don’t hesitate to get in touch on the forums if you have any thoughts.

Changing the starting state of the world

When you deploy a SpatialOS project, the initial state of the SpatialOS world is defined by a snapshot. The example projects come with a default snapshot - snapshots/default.snapshot - but you can modify it or create new ones.

In the Unreal Starter Project, there’s an Unreal commandlet to generate a snapshot, located in workers/unreal/Game/Source/StarterProject/ExportSnapshotCommandlet.cpp. The commandlet uses the C++ worker API.

The commandlet creates a spawner entity that will exist in the world when the game starts. You can add your own entities by using the SpatialOS components and Unreal blueprints you defined. When you’re happy with your changes, build your new snapshot:

Compile your C++ changes.
On the root of your project run ./generatesnapshot.sh (this will run the Unreal commandlet and overwrite snapshots/default.snapshot).

You can change the snapshot save name or location by modifying it in the Commandlet code.

Once your new snapshot is built, you can launch your new world with spatial local launch --snapshot=<your_snapshot_name>.snapshot.

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums