Difference between revisions of "Template:Path"
From PCGamingWiki, the wiki about fixing PC games
m (added ~/ to the osxhome and linuxhome abbr) |
m (D -> d) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly>{{#switch:{{lc:{{{1}}}}} | <includeonly>{{#switch:{{lc:{{{1}}}}} | ||
− | |||
<!-- General --> | <!-- General --> | ||
|game = [[Glossary:Game data#Installation folder|{{Abbr|<path-to-game>|The base installation folder|template=yes}}]]{{#vardefine:Game data note|gamedir}} | |game = [[Glossary:Game data#Installation folder|{{Abbr|<path-to-game>|The base installation folder|template=yes}}]]{{#vardefine:Game data note|gamedir}} | ||
Line 6: | Line 5: | ||
|steam = [[Glossary:Game data#Steam|{{Abbr|<Steam-folder>|The base Steam installation folder|template=yes}}]] | |steam = [[Glossary:Game data#Steam|{{Abbr|<Steam-folder>|The base Steam installation folder|template=yes}}]] | ||
|uplay = [[Glossary:Game data#Uplay|{{Abbr|<Uplay-folder>|The base Uplay (Ubisoft Game Launcher) installation folder|template=yes}}]] | |uplay = [[Glossary:Game data#Uplay|{{Abbr|<Uplay-folder>|The base Uplay (Ubisoft Game Launcher) installation folder|template=yes}}]] | ||
− | |||
<!-- Windows > Registry --> | <!-- Windows > Registry --> | ||
|hkey_current_user | |hkey_current_user | ||
Line 12: | Line 10: | ||
|hkey_local_machine | |hkey_local_machine | ||
|hklm = [[Glossary:Game data#Windows registry|{{Abbr|HKEY_LOCAL_MACHINE|Windows Registry path (use the Registry Editor to access)|template=yes}}]]{{#vardefine:Game data note|hklm}} | |hklm = [[Glossary:Game data#Windows registry|{{Abbr|HKEY_LOCAL_MACHINE|Windows Registry path (use the Registry Editor to access)|template=yes}}]]{{#vardefine:Game data note|hklm}} | ||
− | + | |wow64 = [[Glossary:Game data#Windows registry|{{Abbr|Wow6432Node|Omit this folder for 32-bit versions of Windows|template=yes}}]] | |
<!-- Windows > Drive --> | <!-- Windows > Drive --> | ||
|username = [[Glossary:Game data#User profile|{{Abbr|%USERNAME%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]] | |username = [[Glossary:Game data#User profile|{{Abbr|%USERNAME%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]] | ||
Line 21: | Line 19: | ||
|public = [[Glossary:Game data#Shared profile|{{Abbr|%PUBLIC%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]] | |public = [[Glossary:Game data#Shared profile|{{Abbr|%PUBLIC%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]] | ||
|allusersprofile | |allusersprofile | ||
− | |programdata = [[Glossary:Game data#Shared application data|{{Abbr|%PROGRAMDATA%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]] | + | |programdata = [[Glossary:Game data#Shared application data|{{Abbr|%PROGRAMDATA%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]{{#vardefine:Game data note|gamedir}} |
+ | |programfiles = [[Glossary:Game data#Shared applications|{{Abbr|%PROGRAMFILES%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]{{#vardefine:Game data note|gamedir}} | ||
|windir = [[Glossary:Game data#Windows|{{Abbr|%WINDIR%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]{{#vardefine:Game data note|gamedir}} | |windir = [[Glossary:Game data#Windows|{{Abbr|%WINDIR%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]{{#vardefine:Game data note|gamedir}} | ||
− | |||
|syswow64 = [[Glossary:Game data#Windows data paths|{{Abbr|SysWOW64|Use System32 for 32-bit versions of Windows|template=yes}}]] | |syswow64 = [[Glossary:Game data#Windows data paths|{{Abbr|SysWOW64|Use System32 for 32-bit versions of Windows|template=yes}}]] | ||
− | |||
<!-- OS X --> | <!-- OS X --> | ||
|osxhome = [[Glossary:Game data#macOS (OS X) paths|{{Abbr|$HOME|Refers to the user's home folder, e.g. ~/ or /Users/user/|template=yes}}]] | |osxhome = [[Glossary:Game data#macOS (OS X) paths|{{Abbr|$HOME|Refers to the user's home folder, e.g. ~/ or /Users/user/|template=yes}}]] | ||
− | |||
<!-- Linux --> | <!-- Linux --> | ||
|linuxhome = [[Glossary:Game data#Linux paths|{{Abbr|$HOME|Refers to the user's home folder, e.g. ~/ or /home/user/|template=yes}}]] | |linuxhome = [[Glossary:Game data#Linux paths|{{Abbr|$HOME|Refers to the user's home folder, e.g. ~/ or /home/user/|template=yes}}]] | ||
|xdgdatahome = [[Glossary:Game data#Linux paths|{{Abbr|$XDG_DATA_HOME|Defaults to ~/.local/share when unset|template=yes}}]] | |xdgdatahome = [[Glossary:Game data#Linux paths|{{Abbr|$XDG_DATA_HOME|Defaults to ~/.local/share when unset|template=yes}}]] | ||
|xdgconfighome = [[Glossary:Game data#Linux paths|{{Abbr|$XDG_CONFIG_HOME|Defaults to ~/.config when unset|template=yes}}]] | |xdgconfighome = [[Glossary:Game data#Linux paths|{{Abbr|$XDG_CONFIG_HOME|Defaults to ~/.config when unset|template=yes}}]] | ||
− | |||
<!-- Default --> | <!-- Default --> | ||
− | |# | + | |#default = [[Category:Invalid template usage (Path)]] |
}}</includeonly><noinclude>{{Documentation}}</noinclude> | }}</includeonly><noinclude>{{Documentation}}</noinclude> |
Revision as of 21:02, 6 August 2020
Documentation for the above template (sometimes hidden from view).
- 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 |
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 |
AppData\LocalLow | |
public |
%PUBLIC% | Public (aka shared) user profile folder |
allusersprofile or programdata |
%PROGRAMDATA% | Program data folder |
programfiles |
%PROGRAMFILES% | Shared applications folder. Use game instead (<path-to-game> ).
|
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}}
- Related
- {{LocalizedPath}}
Visit Template:Path/Documentation to edit this text. (How does this work?)