Release v0.4.0

CHANGELOG.md

@@ -1,13 +1,13 @@
-## Unreleased
+## v0.4.0 (2020-07-21)
 
 * Added the ability to select and deselect specific games.
 * Added the ability to restore to different folders via redirects.
 * Added indicators for how much disk space is used by the files.
 * Added indicators in the GUI when files fail to process.
 * Added a browse button for folders.
 * Replaced the "=> Restore" and "=> Backup" buttons with a navigation bar.
-* Redesigned confirmation and error screens so that the buttons are shown below
-  the text, which helps to prevent any accidental clicks before reading.
+* Redesigned the confirmation and error screens so that the buttons are shown
+  below the text, which helps to prevent any accidental clicks before reading.
 * Narrowed how Steam IDs are substituted in paths to avoid false positives.
 * Fixed an issue where restore mode in the GUI would get stuck showing an
   "in progress" state if the source path had no subdirectories.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ludusavi"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["mtkennerly <mtkennerly@gmail.com>"]
 edition = "2018"
 description = "Game save backup tool"

README.md

@@ -94,9 +94,14 @@ Run `ludusavi --help` for the full usage information.
     what you choose as the "install location" for your games (e.g., if you choose
     `D:/Epic` and it creates a subfolder for `D:/Epic/Celeste`, then the root
     would be `D:/Epic`).
+* To select/deselect specific games, you can run a preview, then click the
+  checkboxes by each game. You can also press the `deselect all` button
+  (when all games are selected) or the `select all` button (when at least
+  one game is deselected) to quickly toggle all of them at once.
+  Ludusavi will remember your most recent checkbox settings.
 
 #### Restore mode
-* Switch to restore mode by clicking the `=> restore` button.
+* Switch to restore mode by clicking the `restore mode` button.
 * You can press `preview` to see what the restore will include,
   without actually performing it.
 * You can press `restore` to perform the restore for real.
@@ -105,6 +110,16 @@ Run `ludusavi --help` for the full usage information.
     parent directories will be created as well before the copy, but if the
     directories already exist, their current files will be left alone (other
     than overwriting the ones that are being restored from the backup).
+* You can use redirects to restore to a different location than the original file.
+  Click `add redirect`, and then enter both the old and new location. For example,
+  if you backed up some saves from `C:/Games`, but then you moved it to `D:/Games`,
+  then you would put `C:/Games` as the source and `D:/Games` as the target.
+
+  Tip: As you're editing your redirects, try running a preview and expanding some
+  games' file lists. This will show you in real time what effect your redirects
+  will have when you perform the restore for real.
+* You can select/deselect specific games in restore mode just like you can in
+  backup mode. The checkbox settings are remembered separately for both modes.
 
 ### Configuration
 Ludusavi stores its configuration in `~/.config/ludusavi` (Windows: `C:/Users/<your-name>/.config/ludusavi`).
@@ -130,8 +145,12 @@ Here are the available settings (all are required unless otherwise noted):
 * `restore` (map):
   * `path` (string): Full path to a directory from which to restore data.
     This can be overridden in the CLI with `--path`.
-  * `ignoredGames` (optional, array of strings): Names of games to skip when restoring.
+  * `ignoredGames` (optional, list of strings): Names of games to skip when restoring.
     This can be overridden in the CLI by passing a list of games.
+  * `redirects` (optional, list):
+    * Each entry in the list should be a map with these fields:
+      * `source` (string): The original location when the backup was performed.
+      * `target` (string): The new location.
 
 Example: