Difference between revisions of "PCGamingWiki:Editing guide/Game data"
(Added Editing guide navbar.) |
m (1 revision imported) |
(No difference)
|
Revision as of 14:37, 9 September 2015
The Game data section holds information relating to possibly the two most important types of files available: configuration (or config) files and save data/files.
Config files hold all the customization values needed to run the game, while save files hold the in-game progress made by the player. The locations of both file types are critical for modifying the game and/or backing up progress.
The section also handles information regarding the save game cloud syncing services (services or programs that automatically backup save files to an offsite server).
Main table
Syntax (base)
{{Game data| --rows go here-- }}
Syntax (row)
{{Game data/row| OS | File location }}
Example
System | Location |
---|
The main part of the section. Like the Availability and DLC tables, the Game data table can be dynamically adjusted to only show the applicable OSes. Unlike other tables however, it needs to be used twice in an article (one for config files, another for save files). The only times this is not the case is when a game does not use save files (game is multiplayer only or uses a save system that does not rely on files. The save files table can be omitted) or both the config files and save files are in the same folder (use one table for both file types).
General rules
- In the case that the game has multiple OS versions available, organize the rows in the following order (for all the platforms that apply):
- DOS
- Windows
- Mac OS
- OS X
- Linux
- Use environment variables when possible. The wiki already has special variables to represent them (see Game data).
- Windows and DOS use
\
as the directory separator. OS X and Linux use/
. Mac OS uses:
. - Games with multiple distribution versions on the same OS (ex. Steam, Origin) should have separate rows if files are placed differently.
Popular file locations
A list of common file locations:
Windows
Location | Path | Notes |
---|---|---|
Base game folder | <path-to-game>\ | |
Game subfolder | <path-to-game>\(name of subfolder)\ | Look for folders labeled along the lines of "Profiles", "Saves", "Save Games", or "Configs". Sometimes the relevant files can be located with the game binaries (the folder is normally called "Bin"). |
User's "Saved Games" folder | %USERPROFILE%\Saved Games\ | |
User's "Documents" folder | %USERPROFILE%\Documents\ | |
"My Games" folder | %USERPROFILE%\Documents\My Games\ | Some Unreal Engine 3 games are lumped together under the "UnrealEngine3" subfolder. |
Local AppData folder | %LOCALAPPDATA%\ | Hidden folder. |
LocalLow AppData folder | %USERPROFILE%\AppData\LocalLow\ | Hidden folder. |
Roaming AppData folder | %APPDATA%\ | Hidden folder. |
VirtualStore folder | %LOCALAPPDATA%\VirtualStore\Program Files\ %LOCALAPPDATA%\VirtualStore\Program Files (x86)\ |
Hidden folder. Files located here are equivalent to the main folder counterparts. (Ex. |
ProgramData folder | %PROGRAMDATA%\ | Hidden folder. |
HKEY_CURRENT_USER | HKEY_CURRENT_USER\Software\ | Configuration values are stored here. The Registry Editor is required to access this path. Files can sometimes be found under the "Wow6432Node" subfolder. Only list this path if no other files can be found elsewhere. |
HKEY_LOCAL_MACHINE | HKEY_LOCAL_MACHINE\SOFTWARE\ | Configuration values are stored here. The Registry Editor is required to access this path. Files can sometimes be found under the "Wow6432Node" subfolder. Only list this path if no other files can be found elsewhere. |
OS X
Location | Path | Notes |
---|---|---|
Application support | ~/Library/Application Support/ | . |
Linux
Location | Path | Notes |
---|---|---|
Base game folder | <path-to-game>/ | |
Game subfolder | <path-to-game>/(name of subfolder)/ | Look for folders labeled along the lines of "Profiles", "Saves", "Save Games", or "Configs". Sometimes the relevant files can be located with the game binaries (the folder is normally called "Bin"). |
XDG_DATA_HOME | ~/.local/share/ | See also XDG support. |
XDG_CONFIG_HOME | ~/.config/ | See also XDG support. |
HOME | ~/ | Usually the folders are hidden (beginning with a full stop). |
XDG support
If the game is available on Linux, support for the XDG Base Directory Specification needs to be mentioned. The tag is always placed under the config files table.
Syntax
{{XDG|true/false}}
Example
<config file table>
- This game does not follow the XDG Base Directory Specification on Linux.
<save game data table>
Save game cloud syncing table
Syntax
{{Save game cloud syncing |origin = |origin notes = |square enix = |square enix notes = |steam cloud = true/false/unknown |steam cloud notes = |uplay = |uplay notes = |gamesave manager = |gamesave manager notes= }}
Example
System | Native | Notes |
---|---|---|
Origin | ||
Ubisoft Connect |
A minor table, the Save game cloud syncing table displays all cloud syncing services that support the game.
Note that only the stores/services the game is available on need to be filled in. The rest can be left blank.
Also, the GameSave Manager field will only show if the value is set to true
.
Full Example
- Taken from Vessel
Configuration file(s) location
- This game follows the XDG Base Directory Specification on Linux.
Save game data location
Save game cloud syncing
- No save game cloud syncing information; you can edit this page to add it.