Conor425/ludusavi-manifest
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add winDocuments placeholder

Browse source
This commit is contained in:
mtkennerly 2020-06-29 06:21:39 -04:00
parent d715380e0b
commit 71bff495f5
6 changed files with 141 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -64,23 +64,24 @@ This means:
Paths can include these placeholders: Paths can include these placeholders:
| placeholder | meaning | | placeholder | meaning |
|---------------------|---------------------------------------------------------------------------| |---------------------|----------------------------------------------------------------------------------------|
| `<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>` |
| `<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 |
| `<winAppData>` | `%APPDATA%` on Windows | | `<winAppData>` | `%APPDATA%` on Windows |
| `<winLocalAppData>` | `%LOCALAPPDATA%` on Windows | | `<winLocalAppData>` | `%LOCALAPPDATA%` on Windows |
| `<winPublic>` | `%PUBLIC%` on Windows | | `<winDocuments>` | `<home>/Documents` (f.k.a. `<home>/My Documents`) or a localized equivalent on Windows |
| `<winProgramData>` | `%PROGRAMDATA%` on Windows | | `<winPublic>` | `%PUBLIC%` on Windows |
| `<winDir>` | `%WINDIR%` on Windows | | `<winProgramData>` | `%PROGRAMDATA%` on Windows |
| `<xdgData>` | `$XDG_DATA_HOME` on Linux | | `<winDir>` | `%WINDIR%` on Windows |
| `<xdgConfig>` | `$XDG_CONFIG_HOME` on Linux | | `<xdgData>` | `$XDG_DATA_HOME` on Linux |
| `<regHkcu>` | `HKEY_CURRENT_USER` in the Windows registry | | `<xdgConfig>` | `$XDG_CONFIG_HOME` on Linux |
| `<regHklm>` | `HKEY_LOCAL_MACHINE` in the Windows registry | | `<regHkcu>` | `HKEY_CURRENT_USER` in the Windows registry |
| `<regHklm>` | `HKEY_LOCAL_MACHINE` in the Windows registry |
## Implementation ## Implementation
Tools must implement the following in addition to respecting the schema: Tools must implement the following in addition to respecting the schema:

144
data/manifest.yaml
View file

@ -130,11 +130,6 @@ $1 Ride:
id: 525480 id: 525480
0 A.D.: 0 A.D.:
files: files:
<home>/Documents/My Games/0ad:
tags:
- save
when:
- os: windows
<home>/Library/Application/ Support/0ad: <home>/Library/Application/ Support/0ad:
tags: tags:
- save - save
@ -145,6 +140,11 @@ $1 Ride:
- config - config
when: when:
- os: windows - os: windows
<winDocuments>/My Games/0ad:
tags:
- save
when:
- os: windows
<xdgConfig>/0ad: <xdgConfig>/0ad:
tags: tags:
- config - config
@ -165,7 +165,7 @@ $1 Ride:
id: 639880 id: 639880
007 Legends: 007 Legends:
files: files:
<home>/Documents/My Games/Activision/007 Legends: <winDocuments>/My Games/Activision/007 Legends:
tags: tags:
- save - save
when: when:
@ -508,18 +508,18 @@ $1 Ride:
id: 970890 id: 970890
1001 Spikes: 1001 Spikes:
files: files:
<home>/Documents/My Games/1001 Spikes:
tags:
- config
- save
when:
- os: windows
<home>/Library/Application Support/1001 Spikes: <home>/Library/Application Support/1001 Spikes:
tags: tags:
- config - config
- save - save
when: when:
- os: mac - os: mac
<winDocuments>/My Games/1001 Spikes:
tags:
- config
- save
when:
- os: windows
<xdgData>/1001 spikes: <xdgData>/1001 spikes:
tags: tags:
- config - config
@ -890,12 +890,12 @@ $1 Ride:
id: 855320 id: 855320
'18 Wheels of Steel: Across America': '18 Wheels of Steel: Across America':
files: files:
<home>/Documents/18 WoS Across America/config.cfg: <winDocuments>/18 WoS Across America/config.cfg:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS Across America/saves: <winDocuments>/18 WoS Across America/saves:
tags: tags:
- save - save
when: when:
@ -906,12 +906,12 @@ $1 Ride:
id: 514160 id: 514160
'18 Wheels of Steel: American Long Haul': '18 Wheels of Steel: American Long Haul':
files: files:
<home>/Documents/18 WoS American Long Haul: <winDocuments>/18 WoS American Long Haul:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS American Long Haul/save: <winDocuments>/18 WoS American Long Haul/save:
tags: tags:
- save - save
when: when:
@ -922,12 +922,12 @@ $1 Ride:
id: 12520 id: 12520
'18 Wheels of Steel: Convoy': '18 Wheels of Steel: Convoy':
files: files:
<home>/Documents/18 WoS Convoy: <winDocuments>/18 WoS Convoy:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS Convoy/save: <winDocuments>/18 WoS Convoy/save:
tags: tags:
- save - save
when: when:
@ -938,12 +938,12 @@ $1 Ride:
id: 514170 id: 514170
'18 Wheels of Steel: Extreme Trucker': '18 Wheels of Steel: Extreme Trucker':
files: files:
<home>/Documents/18 WoS Extreme Trucker: <winDocuments>/18 WoS Extreme Trucker:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS Extreme Trucker/profile##: <winDocuments>/18 WoS Extreme Trucker/profile##:
tags: tags:
- save - save
when: when:
@ -954,12 +954,12 @@ $1 Ride:
id: 33730 id: 33730
'18 Wheels of Steel: Extreme Trucker 2': '18 Wheels of Steel: Extreme Trucker 2':
files: files:
<home>/Documents/18 WoS Extreme Trucker 2: <winDocuments>/18 WoS Extreme Trucker 2:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS Extreme Trucker 2/profile##: <winDocuments>/18 WoS Extreme Trucker 2/profile##:
tags: tags:
- save - save
when: when:
@ -970,12 +970,12 @@ $1 Ride:
id: 362780 id: 362780
'18 Wheels of Steel: Haulin''': '18 Wheels of Steel: Haulin''':
files: files:
<home>/Documents/18 WoS Haulin: <winDocuments>/18 WoS Haulin:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS Haulin/save: <winDocuments>/18 WoS Haulin/save:
tags: tags:
- save - save
when: when:
@ -986,12 +986,12 @@ $1 Ride:
id: 514180 id: 514180
'18 Wheels of Steel: Pedal to the Metal': '18 Wheels of Steel: Pedal to the Metal':
files: files:
<home>/Documents/18 WoS Pedal to the Metal/config.cfg: <winDocuments>/18 WoS Pedal to the Metal/config.cfg:
tags: tags:
- config - config
when: when:
- os: windows - os: windows
<home>/Documents/18 WoS Pedal to the Metal/saves: <winDocuments>/18 WoS Pedal to the Metal/saves:
tags: tags:
- save - save
when: when:
@ -1279,6 +1279,22 @@ Celeste:
Celeste: {} Celeste: {}
steam: steam:
id: 504230 id: 504230
Dark Souls III:
files:
<winAppData>/DarkSoulsIII/<storeUserId>:
tags:
- save
when:
- os: windows
<winAppData>/DarkSoulsIII/GraphicsConfig.xml:
tags:
- config
when:
- os: windows
installDir:
DARK SOULS III: {}
steam:
id: 374320
Lone Survivor: Lone Survivor:
files: files:
<base>/LoneSurvivor/META-INF/AIR: <base>/LoneSurvivor/META-INF/AIR:
@ -1317,11 +1333,6 @@ Prey:
- save - save
when: when:
- os: linux - os: linux
<home>/Documents/My Games/PREY/base:
tags:
- save
when:
- os: windows
<home>/Library/Application Support/Prey/base: <home>/Library/Application Support/Prey/base:
tags: tags:
- config - config
@ -1332,6 +1343,11 @@ Prey:
- save - save
when: when:
- os: mac - os: mac
<winDocuments>/My Games/PREY/base:
tags:
- save
when:
- os: windows
installDir: installDir:
Prey 2006: {} Prey 2006: {}
steam: steam:
@ -1352,3 +1368,69 @@ Prey (2017):
Prey: {} Prey: {}
steam: steam:
id: 480490 id: 480490
Stardew Valley:
files:
<home>/.config/StardewValley:
tags:
- config
when:
- os: mac
<home>/.config/StardewValley/Saves:
tags:
- save
when:
- os: mac
<winAppData>/StardewValley:
tags:
- config
when:
- os: windows
<winAppData>/StardewValley/Saves:
tags:
- save
when:
- os: windows
<xdgConfig>/StardewValley:
tags:
- config
when:
- os: linux
<xdgConfig>/StardewValley/Saves:
tags:
- save
when:
- os: linux
installDir:
Stardew Valley: {}
steam:
id: 413150
Undertale:
files:
<home>/.config/UNDERTALE_linux_steamver:
tags:
- config
- save
when:
- os: linux
<home>/Library/Application Support/com.tobyfox.undertale:
tags:
- config
- save
when:
- os: mac
<root>/userdata/<storeUserId>/391540/remote:
tags:
- config
- save
when:
- store: steam
<winLocalAppData>/UNDERTALE:
tags:
- config
- save
when:
- os: windows
installDir:
Undertale: {}
steam:
id: 391540

3
data/missing.md
View file

@ -8811,7 +8811,6 @@
* [Dark Snow](https://www.pcgamingwiki.com/wiki/?curid=75526) * [Dark Snow](https://www.pcgamingwiki.com/wiki/?curid=75526)
* [Dark Souls II](https://www.pcgamingwiki.com/wiki/?curid=15753) * [Dark Souls II](https://www.pcgamingwiki.com/wiki/?curid=15753)
* [Dark Souls II: Scholar of the First Sin](https://www.pcgamingwiki.com/wiki/?curid=24344) * [Dark Souls II: Scholar of the First Sin](https://www.pcgamingwiki.com/wiki/?curid=24344)
* [Dark Souls III](https://www.pcgamingwiki.com/wiki/?curid=30153)
* [Dark Souls Remastered](https://www.pcgamingwiki.com/wiki/?curid=80167) * [Dark Souls Remastered](https://www.pcgamingwiki.com/wiki/?curid=80167)
* [Dark Souls: Prepare to Die Edition](https://www.pcgamingwiki.com/wiki/?curid=3367) * [Dark Souls: Prepare to Die Edition](https://www.pcgamingwiki.com/wiki/?curid=3367)
* [Dark Space Conqueror](https://www.pcgamingwiki.com/wiki/?curid=136958) * [Dark Space Conqueror](https://www.pcgamingwiki.com/wiki/?curid=136958)
@ -33942,7 +33941,6 @@
* [StarCrawlers](https://www.pcgamingwiki.com/wiki/?curid=34362) * [StarCrawlers](https://www.pcgamingwiki.com/wiki/?curid=34362)
* [Starcross Arena](https://www.pcgamingwiki.com/wiki/?curid=122142) * [Starcross Arena](https://www.pcgamingwiki.com/wiki/?curid=122142)
* [StarCrossed](https://www.pcgamingwiki.com/wiki/?curid=128722) * [StarCrossed](https://www.pcgamingwiki.com/wiki/?curid=128722)
* [Stardew Valley](https://www.pcgamingwiki.com/wiki/?curid=31535)
* [Stardrift Nomads](https://www.pcgamingwiki.com/wiki/?curid=59093) * [Stardrift Nomads](https://www.pcgamingwiki.com/wiki/?curid=59093)
* [StarDrive](https://www.pcgamingwiki.com/wiki/?curid=6102) * [StarDrive](https://www.pcgamingwiki.com/wiki/?curid=6102)
* [StarDrive 2](https://www.pcgamingwiki.com/wiki/?curid=24558) * [StarDrive 2](https://www.pcgamingwiki.com/wiki/?curid=24558)
@ -40157,7 +40155,6 @@
* [UnderParty](https://www.pcgamingwiki.com/wiki/?curid=154116) * [UnderParty](https://www.pcgamingwiki.com/wiki/?curid=154116)
* [Underrail](https://www.pcgamingwiki.com/wiki/?curid=6710) * [Underrail](https://www.pcgamingwiki.com/wiki/?curid=6710)
* [Underspace](https://www.pcgamingwiki.com/wiki/?curid=142204) * [Underspace](https://www.pcgamingwiki.com/wiki/?curid=142204)
* [Undertale](https://www.pcgamingwiki.com/wiki/?curid=28770)
* [Underture](https://www.pcgamingwiki.com/wiki/?curid=141035) * [Underture](https://www.pcgamingwiki.com/wiki/?curid=141035)
* [UnderWater Adventure](https://www.pcgamingwiki.com/wiki/?curid=42786) * [UnderWater Adventure](https://www.pcgamingwiki.com/wiki/?curid=42786)
* [Underwater Affect](https://www.pcgamingwiki.com/wiki/?curid=123409) * [Underwater Affect](https://www.pcgamingwiki.com/wiki/?curid=123409)

6
data/steam-game-cache.yaml
View file

@ -114,10 +114,14 @@
installDir: 18 WoS Extreme Trucker 2 installDir: 18 WoS Extreme Trucker 2
'368000': '368000':
installDir: 100ft Robot Golf installDir: 100ft Robot Golf
'374320':
installDir: DARK SOULS III
'375460': '375460':
installDir: 16bittrader installDir: 16bittrader
'389120': '389120':
installDir: 10 Minute Barbarian installDir: 10 Minute Barbarian
'391540':
installDir: Undertale
'396800': '396800':
installDir: 12 Labours of Hercules IV Mother Nature installDir: 12 Labours of Hercules IV Mother Nature
'3970': '3970':
@ -128,6 +132,8 @@
installDir: 1000 Heads Among the Trees installDir: 1000 Heads Among the Trees
'410110': '410110':
installDir: 12 is Better Than 6 installDir: 12 is Better Than 6
'413150':
installDir: Stardew Valley
'413480': '413480':
installDir: 101 Ways to Die installDir: 101 Ways to Die
'414510': '414510':

6
data/wiki-game-cache.yaml
View file

@ -26727,7 +26727,7 @@ Dark Souls II:
revId: null revId: null
Dark Souls III: Dark Souls III:
pageId: 30153 pageId: 30153
revId: null revId: 971498
Dark Souls Remastered: Dark Souls Remastered:
pageId: 80167 pageId: 80167
revId: null revId: null
@ -102064,7 +102064,7 @@ Starcross Arena:
revId: null revId: null
Stardew Valley: Stardew Valley:
pageId: 31535 pageId: 31535
revId: null revId: 962956
Stardrift Nomads: Stardrift Nomads:
pageId: 59093 pageId: 59093
revId: null revId: null
@ -120634,7 +120634,7 @@ Underspace:
revId: null revId: null
Undertale: Undertale:
pageId: 28770 pageId: 28770
revId: null revId: 971737
Underture: Underture:
pageId: 141035 pageId: 141035
revId: null revId: null

2
src/importer.ts
View file

@ -117,7 +117,7 @@ const PATH_ARGS: { [arg: string]: { mapped: string, when?: Constraint, registry?
when: { os: "windows" }, when: { os: "windows" },
}, },
"userprofile\\documents": { "userprofile\\documents": {
mapped: "<home>/Documents", mapped: "<winDocuments>",
when: { os: "windows" }, when: { os: "windows" },
}, },
appdata: { appdata: {