Steamworks-Dokumentation
Steam Cloud
Kurz dargestellt
Die Steam Cloud speichert automatisch Daten Ihres Spiels auf Steam-Servern. So haben Ihre Spieler nach Anmeldung auf Steam von jedem Computer aus Zugriff auf ihre Speicherstände.
Integrationslevel
Auf der Steamworks-Website ist die Konfiguration der Dateipfade erforderlich. Uploads, Downloads sowie Aufzählen und Löschen erfordern einige API-Aufrufe aus dem Spielcode heraus an Steamworks. (Optional.)

Steam Cloud – Übersicht

Die Steam Cloud bietet ein einfaches und transparentes System zum externen Speichern von Dateien für Ihr Spiel. Alle in der Auto-Cloud-Konfiguration angegebenen oder über die Cloud-API auf das Laufwerk geschriebenen Dateien (erstellt, geändert, gelöscht etc.) werden nach Beendigung des Spiels automatisch auf den Steam-Servern repliziert.

Wenn der Benutzer zu einem anderen Computer wechselt, werden die Dateien automatisch auf den neuen Computer heruntergeladen, bevor das Spiel startet. Das Spiel liest dann die Daten entweder über die Cloud-API oder wie gewöhnlich direkt vom Laufwerk. Vermeiden Sie gerätespezifische Konfigurationen, z. B. Videoeinstellungen.

Der Steam-Client stellt sicher, dass die Dateien auf allen Computern eines Benutzers synchron bleiben.

Benutzer können die Cloud-Synchronisation in den Steam-Einstellungen global deaktivieren, indem Sie die Option „Steam-Cloud-Synchronisation für alle unterstützten Anwendungen aktivieren“ deaktivieren.

Benutzer können die Cloud-Synchronisation auch für einzelne Spiele in den Eigenschaften des jeweiligen Spiels deaktivieren.

Spacewar_Cloud_Properties.png

Hinweise und bewährte Praktiken


Steam synchronisiert die Steam-Cloud-Dateien von Nutzern vor und nach jeder Spielsitzung. Während einer Spielsitzung veränderte Dateien werden sofort nach Beendigung dieser in die Steam Cloud hochgeladen. Das Speichern sehr großer oder vieler kleiner Dateien in der Steam Cloud kann die Bandbreite von Nutzern belasten und das Beenden von Steam sowie einen Neustart des jeweiligen Spiels verzögern.

Im Allgemeinen empfehlen wir kleinere Dateien zu verwenden. Weiterhin empfehlen wir separate Dateien zu verwenden, wenn der Spielstand eines Nutzers in verschiedene Kategorien aufgeteilt werden kann, wie z. B. in Speicherstände die sich häufig ändern und solche, die sich nur selten ändern. Auf diese Weise werden unveränderte Speicherstände nicht nach jeder Spielsitzung erneut hochgeladen.

Maximale Dateigröße


Die zulässigen Größen für Steam-Cloud-Dateien können sich mit der Zeit ändern. Hier die aktuellen Maximalgrößen:

GrößeBeschränkung
100MBMaximale Größe für einen Aufruf an ISteamRemoteStorage::FileWrite oder ISteamRemoteStorage::FileWriteStreamWriteChunk
256MBKann zu einer nicht optimalen Speicherendpunktauswahl für den Standort des Benutzers führen und dessen Upload-/Downloadleistung beeinträchtigen.

Save File Paths

When deciding where to write your save files, be sure the path will be unique for the current Steam user. If needed, you can get the user's unique Steam ID via ISteamUser::GetSteamID. From that, you can access their accountID from GetAccountID(), allowing you to have a unique variable when constructing your save path.

Cross-Platform Saves


If your game is supported on multiple platforms - or even if you plan to support this in the future - you should consider this when setting up Steam Cloud for your game.

If you plan to read/write files directly via the ISteamRemoteStorage interface, then you can control platform sync via ISteamRemoteStorage::SetSyncPlatforms. The default for a new file is to sync to all platforms.

If you plan to use Steam Auto-Cloud, there are some key things to know. First, the default for new files is to sync to only the OS setting on the associated Auto Cloud Root path. This means that if you set up distinct roots for each OS, all files will be partitioned by platform, and hence there will be no cross-platform save functionality.

To enable cross-platform saves, you should instead define a single Root path (likely for Windows), and then create Root Overrides for the other supported platforms. Files matching a given Root path which also has platform Root Overrides will sync to all platforms in both the origianal Root and all Overrides. See the Steam Auto-Cloud documentation for more details.

Ersteinrichtung

To set up Steam Cloud you must set the Byte quota per user and Number of files allowed per user options on the Steam Cloud Settings page in the Steamworks App Admin panel.

This quota is enforced on each Cloud-enabled game, on a per-user-per-game basis. It's recommended to set the values to reasonable amounts for your game title.

HINWEIS: Don't forget to click Save at the bottom of the page, and Publish your updated settings. Once published the cloud icon will be visible in the Steam client for anyone that owns your game.

If your game has already been released to the public then you can check the box labeled Enable cloud support for developers only. If developers-only mode is enabled then only the steam accounts which own a "Developer Comp" license for your title will see the cloud icon and will be able to use the Steam Cloud. This is useful to safely test Steam Cloud integration without breaking the public user experience. This has no effect on unreleased games since no one owns the game yet, they won't be able to see or access any cloud storage for the specific app ID.

You are able to share Cloud storage space between two app IDs by filling out the Shared cloud APP ID field. This is most commonly used to share saved games between a demo and a full game. A value of 0 disables this feature.

Steam-Cloud-API und Steam-Auto-Cloud

Steam provides two different methods of utilizing the Steam Cloud, read up on how the two methods differ, and determine which would be the best for your application.

First up is the Steam Cloud API.
The Cloud API provides a series of functions which allows you to directly integrate the Steam Cloud into your game. The Cloud API isolates individual Steam users files from each other and provides a greater level of control over the Steam Cloud.

The Steam Cloud API is exposed via the ISteamRemoteStorage API interface, and you can find example usage in the Steamworks-API-Beispielanwendung (SpaceWar) project.

The second is Steam Auto-Cloud.
Steam Auto-Cloud was designed for games where you choose to not integrate the Steam Cloud API. It provides a quick and easy way to get started but lacks the flexibility that is available with the Steam Cloud API.

If you prefer a deeper integration with Steam Cloud (for example, allowing to choose which save files are stored in the cloud), then you should use the Cloud API. Otherwise you can use Steam Auto-Cloud.

Steam-Auto-Cloud

Steam Auto-Cloud is an alternative to the Steam Cloud API that allows apps to use Steam Cloud without writing code or modifying the game in any way. It only requires that you specify the file groups which you want persisted to the Cloud. Steam will automatically sync the groups of files when the application launches and exits. Avoid machine specific configurations such as video quality.
Hinweis: Die Datei „steam_autocloud.vdf“ wird an jedem in Ihrem Steamworks-Cloud-Pfad angegebenen Ort erstellt. Diese Datei wird von Steam verwendet und kann von Ihrem Spiel ignoriert werden.

Setup

After completing the Ersteinrichtung the Steam Auto-Cloud configuration section will unlock on the Steam Cloud Settings page.

Root Paths describe groups of files which will be persisted to the Steam Cloud. Each Root Path can be as specific as a single file or as wide as all files under a given subfolder. Use a new path for each group of files to sync.

A Root Path is composed of 5 parts:
  1. Stammverzeichnis

    Dies ist eine vordefinierte Liste von Pfaden, in denen normalerweise Spielstände gespeichert werden.
    StammverzeichnisUnterstützte BetriebssystemeZugehöriger Pfad
    App-InstallationsverzeichnisAlle[Steam-Installationsordner]\SteamApps\common\[Spielordner]\
    SteamCloudDocumentsAllePlattform-spezifischer Pfad, z. B. auf Linux: ~/.SteamCloud/[Benutzername]/[Spielordner]/
    WinMyDocumentsWindows%USERPROFILE%\Dokumente\
    WinAppDataLocalWindows%USERPROFILE%\AppData\Local\
    WinAppDataLocalLowWindows%USERPROFILE%\AppData\LocalLow\
    WinAppDataRoamingWindows%USERPROFILE%\AppData\Roaming\
    WinSavedGamesWindows%USERPROFILE%\Gespeicherte Spiele\
    MacHomemacOS~/
    MacAppSupportmacOS~/Library/Application Support/
    MacDocumentsmacOS~/Documents/
    LinuxHomeLinux~/
    LinuxXdgDataHomeLinux$XDG\_DATA\_HOME/
  2. Unterverzeichnis

    Unterverzeichnispfad zu den Cloud-Dateien relativ zum Stammverzeichnis. Verwenden Sie `.`, wenn kein Unterverzeichnis vorhanden ist.

    Spezielle Auto-Cloud-Pfadwerte
    Auto-Cloud ermöglicht die Verwendung eindeutiger Steam-Benutzer-Bezeichner im Unterverzeichnis-Pfad. So können Sie Spielstände für jeden Benutzer des Computers separat speichern. Sie können ISteamUser::GetSteamID in Ihrem Spiel verwenden, um die Steam-ID oder die Account-ID des aktuellen Benutzers für Speicher- und Lesevorgänge abzurufen.
    • {64BitSteamID} – Verwenden Sie diese Variable im Steam-Pfad, um die 64-Bit-Steam-ID des Benutzers einzufügen. Eine 64-Bit Steam-ID sieht wie folgt aus: 76561198027391269.
    • {Steam3AccountID} – Verwenden Sie diese Variable im Steam-Pfad, um die 3-Bit-Steam-ID des Benutzers einzufügen. Eine Account-ID sieht wie folgt aus: 67125541.
    Beispiel: SavesDir/{64BitSteamID}
  3. Muster

    Passendes Dateimaskenmuster. Sie können * als Platzhalter verwenden. Wenn Sie alle Dateien im Verzeichnis einschließen möchten, verwenden Sie einfach*.

    Beispiel: *.sav
  4. Betriebssystem

    Legt das Betriebssystem fest, mit/von dem die Dateien synchronisiert werden. Dies ist nur erforderlich, wenn die Dateien betriebssystemspezifisch sind, was hoffentlich nicht der Fall ist.
  5. Rekursiv

    Bezieht Unterverzeichnisse bei der Suche nach Dateien mit ein. Dies ist nützlich bei Unterverzeichnissen mit nicht-deterministischen Namen, z. B. Namen oder IDs von Nicht-Steam-Benutzern. Wenn Sie eine Steam-ID verwenden, wird die Nutzung der speziellen Pfadwerte im Feld „Unterverzeichnis“ dringend empfohlen.

Root Overrides

If your application is cross-platform and requires different directories for each OS. You can use the Root Overrides functionality to specify an override the Root Paths that you set above.

The root paths specified above can be overridden to correspond to a different path on another OS. If you use Root Overrides, you must specify [All OSes] in the Root OS drop down above.

A Root Override consists of 5 parts.
  1. Original-Stammverzeichnis

    Dies entspricht einem der oben eingestellten Stammverzeichnisse.
  2. Betriebssystem

    Das Betriebssystem, auf das die Überschreibung angewendet wird.
  3. Neues Stammverzeichnis

    Der neue Speicherort, auf den das Original-Stammverzeichnis auf dem angegebenen Betriebssystem verweist.
  4. Pfad hinzufügen/ersetzen

    Hiermit können Sie optional einen Unterverzeichnispfad hinzufügen, der zwischen dem neuen Stammverzeichnis und dem originalen Stammverzeichnis eingefügt wird.
  5. Pfad ersetzen

    Wenn aktiviert, wird das originale Unterverzeichnis vollständig durch den unter „Pfad hinzufügen/ersetzen“ angegebenen Pfad ersetzt.

Example: Configuring Auto-Cloud for Unity Applications

The following is an example of setting up Auto-Cloud for use with Unity and the Application.persistentDataPath property where the value is different per OS. The Windows version is configured as the Root Path with the company in Unity set to DefaultCompany and the Project called AutocloudSample. On macOS and Linux/SteamOS, the alternate paths from Application.persistentDataPath are set in the Add/Replace Path field and Replace Path is enabled.

With these settings, Auto-Cloud files will be synchronized between the three folders as shown in the Preview samples.

Cloud_Unity_Auto-Cloud_Example.png

Pre-release Testing

If you are adding Steam Auto-Cloud to a game which is already released and you have enabled developer-only mode during the Ersteinrichtung then you must complete some additional steps to test the functionality.
  1. Melden Sie sich bei Steam mit einem Account an, der die zu testende Anwendung besitzt.
  2. Öffnen Sie die Steam-Konsole, indem Sie in Ihrem Browser zu steam://open/console navigieren.
  3. Geben Sie testappcloudpaths <AppId> mit der App-ID der zu testenden Anwendung ein. Beispiel: testappcloudpaths 480
  4. Geben Sie set_spew_level 4 4 in die Konsole ein.
  5. Starten Sie Ihre Anwendung von Steam aus.
  6. Prüfen Sie auf Konsolenaktivität. Wenn in den Auto-Cloud-Pfaden bereits Dateien vorhanden sind, sollten diese jetzt hochgeladen werden. Speichern Sie anderenfalls einige Dateien aus Ihrer Anwendung und schließen Sie dann die Anwendung, um eine Synchronisierung auszulösen.
  7. Wechseln Sie zu einem anderen PC und wiederholen Sie die Schritte oben, um den Download von Dateien aus Steam-Auto-Cloud zu testen.
  8. Führen Sie die Tests unbedingt auf allen unterstützten Betriebssystemen durch.
  9. Set testappcloudpaths 0 and set_spew_level 0 0 to end testing. Um den Konsolen-Tab zu schließen, können Sie den Steam-Client neu starten.

Don't forget to disable developers-only mode and publish the changes when you're done testing.

Dynamic Cloud Sync


Steam Cloud now supports dynamic sync - where changes appearing in the Cloud can be downloaded to the local machine during an application session. The current example is a suspended game session on the Steam Deck. For apps marked as supporting dynamic Cloud sync, Steam will synchronize files up to the Steam Cloud at the suspend time. Then, the user may run the game on another device, which will receive the updates from the Steam Deck session at launch. At exit, those changes will be uploaded to the Steam Cloud. Finally, when the Steam Deck device is awakened, Steam will synchronize the changes down to that device, and post a notification to the application that local files have changed. The application can then iterate those changes and take appropriate action. For instance, the game may be able to simply load the updated progress from disk and allow the user to pick up right where they left off on the other device.

Check out our announcement post for even more information about why this feature exists, and how to use it.

Note that this feature supports applications whether they use the ISteamRemoteStorage API to manage files, or Auto-Cloud.

For more details, see the ISteamRemoteStorage documentation, specifically ISteamRemoteStorage::RemoteStorageLocalFileChange_t, ISteamRemoteStorage::GetLocalFileChangeCount, and ISteamRemoteStorage::GetLocalFileChange.

See also ISteamRemoteStorage::BeginFileWriteBatch and ISteamRemoteStorage::EndFileWriteBatch - these wrappers should be used to provide hints to Steam which will help it safely sync up to the Steam Cloud at the time when the user initiates a system suspend.

Pre-release Testing


You can locally enable Dynamic Cloud Sync for your app to test your builds - this is recommended for a game that has already shipped, as enabling Dynamic Cloud Sync for all users could lead to data loss when running builds that do not handle the new API methods and callbacks.

To test locally from a PC:

  1. Sign in to Steam with an account that owns the app that you are testing.
  2. Open the Steam Console by navigating to steam://open/console in your browser. (You can also run Steam with the command-line steam -console and then navigate to the Console section directly).
  3. Enter @cloud_testdynamicsyncapp <AppId> into the console with the given App ID that you are testing. Ex: @cloud_testdynamicsyncapp 480
  4. Launch your app from Steam.
  5. Progress through the game to a desired amount
  6. In the Steam Console, enter prepare_for_suspend. Steam will suspend your game process and upload any changed files to the Steam Cloud.
  7. Optional: play the game on another device, creating further progress, and then exit and let that Steam client upload progress to the Steam Cloud.
  8. Back on the original device, in the Steam Console, enter resume_suspended_games. This will sync down any necessary files from the Steam Cloud, post the relevant API calls to your game, then un-suspend your game process.

To test locally from a Steam Deck:

  1. Connect your Steam Deck with a Devkit
  2. To use the CEF Console, see here
  3. In the JS console, enter SteamClient.Console.ExecCommand(“@cloud_testdynamicsyncapp <AppId>”) to enable testing. You can then enter SteamClient.Console.ExecCommand(“@cloud_testdynamicsyncapp 0”) to disable it

Debugging

First, always ensure that you have published your changes on the Steam partner website and have waited up to 10 minutes or restarted your Steam client to receive the published changes.

If you run into issues with Steam Cloud you should check the log file located at %Steam Install%\logs\cloud_log.txt.

See Debuggen der Steamworks-API for additional information.