Difference between revisions of "Template:Game data/Documentation"
From AppleGamingWiki, the wiki about gaming on M1 Apple silicon Macs
(d) |
m (d) |
||
| Line 1: | Line 1: | ||
Specify each row with <code><nowiki>{{Game data/config|</nowiki></code> (for configuration files) or <code><nowiki>{{Game data/saves|</nowiki></code> (for save game data). The first parameter is for the data type, the second parameter is the path. | Specify each row with <code><nowiki>{{Game data/config|</nowiki></code> (for configuration files) or <code><nowiki>{{Game data/saves|</nowiki></code> (for save game data). The first parameter is for the data type, the second parameter is the path. | ||
| − | Where possible use environmental variables instead of manual paths (e.g. <code>{{p| | + | Where possible use environmental variables instead of manual paths (e.g. <code>{{p|macoshome}}/Library/Application Support/<game>/</code>, not <code>/Users/{{p|uid}}/Library/Application Support/<game>/</code>) since these will automatically expand when used to match the path on the user's end. |
==Using notes== | ==Using notes== | ||
| Line 10: | Line 10: | ||
<pre> | <pre> | ||
{{Game data| | {{Game data| | ||
| − | {{Game data/saves| | + | {{Game data/saves|macOS|{{p|macoshome}}/Library/Application Support/Borderlands The Pre-Sequel/WillowGame/Config/}} |
}} | }} | ||
</pre> | </pre> | ||
| Line 16: | Line 16: | ||
This produces: | This produces: | ||
{{Game data| | {{Game data| | ||
| − | {{Game data/saves| | + | {{Game data/saves|macOS|{{p|macoshome}}/Library/Application Support/Borderlands The Pre-Sequel/WillowGame/Config/}} |
}} | }} | ||
<includeonly>[[Category:Table templates]]</includeonly> | <includeonly>[[Category:Table templates]]</includeonly> | ||
<noinclude>[[Category:Documentation templates]]</noinclude> | <noinclude>[[Category:Documentation templates]]</noinclude> | ||
Revision as of 18:47, 23 January 2021
Specify each row with {{Game data/config| (for configuration files) or {{Game data/saves| (for save game data). The first parameter is for the data type, the second parameter is the path.
Where possible use environmental variables instead of manual paths (e.g. $HOME/Library/Application Support/<game>/, not /Users/<user-id>/Library/Application Support/<game>/) since these will automatically expand when used to match the path on the user's end.
Using notes
- Add a note if the folder path needs further explanation, e.g. Ultima Underworld: The Stygian Abyss has a
SAVE0folder that isn't actually one of the user's save files. - If the game has a Linux version, specify whether it supports the XDG specification using the Template:XDG.
Example usage
{{Game data|
{{Game data/saves|macOS|{{p|macoshome}}/Library/Application Support/Borderlands The Pre-Sequel/WillowGame/Config/}}
}}
This produces:
| System | Location |
|---|---|
| macOS | $HOME/Library/Application Support/Borderlands The Pre-Sequel/WillowGame/Config/ |