Skip to content

Commit

Permalink
Use semantic line breaks in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Dec 9, 2023
1 parent 575c348 commit 950f319
Showing 1 changed file with 34 additions and 30 deletions.
64 changes: 34 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ludusavi for Playnite
This project is a [Playnite](https://playnite.link) plugin to
back up your save data using [Ludusavi](https://github.com/mtkennerly/ludusavi).
This project is a [Playnite](https://playnite.link) plugin
to back up your save data using [Ludusavi](https://github.com/mtkennerly/ludusavi).

## Features
* Known save locations for more than 10,000 games.
Expand All @@ -10,8 +10,8 @@ back up your save data using [Ludusavi](https://github.com/mtkennerly/ludusavi).

The [info on what to back up](https://github.com/mtkennerly/ludusavi-manifest)
is ultimately sourced from [PCGamingWiki](https://www.pcgamingwiki.com/wiki/Home),
so please contribute any new or fixed data back to the wiki itself, and your
improvements will be incorporated into Ludusavi's data as well.
so please contribute any new or fixed data back to the wiki itself,
and your improvements will be incorporated into Ludusavi's data as well.

If you'd like to help translate this plugin into other languages,
[check out the Crowdin project](https://crowdin.com/project/ludusavi-playnite).
Expand All @@ -23,9 +23,8 @@ for instructions on how to install Ludusavi itself.
Ludusavi 0.16.0 or newer is recommended for full functionality,
but version 0.7.0 or newer will work (albeit without some features enabled).

By default, the plugin will look for the Ludusavi executable in your `PATH`
environment variable, but you can also configure the plugin with the full
path to the executable.
By default, the plugin will look for the Ludusavi executable in your `PATH` environment variable,
but you can also configure the plugin with the full path to the executable.

### Plugin
You can download the plugin from the
Expand All @@ -42,9 +41,10 @@ There are two ways to install it:

### Configuration
The plugin provides some of its own configuration (see the screenshots below),
but you'll also need to open Ludusavi to configure it as needed. For example,
at this time, the plugin is not able to tell Ludusavi about your Playnite
library sources, so you'll need to configure Ludusavi's roots separately.
but you'll also need to open Ludusavi to configure it as needed.
For example, at this time,
the plugin is not able to tell Ludusavi about your Playnite library sources,
so you'll need to configure Ludusavi's roots separately.

Behavior can be overridden for specific games by using tags:

Expand All @@ -60,8 +60,9 @@ Behavior can be overridden for specific games by using tags:
| `[Ludusavi] Platform: no backup` | | | No | No |
| `[Ludusavi] Platform: no restore` | | | | No |

For example, if the global backup-after-play option is enabled, but a game is
marked with `[Ludusavi] Skip`, then it will not be backed up after play.
For example, if the global backup-after-play option is enabled,
but a game is marked with `[Ludusavi] Skip`,
then it will not be backed up after play.
However, the game will still be included when doing a full backup of all games from the menu.

`[Ludusavi] Skip` takes precedence over the other tags,
Expand Down Expand Up @@ -90,10 +91,12 @@ The following tags are only informational and do not have special behavior:
## Other notes
* The backup and restore operations run in the background after you start them.
You'll get a notification in Playnite when they finish. If you try to start
another operation before the first one finishes, you'll have to wait.
You'll get a notification in Playnite when they finish.
If you try to start another operation before the first one finishes,
you'll have to wait.
* When processing specific games via the context menu,
the plugin will try to look them up a few ways, in this order of precedence:
the plugin will try to look them up a few ways,
in this order of precedence:

* Steam ID (if applicable)
* Title
Expand All @@ -106,23 +109,24 @@ The following tags are only informational and do not have special behavior:
then the notification will include `Playnite Title (↪ Ludusavi Title)`.
* After doing a full backup/restore of all games, you can click the notification to see the list.
There, "+" denotes a newly found game, and "Δ" denotes a game whose saves have changed.
* For backups, the plugin always sets Ludusavi's `--merge` flag. This way,
if you back up saves for one game, it will not interfere with any backups
you may have for another game.
* Although Ludusavi only knows about PC games by default, you can add custom
entries in Ludusavi for non-PC games if you'd like. The plugin provides a
setting to either look up those custom entries by the game's name on its own
or with a suffix, in case you need multiple custom entries for the same game
name on different platforms.

Within the suffix, you can write `<platform>` and it will be replaced by
the actual platform name. For example, if you enable the default suffix and
you'd like a custom entry for `Some Game` on Nintendo 64, then in Ludusavi
you would create a custom entry called `Some Game (Nintendo 64)`.
* For backups, the plugin always sets Ludusavi's `--merge` flag.
This way, if you back up saves for one game,
it will not interfere with any backups you may have for another game.
* Although Ludusavi only knows about PC games by default,
you can add custom entries in Ludusavi for non-PC games if you'd like.
The plugin provides a setting to either look up those custom entries
by the game's name on its own or with a suffix,
in case you need multiple custom entries for the same game name on different platforms.

Within the suffix, you can write `<platform>`
and it will be replaced by the actual platform name.
For example, if you enable the default suffix
and you'd like a custom entry for `Some Game` on Nintendo 64,
then in Ludusavi you would create a custom entry called `Some Game (Nintendo 64)`.
* If you want a single custom entry for all games on a particular non-PC platform
(such as when all of the saves for that platform are in a single memory card file),
you can enable the "back up save data by platform name" setting. You will just need
to create a custom entry in Ludusavi with the same name as the platform.
you can enable the "back up save data by platform name" setting.
You will just need to create a custom entry in Ludusavi with the same name as the platform.

## Development
Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).

0 comments on commit 950f319

Please sign in to comment.