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:Path/Documentation"

From PCGamingWiki, the wiki about fixing PC games
(added example)
(updated docs)
Line 1: Line 1:
 
;Description
 
;Description
−
Template for use with [[Template:Game data]].
+
Template for use with {{T|Game data}}.
  
 
;Syntax
 
;Syntax
Line 6: Line 6:
  
 
;Arguments
 
;Arguments
−
* {{Code|game}} - {{p|game}}
+
 
−
* {{Code|uid}} - {{p|uid}}
+
''General''
−
* {{Code|hkcu}} - {{p|hkcu}}
+
{| class="wikitable"
−
* {{Code|hklm}} - {{p|hklm}}
+
|-
−
* {{code|wow64}} - {{p|wow64}}
+
! Argument !! Result !! Location
−
* {{Code|userprofile}} - {{p|userprofile}}
+
|-
−
* {{Code|userprofile\documents}} - {{p|userprofile\documents}}
+
| {{code|game}} || {{p|game}} || The base installation folder
−
* {{Code|appdata}} - {{p|appdata}}
+
|-
−
* {{Code|localappdata}} - {{p|localappdata}}
+
| {{code|uid}} || {{p|uid}} || The user ID or profile name (specific to your account or computer).<br>Typically used to refer to Steam/Uplay/game-specific user ID or profile name.
−
* {{Code|public}} - {{p|public}}
+
|-
−
* {{Code|programdata}} - {{p|programdata}}
+
| {{code|steam}} || {{p|steam}} || The base Steam installation folder
−
* {{Code|windir}} - {{p|windir}}
+
|-
−
* {{Code|syswow64}} - {{p|syswow64}}
+
| {{code|uplay}} || {{p|uplay}} || The base Uplay (Ubisoft Game Launcher) installation folder
−
* {{Code|steam}} - {{p|steam}}
+
|-
−
* {{Code|uplay}} - {{p|uplay}}
+
|}
−
* {{code|osxhome}} - {{p|osxhome}}
+
 
−
* {{code|linuxhome}} - {{p|linuxhome}}
+
''Windows registry''
−
* {{code|xdgdatahome}} - {{p|xdgdatahome}}
+
{| class="wikitable"
−
* {{code|xdgconfighome}} - {{p|xdgconfighome}}
+
|-
 +
! Argument !! Result !! Location
 +
|-
 +
| {{code|hkcu}} || {{p|hkcu}} || HKEY_CURRENT_USER registry path
 +
|-
 +
| {{code|hklm}} || {{p|hklm}} || HKEY_LOCAL_MACHINE registry path
 +
|-
 +
| {{code|wow64}} || {{p|wow64}} || Used for 32-bit applications running on 64-bit operating systems
 +
|-
 +
|}
 +
 
 +
''Windows filesystem''
 +
{| class="wikitable"
 +
|-
 +
! Argument !! Result !! Location
 +
|-
 +
| {{code|username}} || {{p|username}} || Not a location, but resolves to the username in Windows
 +
|-
 +
| {{code|userprofile}} || {{p|userprofile}} || Base user profile folder
 +
|-
 +
| {{code|userprofile\documents}} || {{p|userprofile\documents}} || "Documents" folder
 +
|-
 +
| {{code|appdata}} || {{p|appdata}} || AppData\Roaming
 +
|-
 +
| {{code|localappdata}} || {{p|localappdata}} || AppData\Local
 +
|-
 +
| {{code|<nowiki>{{p|userprofile}}\AppData\LocalLow\</nowiki>}} || {{p|userprofile}}\AppData\LocalLow\ || AppData\LocalLow
 +
|-
 +
| {{code|public}} || {{p|public}} || Public (aka shared) user profile folder
 +
|-
 +
| {{code|allusersprofile}}<br>''or''<br>{{code|programdata}} || {{p|programdata}} || Program data folder
 +
|-
 +
| {{code|windir}} || {{p|windir}} || Windows directory
 +
|-
 +
| {{code|syswow64}} || {{p|syswow64}} || Stores 32-bit system libraries on 64-bit operating systems
 +
|-
 +
|}
 +
 
 +
''OS X''
 +
{| class="wikitable"
 +
|-
 +
! Argument !! Result !! Location
 +
|-
 +
| {{code|osxhome}} || {{p|osxhome}} || User home folder ~/
 +
|-
 +
|}
 +
 
 +
''Linux''
 +
{| class="wikitable"
 +
|-
 +
! Argument !! Result !! Location
 +
|-
 +
| {{code|linuxhome}} || {{p|linuxhome}} || User home folder ~/
 +
|-
 +
| {{code|xdgdatahome}} || {{p|xdgdatahome}} || ~/.local/share/
 +
|-
 +
| {{code|xdgconfighome}} || {{p|xdgconfighome}} || ~/.config/
 +
|-
 +
|}
  
 
;Redirects
 
;Redirects

Revision as of 17:51, 7 January 2020

Description

Template for use with {{Game data}}.

Syntax

{{p|localappdata}} produces %LOCALAPPDATA%

Arguments

General

Argument Result Location
game <path-to-game> The base installation folder
uid <user-id> The user ID or profile name (specific to your account or computer).
Typically used to refer to Steam/Uplay/game-specific user ID or profile name.
steam <Steam-folder> The base Steam installation folder
uplay <Ubisoft-Connect-folder> The base Uplay (Ubisoft Game Launcher) installation folder

Windows registry

Argument Result Location
hkcu HKEY_CURRENT_USER HKEY_CURRENT_USER registry path
hklm HKEY_LOCAL_MACHINE HKEY_LOCAL_MACHINE registry path
wow64 Wow6432Node Used for 32-bit applications running on 64-bit operating systems

Windows filesystem

Argument Result Location
username %USERNAME% Not a location, but resolves to the username in Windows
userprofile %USERPROFILE% Base user profile folder
userprofile\documents %USERPROFILE%\Documents "Documents" folder
appdata %APPDATA% AppData\Roaming
localappdata %LOCALAPPDATA% AppData\Local
{{p|userprofile}}\AppData\LocalLow\ %USERPROFILE%\AppData\LocalLow\ AppData\LocalLow
public %PUBLIC% Public (aka shared) user profile folder
allusersprofile
or
programdata		 %PROGRAMDATA% Program data folder
windir %WINDIR% Windows directory
syswow64 SysWOW64 Stores 32-bit system libraries on 64-bit operating systems

OS X

Argument Result Location
osxhome $HOME User home folder ~/

Linux

Argument Result Location
linuxhome $HOME User home folder ~/
xdgdatahome $XDG_DATA_HOME ~/.local/share/
xdgconfighome $XDG_CONFIG_HOME ~/.config/
Redirects