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

Warning for game developers: PCGamingWiki staff members will only ever reach out to you using the official press@pcgamingwiki.com mail address.
Be aware of scammers claiming to be representatives or affiliates of PCGamingWiki who promise a PCGW page for a game key.

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

From PCGamingWiki, the wiki about fixing PC games
(basic explanation)
 
(added vardefine override for example to skip cleanup detection)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
Specify each row with <code><nowiki>{{Game Location Table/row|</nowiki></code>. 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>%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|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.
−
 
 
−
Note that My Documents is always <code>%USERPROFILE%\My Documents</code> even though newer versions hide the "My"; do not use <code>%USERPROFILE%\Documents</code>.
 
  
 
==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 and use <code><nowiki>{{++}}</nowiki></code> and <code><nowiki>{{--}}</nowiki></code> appropriately; leave the XDG note out if you're unsure.
+
{{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 Location Table|
+
{{Game data|
−
{{Game Location Table/row|Save games (GOG.com)|C:\GOG Games\Fallout\DATA\SAVEGAME}}
+
{{Game data/saves|DOS|{{p|game}}\DATA\SAVEGAME}}
−
{{Game Location Table/row|Save games (Steam)|C:\Program Files (x86)\Steam\steamapps\common\fallout\DATA\SAVEGAME}}
 
 
}}
 
}}
 
</pre>
 
</pre>
  
−
This produces:
+
This produces:{{#vardefine:section|Game data/config}}
−
{{Game Location Table|
+
{{Game data|
−
{{Game Location Table/row|Save games (GOG.com)|C:\GOG Games\Fallout\DATA\SAVEGAME}}
+
{{Game data/saves|DOS|{{p|game}}\DATA\SAVEGAME}}
−
{{Game Location Table/row|Save games (Steam)|C:\Program Files (x86)\Steam\steamapps\common\fallout\DATA\SAVEGAME}}
 
 
}}
 
}}
 +
 +
<includeonly>[[Category:Table templates]]</includeonly>
 +
<noinclude>[[Category:Documentation templates]]</noinclude>

Latest revision as of 03:08, 27 August 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. %USERPROFILE%\Saved Games\, not C:\Users\your user name\Saved Games\) 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.
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|DOS|{{p|game}}\DATA\SAVEGAME}}
}}

This produces:

System Location
DOS <path-to-game>\DATA\SAVEGAME