Generate a snapshot

Generate an initial snapshot

Before you run your first deployment, and whenever you update your GDK, you must generate an initial snapshot. There are two ways to generate an initial snapshot:

Generate manually from the GDK toolbar

To generate a snapshot manually, on the SpatialOS GDK toolbar in the Unreal Editor, select Snapshot.

Image: The GDK toolbar

This creates a snapshot called default.snapshot which you can find in <ProjectRoot>/spatial/snapshots. See <ProjectRoot> for more information.

If you want to export your snapshots to a different path, you can specify the output path and file name in the Editor settings panel. For more information, see SpatialOS Editor Settings panel.

Generate automatically when you start a cloud deployment

When you start a cloud deployment, you can automatically generate an initial snapshot. To do so:

  1. In the GDK toolbar, click Cloud:
  1. In the Cloud Launch Configuration dialog box, check Build and Upload Assembly and Generate Snapshot:

When you start your deployment, the GDK generates a new snapshot for your project and uploads the snapshot with the assembly.

The GDK saves the snapshot on your computer as <ProjectRoot>/spatial/snapshots/default.snapshot. It overwrites any existing file with the same file path and file name. If you want to export your snapshots to a different path, you can specify the output path and file name in the Editor settings panel. For more information, see SpatialOS Editor Settings panel.

For more information on the Cloud Deployment Configuration dialog box, see the following pages:

Generate snapshots of a cloud deployment

You can only generate a snapshot of a cloud deployment when your project uses the Compatibility Mode Runtime variant.

Make sure you have Compatibility Mode selected (in the Unreal Editor, select Edit > Project Settings > Editor settings > Runtime > Runtime Variant > Compatibility Mode). See the SpatialOS Runtime documentation for further information.

You can take individual or continuous snapshots of a cloud deployment using the following methods:

An individual snapshot via the Inspector

  • Use the Inspector.
    At the top of the screen, select Take snapshot.

Continuous snapshots via project configuration

  • Configure your deployment to automatically capture snapshots at specific time intervals.
    To do this, open your launch configuration file, and set the snapshot_write_period_seconds parameter to your chosen time interval

Continuous snapshots via the Platform SDK


2020-06-22 Page created with editorial review

Updated about a year ago


Generate a snapshot


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.