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

Difference between revisions of "PCGamingWiki:Sample article"

From PCGamingWiki, the wiki about fixing PC games
(VR template code)
m (added OS X and Linux release dates)
Line 18: Line 18:
 
|release dates=  
 
|release dates=  
 
{{Infobox game/row/date|Windows|Month dd, yyyy}}
 
{{Infobox game/row/date|Windows|Month dd, yyyy}}
 +
{{Infobox game/row/date|OS X|Month dd, yyyy}}
 +
{{Infobox game/row/date|Linux|Month dd, yyyy}}
 
|steam appid  = 000000
 
|steam appid  = 000000
 
|steam appid side  = 000000
 
|steam appid side  = 000000
Line 420: Line 422:
 
|release dates=  
 
|release dates=  
 
{{Infobox game/row/date|Windows|Month dd, yyyy}} <!-- (Example: January 3, 2012) -->
 
{{Infobox game/row/date|Windows|Month dd, yyyy}} <!-- (Example: January 3, 2012) -->
 +
{{Infobox game/row/date|OS X|Month dd, yyyy}}
 +
{{Infobox game/row/date|Linux|Month dd, yyyy}}
 
|steam appid  = 277430
 
|steam appid  = 277430
 
|gogcom id    = 1207658682
 
|gogcom id    = 1207658682

Revision as of 00:21, 23 February 2019

Cheat sheet


{{Infobox game
|cover        = Game cover.jpg
|developers   = 
{{Infobox game/row/developer|Developer}}
|publishers   = 
{{Infobox game/row/publisher|Publisher}}
|engines      = 
{{Infobox game/row/engine|Engine}}
|release dates= 
{{Infobox game/row/date|Windows|Month dd, yyyy}}
{{Infobox game/row/date|OS X|Month dd, yyyy}}
{{Infobox game/row/date|Linux|Month dd, yyyy}}
|steam appid  = 000000
|steam appid side  = 000000
|gogcom id    = 000000
|gogcom id side = 000000
|strategywiki = Page name
|wikipedia    = Page name
|winehq       = 00000
|license      = 
}}
{{Series|game}}

'''General information'''
{{GOG.com links|support page|forum name}}
{{mm}} [https://steamcommunity.com/app/000000/discussions/ Steam Community Discussions]
{{mm}} [  ] for game

==Availability==
{{Availability|
{{Availability/row| Steam | 000000 | Steam | notes |  | Windows }}
{{Availability/row| store | id | drm | notes | keys | os }}
}}

{{DLC|
{{DLC/row| name | notes | platforms }}
}}

==Essential improvements==
===Skip intro videos===

==Game data==
===Configuration file(s) location===
{{Game data|
{{Game data/config|Windows|}}
}}

===Save game data location===
{{Game data|
{{Game data/saves|Windows|}}
}}

===[[Glossary:Save game cloud syncing|Save game cloud syncing]]===
{{Save game cloud syncing
|discord               = 
|discord notes         = 
|gog galaxy            = 
|gog galaxy notes      = 
|origin                = 
|origin notes          = 
|steam cloud           = true/false/unknown
|steam cloud notes     = 
|uplay                 = 
|uplay notes           = 
|xbox cloud            = 
|xbox cloud notes      = 
}}

==Video settings==
{{Image|game settings.png|General settings.}}
{{Video settings
|wsgf link                  = http://www.wsgf.org/dr/game_name/en
|widescreen wsgf award      = gold/silver/limited/unsupported/incomplete
|multimonitor wsgf award    = gold/silver/limited/unsupported/incomplete
|ultrawidescreen wsgf award = gold/silver/limited/unsupported/incomplete
|4k ultra hd wsgf award     = gold/silver/limited/unsupported/incomplete
|widescreen resolution      = true/false/hackable/unknown
|widescreen resolution notes= 
|multimonitor               = unknown
|multimonitor notes         = 
|ultrawidescreen            = unknown
|ultrawidescreen notes      = 
|4k ultra hd                = unknown
|4k ultra hd notes          = 
|fov                        = unknown
|fov notes                  = 
|windowed                   = unknown
|windowed notes             = 
|borderless windowed        = unknown
|borderless windowed notes  = 
|anisotropic                = unknown
|anisotropic notes          = 
|antialiasing               = unknown
|antialiasing notes         = 
|vsync                      = unknown
|vsync notes                = 
|60 fps                     = unknown
|60 fps notes               = 
|120 fps                    = unknown
|120 fps notes              = 
|hdr                        = unknown
|hdr notes                  = 
|color blind                = unknown
|color blind notes          = 
}}

==Input settings==
{{Input settings
|key remap                 = unknown
|key remap notes           = 
|acceleration option       = unknown
|acceleration option notes = 
|mouse sensitivity         = unknown
|mouse sensitivity notes   = 
|mouse menu                = unknown
|mouse menu notes          = 
|invert mouse y-axis       = unknown
|invert mouse y-axis notes = 
|touchscreen               = unknown
|touchscreen notes         = 
|controller support        = unknown
|controller support notes  = 
|full controller           = unknown
|full controller notes     = 
|controller remap          = unknown
|controller remap notes    = 
|controller sensitivity    = unknown
|controller sensitivity notes= 
|invert controller y-axis  = unknown
|invert controller y-axis notes= 
|xinput controllers        = unknown
|xinput controllers notes  = 
|xbox prompts              = unknown
|xbox prompts notes        = 
|impulse triggers          = unknown
|impulse triggers notes    = 
|dualshock 4               = unknown
|dualshock 4 notes         = 
|dualshock prompts         = unknown
|dualshock prompts notes   = 
|light bar support         = unknown
|light bar support notes   = 
|dualshock 4 modes         = unknown
|dualshock 4 modes notes   = 
|tracked motion controllers= unknown
|tracked motion controllers notes = 
|tracked motion prompts    = unknown
|tracked motion prompts notes = 
|other controllers         = unknown
|other controllers notes   = 
|other button prompts      = unknown
|other button prompts notes= 
|controller hotplug        = unknown
|controller hotplug notes  = 
|haptic feedback           = unknown
|haptic feedback notes     = 
|simultaneous input        = unknown
|simultaneous input notes  = 
|steam input api           = unknown
|steam input api notes     = 
|steam hook input          = unknown
|steam hook input notes    = 
|steam input presets       = unknown
|steam input presets notes = 
|steam controller prompts  = unknown
|steam controller prompts notes = 
|steam cursor detection    = unknown
|steam cursor detection notes = 
}}

==Audio settings==
{{Audio settings
|separate volume          = unknown
|separate volume notes    = 
|surround sound           = unknown
|surround sound notes     = 
|subtitles                = unknown
|subtitles notes          = 
|closed captions          = unknown
|closed captions notes    = 
|mute on focus lost       = unknown
|mute on focus lost notes = 
|eax support              = 
|eax support notes        = 
}}

{{L10n|content=
{{L10n/switch
 |language  = Language
 |interface = yes/no
 |audio     = 
 |subtitles = 
 |notes     = 
 |fan       = 
}}
}}

==Network==
{{Network/Multiplayer
|local play           = 
|local play players   = 
|local play modes     = 
|local play notes     = 
|lan play             = 
|lan play players     = 
|lan play modes       = 
|lan play notes       = 
|online play          = 
|online play players  = 
|online play modes    = 
|online play notes    = 
|asynchronous         = 
|asynchronous notes   = 
}}{{Network/Connections
|matchmaking        = 
|matchmaking notes  = 
|p2p                = 
|p2p notes          = 
|dedicated          = 
|dedicated notes    = 
|self-hosting       = 
|self-hosting notes = 
|direct ip          = 
|direct ip notes    = 
}}{{Network/Ports
|tcp  = 
|udp  = 
|upnp = 
}}

==Other information==
===API===
{{API
|direct3d versions      = 
|direct3d notes         = 
|directdraw versions    = 
|directdraw notes       = 
|opengl versions        = 
|opengl notes           = 
|glide versions         = 
|glide notes            = 
|software mode          = 
|software mode notes    = 
|mantle support         = 
|mantle support notes   = 
|metal support          = 
|metal support notes    = 
|vulkan versions        = 
|vulkan notes           = 
|dos modes              = 
|dos modes notes        = 
|shader model versions  = 
|shader model notes     = 
|64-bit executable      = unknown
|64-bit executable notes= 
}}

===Middleware===
{{Middleware
|physics          = 
|physics notes    = 
|audio            = 
|audio notes      = 
|interface        = 
|interface notes  = 
|input            = 
|input notes      = 
|cutscenes        = 
|cutscenes notes  = 
|multiplayer      = 
|multiplayer notes= 
|anticheat        = 
|anticheat notes  = 
}}

==System requirements==
{{System requirements
|OSfamily = Windows

|minOS    = 
|minCPU   = 
|minRAM   = 
|minHD    = 
|minGPU   = 

|recOS    = 
|recCPU   = 
|recRAM   = 
|recHD    = 
|recGPU   = 
|notes    = 
}}

{{References}}
{{Seriesbox|title={{SUBST:PAGENAME}}|entries=
{{Seriesbox/row|[[game]]|yyyy}}
{{Seriesbox/row|[[]]|}}
{{Seriesbox/row|[[]]|}}
{{Seriesbox/row|[[]]|}}
}}<noinclude>[[Category:Series]]</noinclude>
{{Fixbox|description=Description|ref=<ref>[http:// Reference]</ref>|fix=
#
#
#
'''Notes'''
{{ii}}
{{ii}}
}}
See [[#Widescreen resolution|Widescreen resolution]].

See [[#Multi-monitor|Multi-monitor]].

See [[#Field of view (FOV)|Field of view (FOV)]].

See [[#Windowed|Windowed]].

See [[#Borderless fullscreen windowed|Borderless fullscreen windowed]].

See [[#Anisotropic filtering (AF)|Anisotropic filtering (AF)]].

See [[#Anti-aliasing (AA)|Anti-aliasing (AA)]].

See [[#Vertical sync (Vsync)|Vertical sync (Vsync)]].
==VR support==
{{VR support
|gg3d name                   = 
|native 3d gg3d award        = platinum/gold/silver/bronze/uncertified
|nvidia 3d vision gg3d award = 
|tridef 3d gg3d award        = 
|iz3d gg3d award             = 
|native 3d                   = 
|native 3d notes             = 
|nvidia 3d vision            = 
|nvidia 3d vision notes      = 
|tridef 3d                   = 
|tridef 3d notes             = 
|iz3d                        = 
|iz3d notes                  = 
|vr only                     = 
|htc vive                    = 
|htc vive notes              = 
|oculus rift                 = 
|oculus rift notes           = 
|osvr                        = 
|osvr notes                  = 
|windows mixed reality       = 
|windows mixed reality notes = 
|keyboard-mouse              = 
|keyboard-mouse notes        = 
|3rd space gaming vest       = 
|3rd space gaming vest notes = 
|novint falcon               = 
|novint falcon notes         = 
|trackir                     = 
|trackir notes               = 
|tobii eye tracking          = 
|tobii eye tracking notes    = 
|play area seated            = 
|play area seated notes      = 
|play area standing          = 
|play area standing notes    = 
|play area room-scale        = 
|play area room-scale notes  = 
}}

Instructions

Bullet point icons

  • The purpose of the bullet point graphics is to provide more brevity and clarity to article content.
  • All icons automatically indent onto a new line.
  • Virtually all sentences in all game fix pages should use these codes:
- {{ii}} - information.
- {{++}} - positive / advantage / recommend.
- {{--}} - negative / disadvantage / dissuade.

Style crib sheet

We have decided to not include genre information. The focus of the wiki is to provide information about how to fix games, rather than the content of games.
Reference where the fixes come from using <ref> tags and templates ({{refurl}}, {{refcheck}}, {{refsnip}}).[1]
All headers and page names to use sentence case. This means capital letter at the beginning of a sentence, with no other capitals unless it is a proper noun or acryonym.

Fixbox

Use the Fixbox template to boxout fixes and instructions.

Example

Fixbox header here

How to apply this fix.

Note: Fixbox titles MUST describe the fix method, e.g. 'Edit VideoSettings.ini' or 'Run in DirectX 9 through command line'. This helps the user make a choice between multiple solutions to the same problem.


Sample article
Sample article cover
Developers
Developer
Publishers
Publisher
Engines
Engine
Release dates
Windows Month dd, yyyy
macOS (OS X) Month dd, yyyy
Linux Month dd, yyyy
Sample article on Wikipedia

Key points

Key points are the first few things you might say about a game e.g. Star Wars: Knights of the Old Republic II – The Sith Lords is vastly improved by the restored content patch.
Noteworthy comments about poor performance or stability.
Developer support, updates.
Technical comparisons to other games in the series.
Particularly obstructive DRM.

General information

Official Forum - this is a very active official forum
GOG.com Community Discussions
GOG.com Support Page
Steam Community Discussions
If still relevant, state where bugs can be reported.

Availability

Source DRM Notes Keys OS
Retail
Requires online activation
Example notes: SecuROM ∞ activations.
DOS
Mac OS
Amazon.com
Icon overlay.png
Example: Amazon.
Windows
Developer website
DRM-free
Example: game released directly from website.
Icon overlay.png
Windows
macOS (OS X)
Linux
GOG.com
DRM-free
Example: GOG.com.
Windows
macOS (OS X)
Linux
Origin
Origin
Example notes: GFWL (SSA) x 15 activations.
Windows
Steam
Icon overlay.png
Example: Steam.
Windows
macOS (OS X)
Linux
Which is the 'best' version of the game to get?

DLC and expansion packs

Name Notes
Some DLC name Example: Only available in Japan
Windows
Some other DLC
Windows
Linux

Essential improvements

One can use subheaders as below, or simply list individual improvements as 3rd level headers.

Patches

Include If

There is a benefit in using an older patch. For example, Diablo II's latest patch is 1.13, but the high-res mod only supports 1.12.
There is a community or fan patch which is superior to the latest developer patch.
Patch install instructions

How to apply this complex patch installation.

Utilities

Very important launchers, reputable save game editors, etc.

Modifications

List mods that are very important and would be detrimental if played without the mod, e.g. DSFix, TSLRCM. Balance mods and aesthetic mods can also be included if they are stable, mature and popular.

Game data

(Linux only) State whether XDG is being followed (partially, completely, not at all)

Configuration file(s) location

System Location
Windows %APPDATA%\Vessel\
macOS (OS X) ~/Library/Application Support/Vessel/
Linux ~/.config/Vessel/
This game follows the XDG Base Directory Specification on Linux.

Save game data location

System Location
Windows %APPDATA%\.minecraft\saves
macOS (OS X) ~/Library/Application Support/minecraft/saves
Linux ~/.minecraft/saves

Save game cloud syncing

System Native Notes
GOG Galaxy
Origin
Steam Cloud
Syncs save games and settings.
Ubisoft Connect

Video settings

Template:Video settings

Widescreen resolution

Multi-monitor

Ultra-widescreen

4K Ultra HD

Field of view (FOV)

Windowed

Borderless fullscreen windowed

Anisotropic filtering (AF)

Anti-aliasing (AA)

Vertical sync (Vsync)

Color blind mode

Delete unnecessary headers and links.

Input settings

Template:Input settings

Remapping

Mouse acceleration

Controller support

Controller remapping

Touchscreen

Delete unnecessary headers and links.

Audio settings

Template:Audio settings

Localizations

Language UI Audio Sub Notes
English
French
German
Italian
Spanish
Download from here.

Network

Do not include this section in games without Multiplayer modes.

Multiplayer types

Connection types

Ports

Protocol Port(s) and/or port range(s)
TCP 1, 2, 30
UDP 500-600, 3500
Universal Plug and Play (UPnP) support status is unknown.

VR support

This game requires a virtual reality headset.

Issues unresolved

Issue

Issue

Issues fixed

Issue

Fixbox header here

How to apply this fix.

Issue

Other information

Miscellaneous information, e.g.:

  • Visual enhancements.
  • Enabling minor performance increases.
  • Useful, but not essential utilities.

API

Technical specs Supported Notes
Direct3D 9, 11 Windows only.
OpenGL 3.3, 4 OS X and Linux only.
Mantle support
Requires an AMD video card with a driver version earlier than 19.5.1 (2019).[2]
Executable 32-bit 64-bit Notes
Windows
macOS (OS X)
Linux

Middleware

Middleware Notes
Physics PhysX Lacks GPU acceleration on Linux.
Audio FMOD
Interface Scaleform
Cutscenes Bink
Multiplayer Steamworks

Console commands

System requirements

Avoid adding any prefixes and suffixes* to the OS parameter such as "Windows 7", "OS X Lion 10.7" and "7 64-bit". These do not apply to Linux as many distros are available. *For windows, service packs are the only suffix permitted.
64/32-bit only/recommended mention is noted in the notes parameter as a point.
The separator for more than one operating system is a comma (,) - nothing else.
Windows
Minimum Recommended
Operating system (OS) XP, Vista, 7
Processor (CPU) Dual Core 2.0 GHz or Athlon 64 X2 Dual Core 5400+
System memory (RAM) 2 GB
Hard disk drive (HDD) 8 GB
Video card (GPU) Nvidia GeForce 8600 GTS
512 MB of VRAM
OS X
Minimum Recommended
Operating system (OS) 10.5.2
Processor (CPU) Dual Core 2.0 GHz or Athlon 64 X2 Dual Core 5400+
System memory (RAM) 2 GB
Hard disk drive (HDD) 8 GB
Video card (GPU) Nvidia GeForce 8600 GTS
512 MB of VRAM
Linux
Minimum Recommended
Operating system (OS) Kernel 3.0
Processor (CPU) Dual Core 2.0 GHz or Athlon 64 X2 Dual Core 5400+
System memory (RAM) 2 GB
Hard disk drive (HDD) 8 GB
Video card (GPU) Nvidia GeForce 8600 GTS
512 MB of VRAM


References

  1. PCGamingWiki - last accessed on 2012-12-21
  2. Cite error: Invalid <ref> tag; no text was provided for refs named Mantle support