Releases: mtkennerly/ludusavi
v0.24.1 (2024-06-15)
- Fixed:
- Symlinks were incorrectly traversed when applying redirects. For example, if you had a backup-type redirect from
/oldto/new, but/newhappened to be a symlink to/neweron your system, then the backup would incorrectly contain a reference to/newer. - Redirects could match a partial folder/file name. For example, a restore-type redirect from
C:/oldtoC:/newwould also redirectC:/oldertoC:/newer(C:/[old -> new]er). - On Linux, if a file name contained a colon (
:), it would fail to back up. - GUI: When using a game's context menu to create a custom entry, Ludusavi did not scroll down to the new entry.
- Symlinks were incorrectly traversed when applying redirects. For example, if you had a backup-type redirect from
- Changed:
- Updated translations, including a new translation for Finnish. (Thanks to contributors on the Crowdin project)
v0.24.0 (2024-06-08)
- Added:
- On the "other" screen, you can choose not to back up games with cloud support on certain stores. If a game is customized or already has local backups, then Ludusavi will continue backing it up regardless.
- For Heroic roots, Ludusavi now supports Amazon and sideloaded games.
- For Lutris roots, Ludusavi now scans
pga.dbin addition togames/*.ymlin case the YAML files do not contain all of the necessary information. - CLI: There is a new
apicommand that can be used for bulk queries. Right now, it only supports looking up titles (analogous to thefindcommand). - CLI: There is a new
schemacommand to display some of Ludusavi's schemas. - CLI: The
findcommand now accepts a--lutris-idoption. - CLI: The
backupscommand output now includes each game's backup directory.
- Changed:
- Title normalization now ignores apostrophes and quotation marks (e.g.,
ludusavi find --normalized "Mirrors Edge"will findMirror's Edge). - Some additional fields in the config file have been made optional.
- Updated translations. (Thanks to contributors on the Crowdin project)
- Title normalization now ignores apostrophes and quotation marks (e.g.,
- Fixed:
- For Heroic and Lutris roots, if you had multiple copies of the same game, Ludusavi would only use the metadata from one of them.
- GUI: The game-level duplication badge did not always fade out when the conflicts were resolved.
v0.23.0 (2024-04-27)
- Added:
- CLI: The
wrapcommand now supports some new arguments:--infer steam,--infer lutris, and--forceto skip confirmations - GUI: File sizes are now displayed for each file and directory. (Contributed by JackSpagnoli)
- When a save fails to back up or restore, you can now see a specific error message per save. Previously, this was only available in the log file. For the GUI, you can hover over the "failed" badge to view the error. Note that these errors are shown as-is for troubleshooting and may not be translated.
- You can now set aliases to display instead of the original name. This does not affect the CLI when using
--api. - On Linux, for Steam roots that point to a Flatpak installation, Ludusavi now checks
$XDG_DATA_HOMEand$XDG_CONFIG_HOMEinside of the Flatpak installation of Steam. - Updated translations, including new in-progress translations for Traditional Chinese and Turkish. (Thanks to contributors on the Crowdin project)
- CLI: The
- Fixed:
- Ludusavi would crash when reading a non-UTF-8 mapping.yaml file. This wouldn't normally happen, but could arise from external modifications.
- GUI: On Linux with Wayland, the app ID property was not being set, which caused some issues like not showing the window icon and not grouping the window properly. (Contributed by ReillyBrogan)
- CLI: During slow processing (e.g., cloud upload or a game with huge saves), the progress bar timer wouldn't update.
- GUI: After performing a cloud upload preview on the other screen, the very next backup preview wouldn't do anything.
- GUI: You can now use undo/redo shortcuts for backup comments.
- CLI: The
wrapcommand did not fail gracefully when the game launch commands were missing. - CLI: Several commands did not resolve aliases.
- CLI: The
cloudcommands did not reject unknown game titles. - If a game had more data that failed to back up than succeeded, then the backup size would be reported incorrectly.
- Changed:
-
The way Ludusavi parses file paths internally has been overhauled. The majority of the observable behavior is the same, but it is now more predictable and correct when parsing Linux-style paths on Windows and vice versa.
Some behavioral changes worth noting:
- You can now configure redirects that change Windows/Linux-style paths into the other format. For example, if you configure a backup redirect from
C:\gamesto/opt/games, then the backup will contain references to/opt/games. (Previously,/opt/gameswould turn intoC:/opt/gameswhen parsed on Windows, andC:\gameswould turn into./C_/gameswhen parsed on Linux.) - On Windows, you can no longer write
/gamesas an alias ofC:\games. These are now treated as distinct paths. (Previously, on Windows, Linux-style paths were interpreted asC:paths.) - If you try to restore Windows-style paths on Linux or vice versa, it will now produce an error, unless you've configured an applicable redirect.
- You can now configure redirects that change Windows/Linux-style paths into the other format. For example, if you configure a backup redirect from
-
GUI: On Windows, the way Ludusavi hides its console in GUI mode has changed, in order to avoid a new false positive from Windows Defender.
Instead of relaunching itself, Ludusavi now detaches the console from the current instance. This reverts a change from v0.18.1, but care has been taken to address the problems that originally led to that change. If you do notice any issues related to this, please report them.
-
GUI: Previously, when you changed settings, Ludusavi would save each change immediately. It now waits for 1 second in case there is another change, so that typing and other fast, successive edits are batched.
-
CLI: Previously, the
restoreandbackups(notbackup) commands would return an error if you specified a game that did not have any backups available to restore. This was inconsistent with thebackupcommand, which would simply return empty data if there was nothing to back up. Now,restoreandbackupswill also return empty data if there are no backups. -
CLI: Some deprecated flags have been removed from the
backupcommand:--merge,--no-merge,--update, and--try-update. -
When synchronizing to the cloud after a backup, Ludusavi now instructs Rclone to only check paths for games with updated saves. This improves the cloud sync performance.
-
The following are now configured as default arguments for Rclone:
--fast-list --ignore-checksum. These should improve performance in most cases. You can change or remove these on the "other" screen. -
GUI: During a backup or restore, if the "synchronize automatically" cloud setting is enabled, then the progress bar will display "cloud" instead of "scan" during the cloud operations.
-
Differential backup names now end with "-diff". This does not affect existing backups.
-
v0.22.0 (2023-12-26)
- Added:
- You can now configure additional manifests, which Ludusavi will download and use just like the primary one. This allows the community to create additional save lists for specific purposes that might not be covered by PCGamingWiki.
- You can now configure a custom game as an alias for another game, without having to make a copy of the other game's info. On the custom games screen, use the dropdown to toggle between "game" (default) and "alias".
- You can now configure roots for OS installations on other drives. New root types:
Windows drive,Linux drive,Mac drive - Ludusavi can now scan Legendary games on their own without Heroic. New root type:
Legendary - CLI:
wrapcommand to do a restore before playing a game and a backup afterwards. (Contributed by sluedecke) - When a path or URL fails to open, additional information is now logged.
- On Windows, Ludusavi can now back up additional types of registry data:
REG_NONE,REG_DWORD_BIG_ENDIAN,REG_LINK,REG_RESOURCE_LIST,REG_FULL_RESOURCE_DESCRIPTOR,REG_RESOURCE_REQUIREMENTS_LIST. - On Windows, Ludusavi now recognizes if you've moved the
%USERPROFILE%\Saved Gamesfolder.
- Changed:
- GUI: A different icon is now used for the button to hide the backup comment field. The previous icon (a red X) could have been misinterpreted as "delete" rather than "close".
- GUI: When you click the filter icon on the backup/restore screen, the title search field is automatically focused.
- CLI: Help text is now styled a bit differently.
- Updated translations, including a new in-progress Czech translation. (Thanks to contributors on the Crowdin project)
- Fixed:
- GUI: On some systems using Wayland, Ludusavi would crash on startup.
- When storing file modified times in zip archives, if the year is too old for zip to support (i.e., before 1980), Ludusavi will now round up to the earliest supported date (1980-01-01).
- When backing up a malformed
dword-type value from the registry, Ludusavi would silently convert it to a default 0, which could result in data loss when restored. Now, invalid registry values are backed up and restored as-is. - If Ludusavi encountered an error when restoring a specific file, it would retry up to 99 times in case it was just a temporary error. This was primarily intended to handle cases of duplicate backups that might cause a file to be busy, but it would also cause excessive delays for other, persistent errors. Now, Ludusavi will only try once per file.
- GUI: When a custom game was disabled, its refresh button would do nothing. The refresh button will now be disabled for that game.
v0.21.0 (2023-08-22)
- Added:
- GUI: Thanks to updates in Iced, there is now much better support for non-ASCII characters. This means that several translations are now properly supported: Simplified Chinese, Japanese, Korean, and Thai. Unfortunately, there are still technical limitations with Arabic, so that translation remains experimental via the config file.
- GUI: For custom games in scan results, you can click on the "custom" badge to jump to the corresponding entry.
- Changed:
- GUI: Rendering now uses DirectX/Vulkan/Metal instead of OpenGL. For systems that don't support those, there is a fallback software renderer as well.
- GUI: Ludusavi now bundles and uses the Noto Sans font for consistency, but some languages will still depend on your system fonts.
- Fixed:
- If an invalid manifest file were downloaded, Ludusavi would correctly show an error, but then after relaunching, it would get stuck on an "updating manifest" screen.
- On Linux, if Ludusavi were installed via Flatpak, then
XDG_CONFIG_HOMEandXDG_DATA_HOMEwould be set inside of the Flatpak environment, preventing it from finding some saves. Now, Ludusavi will also check the default paths (~/.configand~/.local/sharerespectively). - For Heroic roots, Ludusavi now also checks the
legendaryConfigfolder used by Heroic 1.9.0. - Saves associated with the Ubisoft Game Launcher folder were not detected on Linux when installed with Steam and Proton.
- On non-Windows systems, when recursively finding files in a directory, file/folder names containing a backslash would cause an error. For now, these files will be ignored until they are properly supported.
- When using shift+click on a path selector icon to browse the path, it will now handle some manifest
<placeholder>s. - In paths,
<storeUserId>next to*would trigger an error. - GUI: When switching screens and then expanding a section, the scroll position did not remain visually stable.
v0.20.0 (2023-07-10)
- Added:
- The restore screen now supports deselecting individual saves (like you already could on the backup screen).
- You can now use glob syntax for file paths in the "backup exclusions" section.
- CLI: Commands that take a list of games now support reading stdin (one game per line). For example,
ludusavi find --steam-id 504230 | ludusavi backup --preview. - CLI: The
findcommand will now report multiple results if you don't specify a name or ID. The command also has new options for filtering these results:--disabledand--partial. For example,ludusavi find --restore --disabledwill list all games that can be restored and are disabled. - Support for checking secondary/associated Steam IDs for a game. This is mainly useful for discovering Proton prefix folders of DLC, since DLC saves may be kept separately from base game saves. Specifically, this detection is based on the
steamExtrafield from the manifest. - A "custom" badge is shown next to custom games in scan results.
- Option to filter scan results by change status (new/updated/unchanged/unscanned). (Contributed by kekonn)
- For buttons that open a path selector dialog, shift+click will open the configured path in your file explorer.
- Fixed:
- When restoring registry saves, multi-string values would be restored as expandable string values, and expandable string values would be restored as multi-string values. This only affected the restore process; backups would still be correct. This issue was introduced in v0.18.0.
- For Lutris roots, the
<base>placeholder was resolved generically instead of using the Lutris-specific logic. - For Lutris roots, when inferring the
<base>from theexefield, Ludusavi assumed that the path would be absolute, but it could also be relative. Now, Ludusavi will combine theprefixandexefields if necessary.
- Changed:
- All path selectors now use the same icon.
- The button to find missing roots now uses a search icon instead of a refresh icon.
- Updated translations. (Thanks to contributors on the Crowdin project)
v0.19.0 (2023-06-02)
- Added:
-
On the restore screen, there is a "validate" button to check whether your backups are missing any files declared in their mapping.yaml. This is intended to help rectify a bug identified below.
-
Automatic detection of non-Flatpak Lutris roots (
~/.config/lutris). -
Updated translations. (Thanks to contributors on the Crowdin project)
A partial translation for Thai has been added, but it only has experimental support because of a technical limitation. You can enable it by editing the config file directly with language code
th-TH,
-
- Fixed:
-
If you had configured a backup-only or bidirectional redirect and you were using simple backups, then the first backup for a game would complete successfully, but a subsequent backup would fail because Ludusavi would mark the redirect target as a removed file.
-
If you had configured a backup-only or bidirectional redirect and you were using zip-based backups, then the redirected files would not be included in the backup.
You can check if this affects you by going to the restore screen and clicking the "validate" button. If it finds any issues, it will prompt you to make new full backups for the games in question.
-
Compatibility with Heroic 2.7.0+, which now uses
store_cache/gog_library.jsoninstead ofgog_store/library.json. -
For Lutris, the
game_slugfield is no longer required, since Ludusavi only uses it for logging when available. -
The Spanish and Russian translations were set incorrectly in the config file. If you selected Spanish, it would display normally, but the config file would be set to Russian. If you selected Russian and restarted the app, it would display in Japanese.
-
v0.18.2 (2023-05-21)
- Fixed:
- When a Lutris game file does not include the
game > working_dirfield, Ludusavi will now try to fall back to thegame > exefield and cut off the file name. Ludusavi will also log a more specific message when an expected field is missing.
- When a Lutris game file does not include the
v0.18.1 (2023-05-21)
- Fixed:
-
Cloud backups would fail if the cloud path contained a backslash (
\). -
On Windows, if the default terminal application was the Windows Terminal (as opposed to the older Windows Console Host), then a couple of problems would happen when Ludusavi was launched from Windows Explorer:
- An empty console window would stay open along with the GUI.
- Asynchronous Rclone commands would fail.
This was ultimately related to how Ludusavi hides the console in GUI mode. Now, instead of removing the console from the currently running instance, Ludusavi simply relaunches itself in a detached state.
-
v0.18.0 (2023-05-20)
- Added:
-
You can now upload backups to the cloud. This integrates with Rclone, so you can use any cloud system that it supports, and Ludusavi can help you configure some of the more common ones: Google Drive, OneDrive, Dropbox, Box, FTP servers, SMB servers, and WebDAV servers.
For the GUI, refer to the "cloud" section on the "other" screen. For the CLI, use the
cloudcommand group (e.g.,ludusavi cloud upload). -
The Lutris launcher is now supported as a root type. Ludusavi can find saves from Wine prefixes configured in Lutris.
-
The EA app is now supported as a root type.
-
On the restore screen, you can lock a backup so that it is kept indefinitely regardless of your retention settings.
-
Progress bars now show additional information (operation label, elapsed time, exact progress count).
-
Backups now record the operating system on which they were created. For the GUI, this is shown as a badge on the restore screen if you select a non-native backup. For the CLI, this is included in the output of the
backupscommand. -
Ludusavi now supports Flatpak IDs (if present in the manifest) in order to infer the correct
XDG_DATA_HOMEandXDG_CONFIG_HOME. At this time, the primary manifest does not specify Flatpak IDs for any games, but any such additions can be supported transparently in the future. -
GUI: You can use (shift+)tab to cycle through text fields.
-
GUI: Input fields show an error icon for paths like
http://andssh://since these are not supported and will be mangled into a local path. -
CLI: A standalone
manifest updatecommand.
-
- Changed:
-
The "merge" option has been removed, and merging is now always enforced. This option made sense before Ludusavi supported differential and cloud backups, but there was not much reason to turn off merging anymore.
The CLI
backupcommand's--merge/--no-mergeflags are now ignored and will be removed in a future release. -
CLI: The
backupcommand's--update/--try-updateflags are deprecated and will be removed in a future release. It was confusing because Ludusavi could still update the manifest without either flag, and other commands would also update the manifest but without equivalent flags to adjust the behavior.To simplify this and for consistency with the GUI, now the CLI will update the manifest automatically by default. To disable this, use the new
--no-manifest-updateglobal flag, which works across commands. To ignore errors in the update, use the new--try-manifest-updateglobal flag. -
CLI: The deprecated
--by-steam-idoption has been removed from thebackup,backups, andrestorecommands. You can use thefindcommand to replicate this functionality. -
CLI: Using
--apimode would silence some human-readable errors that would otherwise go on stderr. Since the API output itself goes on stdout, there's no harm leaving the other messages on stderr, so they are now allowed to print. In the future, these messages may be integrated into the API output directly. -
GUI: If you try to close the program while an operation is ongoing, Ludusavi will cancel the operation cleanly first before closing. To skip the cleanup and force an immediate close (like in previous versions), you can simply try to quit a second time, but this isn't recommended if you can help it.
-
GUI: Subsections now have a slightly distinct background color to help tell them apart.
-
GUI: Adjusted some spacing/padding. A few more scanned games can fit on screen now.
-
Log files now include timestamps.
-
Some obsolete fields were removed from the config file. This won't have any effect on you unless you were using a version older than v0.14.0. If so, then just update to v0.17.1 first so that Ludusavi can migrate the affected settings. Fields:
manifest.etag,backup.recentGames,restore.recentGames, andrestore.redirects. -
Some config fields weren't serialized if they matched the default value. Now they're serialized anyway in case the default value were to ever change. Fields:
backup.filter.excludeStoreScreenshots,scan.showDeselectedGames,scan.showUnchangedGames, andscan.showUnscannedGames. -
Updated translations. (Thanks to contributors on the Crowdin project)
-
- Fixed:
- Significantly improved performance of zip file extraction. Ludusavi had been unnecessarily reopening the zip for each file inside. In the most extreme case tested (40,864 files and 8.70 GB for a single game), the time was reduced from 12+ hours to 4 minutes.
- In secondary manifests, relative paths (beginning with
./and../) were not correctly resolved. - GUI: In some cases, the scroll position would be set incorrectly when changing screens or when closing a modal.
- CLI: A bare
manifestcommand was allowed, even though it did nothing. You can still usemanifest --helpfor subcommand info. - The log message "ignoring unrecognized Heroic game" could be recorded incorrectly when doing partial scans.