Backup Support

Backup Support

Backup:

With enabling BACKUPSTEAMUSER (either directly in the Game Config or Game Menu or by adding the game to the Backup Steam Collection) all directories with files from the steamuser inside the Proton pfx will be backed (using rsync) when closing the game. The destination directory is STLCFGDIR/backup/steamuser/id/$AID. A backup-timestamp file with the current epoch time is written in the same directory, which is optionally used to restore the steamuser data.

A STLCFGDIR/backup/steamuser/title/$GAMETITLE symlink pointing to it will be created as well.

Files and directories can be excluded from the backup, by either adding them into the per game STLCFGDIR/backup/exclude/exclude-$AID.txt or into the globally parsed STLCFGDIR/backup/exclude/exclude-global.txt exclude file. For easier editing both files are also available via the Editor Menu.

Restore:

The restoration of the backed up steamuser offers multiple modes, which can be configured per game in the Game Menu. The configured mode only has an effect, when a backup was found and when a SteamAppID is defined. This could be dangerous for your steamuser files, so be careful what you select and you use it at your own risk! (When removing a proton game from steam, the whole Compatdata dir (including the steamuser files) are automatically removed as well by steam, without any possibility to backup them before, so...)

The following modes are available (dst stands for "the currently used steamuser dir in Compatdata"):

• "none" : Don't try to restore any steamuser data (default)
• "ask-always" : Always ask, never restore from the backup to dst automatically (probably nobody wants this permanently, as this will pop up on every game start)
• "ask-if-dst-has-no-backup-timestamp" : Ask, if dst doesn't have a backup-timestamp file (could be useful, but likely barely used. offering it anyways to cover almost every constellation)
• "ask-if-unsure" : Ask if no clear strategy could be determined (more or less just a fallback)
• "restore-always" : Always restore from the backup to dst without asking (so you blindly trust in the backup being correct)
• "restore-if-backup-timestamp-is-newer" : Automatically restore, if both the backup and dst have a backup-timestamp file, and the one from the backup dir is newer
• "restore-if-dst-has-no-backup-timestamp" : Automatically restore, if dst doesn't have a backup-timestamp file (likely nobody wants this, but offering it to cover almost every constellation)
• "restore-if-dst-is-empty" : Automatically restore, if dst doesn't have any files (apparently the safest option to auto-recover old configs for a clean Wineprefix) This mode is automatically used when using the REDIRSTEAMUSER mode with Compatdata Redirect