Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.

Difference between revisions of "Template:Game data/Documentation"

From AppleGamingWiki, the wiki about gaming on M1 Apple silicon Macs
(d)
 
m (d)
 
(One intermediate revision by the same user not shown)
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|userprofile}}\Saved Games\</code>, not <code>C:\Users\your user name\Saved Games\</code>) since these will automatically expand when used to match the path on the user's end.
+
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==
 
{{ii}} Add a note if the folder path needs further explanation, e.g. [[Ultima Underworld: The Stygian Abyss]] has a <code>SAVE0</code> folder that isn't actually one of the user's save files.
 
{{ii}} Add a note if the folder path needs further explanation, e.g. [[Ultima Underworld: The Stygian Abyss]] has a <code>SAVE0</code> folder that isn't actually one of the user's save files.
{{ii}} If the game has a Linux version, specify whether it supports the XDG specification using the [[Template:XDG]].
 
  
 
==Example usage==
 
==Example usage==
 
<pre>
 
<pre>
 
{{Game data|
 
{{Game data|
{{Game data/saves|DOS|{{p|game}}\DATA\SAVEGAME}}
+
{{Game data/saves|macOS|{{p|macoshome}}/Library/Application Support/Borderlands The Pre-Sequel/WillowGame/Config/}}
 
}}
 
}}
 
</pre>
 
</pre>
Line 16: Line 15:
 
This produces:
 
This produces:
 
{{Game data|
 
{{Game data|
{{Game data/saves|DOS|{{p|game}}\DATA\SAVEGAME}}
+
{{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>

Latest revision as of 18:48, 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 SAVE0 folder that isn't actually one of the user's save files.

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/