Change default <base> rules to limit wasteful searching

This commit is contained in:
mtkennerly 2020-06-29 19:13:14 -04:00
parent 71bff495f5
commit babf173b78

View file

@ -68,7 +68,7 @@ Paths can include these placeholders:
|---------------------|----------------------------------------------------------------------------------------| |---------------------|----------------------------------------------------------------------------------------|
| `<root>` | a directory where games are installed (configured in backup tool) | | `<root>` | a directory where games are installed (configured in backup tool) |
| `<game>` | an `installDir` (if defined) or the game's canonical name in the manifest | | `<game>` | an `installDir` (if defined) or the game's canonical name in the manifest |
| `<base>` | shorthand for `<root>/**/<game>` | | `<base>` | shorthand for `<root>/<game>` (unless overridden by store-specific rules) |
| `<home>` | current user's home directory in the OS (`~`) | | `<home>` | current user's home directory in the OS (`~`) |
| `<storeUserId>` | current user's ID in the game store | | `<storeUserId>` | current user's ID in the game store |
| `<osUserName>` | current user's name in the OS | | `<osUserName>` | current user's name in the OS |
@ -100,8 +100,10 @@ Tools must implement the following in addition to respecting the schema:
Tools may also: Tools may also:
* Use store-specific logic to narrow down the `**` in `<base>`. For example, * Use store-specific logic to determine the `<base>`. For example,
with Steam, it would be `<root>/steamapps/common/<game>`. with Steam, if the root is `~/.steam/steam`, then `<base>` would be
`<root>/steamapps/common/<game>`. Or a tool could use `<root>/**/<game>`
as a generic option, although it could lead to wasted search time.
The latest version of the primary manifest can be downloaded from The latest version of the primary manifest can be downloaded from
https://raw.githubusercontent.com/mtkennerly/ludusavi-manifest/master/data/manifest.yaml . https://raw.githubusercontent.com/mtkennerly/ludusavi-manifest/master/data/manifest.yaml .