Skip to content

Commit

Permalink
Release v0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Jul 26, 2020
1 parent 84f765b commit 2d63987
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Unreleased
## v0.5.0 (2020-07-25)

* Added:
* Support for custom games.
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ludusavi"
version = "0.4.0"
version = "0.5.0"
authors = ["mtkennerly <mtkennerly@gmail.com>"]
edition = "2018"
description = "Game save backup tool"
Expand Down
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ to that project. Data is ultimately sourced from [PCGamingWiki](https://www.pcga
so you are encouraged to contribute any new or fixed data back to the wiki itself.

## Features
* Ability to back up data from more than 7,000 games<!-- plus your own custom entries -->.
* Ability to back up data from more than 7,000 games plus your own custom entries.
* Backup and restore for Steam as well as other game libraries.
* Preview of the backup/restore before actually performing it.
* Both a graphical interface and command line interface for scripting.
Expand Down Expand Up @@ -75,7 +75,8 @@ Run `ludusavi --help` for the full usage information.
* If the target folder already exists, it will be deleted first,
then recreated.
* Within the target folder, for every game with data to back up,
a subfolder will be created with the game's name encoded as Base64.
a subfolder will be created with the game's name encoded as
[Base64](https://en.wikipedia.org/wiki/Base64).
For example, files for `Celeste` would go into a folder named `Q2VsZXN0ZQ==`.
* Within each game's backup folder, any relevant files will be stored with
their name as the Base64 encoding of the full path to the original file.
Expand Down Expand Up @@ -125,13 +126,12 @@ Run `ludusavi --help` for the full usage information.
* 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.

<!--
#### Custom games
* Switch to this mode by clicking the `custom games` button.
* You can click `add game` to add entries for as many games as you like.
Within each game's entry, you can click `add path` for files/directories
or `add registry` for registry keys.
* For paths, you can use the `browse` button to quickly select a folder.
Within each game's entry, you can click the plus icons to add paths
(files or directories) and registry keys.
* For paths, you can click the browse button to quickly select a folder.
The path can be a file too, but the browse button only lets you choose
folders at this time. You can just type in the file name afterwards.
* In addition to regular paths, you can also use
Expand All @@ -144,7 +144,6 @@ Run `ludusavi --help` for the full usage information.

If the game name matches one from Ludusavi's primary data set, then your
custom entry will override it.
-->

### Configuration
Ludusavi stores its configuration in `~/.config/ludusavi` (Windows: `C:/Users/<your-name>/.config/ludusavi`).
Expand Down Expand Up @@ -176,14 +175,12 @@ Here are the available settings (all are required unless otherwise noted):
* 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.
<!--
* `customGames` (optional, list):
* Each entry in the list should be a map with these fields:
* `name` (string): Name of the game.
* `files` (optional, list of strings): Any files or directories you want
to back up.
* `registry` (optional, list of strings): Any registry keys you want to back up.
-->

Example:

Expand Down
Binary file modified docs/demo-cli.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/demo-gui.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2d63987

Please sign in to comment.