Manage XGameSave data on PC (xgamesaveutil.exe)

Use this tool to manage XGameSave data on your PC. Don’t use it while the title is running. Doing so can put the title’s Game Saves in an indeterminate state. This tool requires the title package to be installed on your PC. This requirement differs from console, where deploying through Visual Studio is sufficient for xbstorage to interact with the title’s Game Saves. You can generate PC packages with makepkg and install them with wdapp install.

If you need to manage XGameSave data on the console, you must use the Manage XGameSave storage on console (xbstorage.exe).

Command	Description
reset	Deletes only local data for the specified Package Family Name (PFN) and Service Configuration Identifier (SCID) on the PC with no impact on saves in the cloud.
import	Imports data from the specified XML file to an `XGameSave` storage space.
export	Exports data from an `XGameSave` storage space to the specified XML file.
delete	Deletes data from an `XGameSave` storage space.
generate	Generates dummy data and saves it to the specified XML file.

xgamesaveutil reset

xgamesaveutil reset [/pfn:<PFN>] [/scid:<SCID>] [/context:<infile>]

Deletes only local data for the specified PFN and SCID on PC, with no impact on saves in the cloud. If a title is launched after xgamesaveutil reset is called, existing saves from the cloud are synced down to the device. There are two ways to specify the location of the data to delete:

If the /context parameter is used, and the filename specified by <infile> has a ContextDescription section that is correctly populated, then that file will be used to specify the target PFN and SCID.
The PFN and SCID can be partially or fully specified through command-line parameters, which take precedence over the respective elements of the specified PFN and SCID from the input file.

Option	Description
/context:<infile>	Specifies the file to use for the app PFN and SCID.
/pfn:<PFN>	Specifies the Package Family Name (PFN) for the app to delete the data from. The app must be installed.
/scid:<SCID>	Specifies the Service Configuration Identifier (SCID). This value comes from your XBOX services configuration.

Examples

xgamesaveutil reset /context:target.xml
xgamesaveutil reset /pfn:MyGame_xxxxxx /scid:2AAEB34B-DAB2-4879-B625-D970069C1D22

xgamesaveutil import

xgamesaveutil import <filename> [/pfn:<PFN>] [/scid:<SCID>] [/replace]

Imports the data that’s specified in filename to a storage space. This XML file contains the data. For an example, see xgamesaveutil generate in this article. For more information about the file’s XML format, see Import and export file format in this article. There are two ways to specify where to import the XGameSave data to:

If the /context parameter is used, and the filename specified by <filename> has a ContextDescription section that is correctly populated, then that file will be used to specify the target PFN and SCID.
The PFN and SCID can be partially or fully specified via command-line parameters, which take precedence over the respective elements of the specified PFN and SCID from the input file.

Option	Description
/pfn:<PFN>	Specifies the Package Family Name (PFN) for the app to delete the data from. The app must be installed.
/scid:<SCID>	Specifies the Service Configuration Identifier (SCID). This value comes from your XBOX services configuration.
/replace	Delete all containers before performing the import.

Examples

xgamesaveutil import mydata.xml
xgamesaveutil import mydata.xml /replace
xgamesaveutil import mydata.xml /pfn:MyGame_xxxxxx /scid:2AAEB34B-DAB2-4879-B625-D970069C1D22

On PC, this tool writes imported data directly to local storage. It does not sync with the cloud before or after the import, and it does not automatically upload the imported data to the cloud. The data is uploaded the next time the title launches and acquires the Game Saves provider (for example, by calling XGameSaveInitializeProvider).This differs from the console tool (xbstorage), which syncs with the cloud before importing and uploads the data immediately after.

If a game with the same primary service configuration identifier (SCID) is running, this operation could cause a race condition and put the contents of the XGameSave storage space in an indeterminate state. If /replace isn’t specified, the containers that are specified in the input file are erased before the blobs that are specified in the input file are written. Containers in the XGameSave storage space that aren’t specified in the input file won’t be touched.

xgamesaveutil export

xgamesaveutil export <outfile> [/pfn:<PFN>] [/scid:<SCID>] [/context:<infile>]

Exports data from an XGameSave storage space to the file specified by outfile. The XML file contains the exported data. For an example, see xgamesaveutil generate. For details about the XML format, see Import and export file format. There are two ways to specify where to export the XGameSave data from:

If the /context parameter is used, and the filename specified by <infile> has a ContextDescription section that is correctly populated, then that file will be used to specify the target PFN and SCID.
The PFN and SCID can be partially or fully specified through command-line parameters, which take precedence over the respective elements of the specified PFN and SCID from the input file.

Option	Description
/pfn:<PFN>	Specifies the Package Family Name (PFN) for the app to export the data from. The app must be installed.
/scid:<SCID>	Specifies the Service Configuration Identifier (SCID). This value comes from your XBOX services configuration.

Examples

xgamesaveutil export exporteddata.xml /context:target.xml
xgamesaveutil export exporteddata.xml /pfn:MyGame_xxxxxx /scid:2AAEB34B-DAB2-4879-B625-D970069C1D22

On PC, this tool reads data directly from local storage. It does not sync with the cloud before exporting. The exported data reflects whatever is currently on disk, which may not include the latest cloud data.

If an app with the same primary SCID is running, this operation could cause a race condition and put the contents of the XGameSave storage space in an indeterminate state.

xgamesaveutil delete

xgamesaveutil delete [/pfn:<PFN>] [/scid:<SCID>] [/context:<infile>]

Deletes all data from an XGameSave storage space. To do this correctly, you must:

Ensure the title isn’t running
Run xgamesaveutil delete to delete local data immediately.
Launch the title and acquire the Game Saves provider. This allows xgamesaveutil to automatically delete the cloud data.

There are two ways to specify where to delete the XGameSave data from:

If the /context parameter is used, and the filename specified by <infile> has a ContextDescription section that is correctly populated, then that file will be used to specify the target PFN and SCID.
The PFN and SCID can be partially or fully specified through command-line parameters, which take precedence over the respective elements of the specified PFN and SCID from the input file.

Option	Description
/pfn:<PFN>	Specifies the Package Family Name (PFN) for the app to delete the data from. The app must be installed.
/scid:<SCID>	Specifies the Service Configuration Identifier (SCID). This value comes from your XBOX services configuration.

Examples

xgamesaveutil delete /context:target.xml
xgamesaveutil delete /pfn:MyGame_xxxxxx /scid:2AAEB34B-DAB2-4879-B625-D970069C1D22 

Before deleting the specified XGameSave storage space, the system attempts to synchronize with the cloud by using the same logic that runs when the storage space is acquired by a running app. If an app with the same primary SCID is running, this operation could cause a race condition and put the contents of the XGameSave storage space in an indeterminate state.

xgamesaveutil generate

xgamesaveutil generate <filename> [/containers:<n>] [/blobs:<n>] [/blobsize:<n>]

Generates dummy data and saves it to a file that’s specified by <filename>. For more information about the file’s XML format, see Import and export file format in this article. The SCID is set to 00000000-0000-0000-0000-000000000000. Change these values by editing the file directly after it’s generated.

Option	Description
/containers:<n>	Specifies how many containers to generate. Default is 2.
/blobs:<n>	Specifies how many blobs per container to generate. Default is 3.
/blobsize:<n>	Specifies how many bytes per blob. Default is 1024.

Examples

xgamesaveutil generate dummydata.xml
xgamesaveutil generate dummydata.xml /containers:4
xgamesaveutil generate dummydata.xml /blobs:10
xgamesaveutil generate dummydata.xml /containers:4 /blobs:10
xgamesaveutil generate dummydata.xml /containers:4 /blobs:10 /blobsize:512

The byte data is a simple ascending sequence. For example, a 5-byte blob would have the following bytes: 00 01 02 03 04. To specify a per-user XGameSave storage space, change the Account node in the XML file to something like the following example.

<Account msa="user@example.com"/>

Import and export file format

The XML file that’s used with the import, export, and generate commands has the format that’s shown in the following example.

  <?xml version="1.0" encoding="UTF-8"?> 
  <XbConnectedStorageSpace> 
    <ContextDescription> 
      <Account msa="user@example.com"/>
      <Title scid="00000000-0000-0000-0000-000000000000" /> 
    </ContextDescription> 
    <Data> 
      <Containers> 
        <Container name="Container1"> 
          <Blobs> 
            <Blob name="Blob1"> 
              <![CDATA[... ]]>
            </Blob> 
            ... 
            <Blob name="BlobN"> 
              <![CDATA[... ]]>
            </Blob> 
          </Blobs>
        </Container> 
        ... 
        <Container name="ContainerN"> 
        ... 
        </Container> 
      </Containers> 
    </Data> 
  </XbConnectedStorageSpace>  

The format of data in this XML file isn’t identical to the format on the platform. The format might change in the future, so the files should be treated as if they have an intermediate or utility format, not an archival format. The ContextDescription node is optional. If you’re making an XGameSave storage space for a user, you can use <Account msa="user@example.com"/> instead of <Account machine="true"/>. Otherwise, the context can be specified on the command line for import. Blobs and containers should have the corresponding names given to them by the game or app for which the file is being generated. The contents of each blob should be a string wrapped in a CDATA tag, which is generated by calling CryptBinaryToStringW with the flag CRYPT_STRING_BASE64, providing the data for that blob as a raw-byte array. Conversely, blob data can be converted back by calling CryptStringToBinary to provide the formerly encrypted string. For an example of using these two functions, see CryptBinaryToString returns invalid bytes.

Tools

xgamesaveutil reset

xgamesaveutil import

xgamesaveutil export

xgamesaveutil delete

xgamesaveutil generate

Import and export file format

See also

​xgamesaveutil reset

​xgamesaveutil import

​xgamesaveutil export

​xgamesaveutil delete

​xgamesaveutil generate

​Import and export file format

​See also

xgamesaveutil reset

xgamesaveutil import

xgamesaveutil export

xgamesaveutil delete

xgamesaveutil generate

Import and export file format

See also