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
m (Template primarily intended for {{T|Game data}} but can also be used with {{T|File}} and {{T|Folder}}.)
m (added {{Registry}})
Line 1: Line 1:
 
;Description
 
;Description
Template primarily intended for {{T|Game data}} but can also be used with {{T|File}} and {{T|Folder}}. See [[PCGamingWiki:Editing guide/Game data#Popular file locations|the editing guide]] for real-world paths and examples.
+
Template primarily intended for {{T|Game data}} but can also be used with {{T|File}}, {{T|Folder}}, and {{T|Registry}}.
 +
See [[PCGamingWiki:Editing guide/Game data#Popular file locations|the editing guide]] for real-world paths and examples.
  
 
;Syntax
 
;Syntax

Revision as of 23:09, 8 January 2023

Description

Template primarily intended for {{Game data}} but can also be used with {{File}}, {{Folder}}, and {{Registry}}. See the editing guide for real-world paths and examples.

Syntax

{{Path|localappdata}} or {{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/Ubisoft Connect/game-specific user ID or profile name.
steam <Steam-folder> The base Steam installation folder
ubisoftconnect <Ubisoft-Connect-folder> The base Ubisoft Connect (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
userprofile\appdata\locallow %USERPROFILE%\AppData\LocalLow AppData\LocalLow
public %PUBLIC% Public (aka shared) user profile folder
allusersprofile
or
programdata
%PROGRAMDATA% Program data folder
programfiles %PROGRAMFILES% Shared applications folder. Use <path-to-game> instead.
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
  • {{P}}