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
(updated with Template:VR support example)
m
Line 68: Line 68:
  
 
==Video settings==
 
==Video settings==
[[File:game settings.png|290px|right|thumb|General settings.]]
+
{{Image|game settings.png|General settings.}}
 
{{Video settings
 
{{Video settings
 
|wsgf link                  = http://www.wsgf.org/dr/game_name/en
 
|wsgf link                  = http://www.wsgf.org/dr/game_name/en

Revision as of 21:41, 30 April 2015

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}}
|steam appid  = 000000
|gogcom page  = game_name
|winehq       = 00000
|wikipedia    = Page name
}}
{{Series|game}}

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

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

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

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

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

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

===[[Glossary:Save game cloud syncing|Save game cloud syncing]]===
{{Save game cloud syncing
|origin                = 
|origin notes          = 
|steam cloud           = true/false/unknown
|steam cloud notes     = 
|uplay                 = 
|uplay notes           = 
|gamesave manager      = 
|gamesave manager 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                = 
|high frame rate            = unknown
|high frame rate notes      = 
|color blind                = unknown
|color blind notes          = 
}}

==Input settings==
{{Input settings
|key remap                 = unknown
|key remap notes           = 
|acceleration option       = unknown
|acceleration option notes = 
|mouse menu                = unknown
|mouse menu notes          = 
|invert mouse y-axis       = unknown
|invert mouse y-axis notes = 
|controller support        = unknown
|controller support notes  = 
|full controller           = unknown
|full controller notes     = 
|controller remap          = unknown
|controller remap notes    = 
|invert controller y-axis  = unknown
|invert controller y-axis notes= 
|touchscreen               = unknown
|touchscreen 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       = 
 |fan notes = 
}}
}}

==Network==
{{Network/Multiplayer
|local play           = 
|local play players   = 
|local play notes     = 
|lan play             = 
|lan play players     = 
|lan play notes       = 
|online play          = 
|online play players  = 
|online play notes    = 
|local co-op          = 
|local co-op players  = 
|local co-op notes    = 
|lan co-op            = 
|lan co-op players    = 
|lan co-op notes      = 
|online co-op         = 
|online co-op players = 
|online co-op notes   = 
|hot-seat             = 
|hot-seat players     = 
|hot-seat 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==

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

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

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

{{References}}
{{Seriesbox|title={{SUBST:PAGENAME}}|entries=
{{Seriesbox/row|[[game]]|yyyy}}
{{Seriesbox/dlc|DatadiskDLC}}
{{Seriesbox/row|[[]]|}}
{{Seriesbox/row|[[]]|}}
{{Seriesbox/row|[[]]|}}
}}<noinclude>[[Category:Series]]</noinclude>
{{Fixbox|1=
{{Fixbox/fix|Description|ref=<ref>[http:// Reference]</ref>}}
#
#
#
'''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)]].

Instructions

  • Code sections can be copied using the edit link for this page.
  • Choose an appropriate category, which will normally be [[Category:Windows]].
  • The Fallout series of articles is an excellent reference point for example of good articles.

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.[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.

Fixbox/fix

Parameters include:
  • |link=false - no 'link here' text - if you want to make the header into a link itself.

Example

Instructions

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
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
Steam Users' Forums
Steam Community Discussions
GOG.com Community Discussions
GOG.com Support Page
If still relevant, state where bugs can be reported.

Availability

Source DRM Notes Keys OS
Developer website
DRM-free
Example: game released directly from website.
Icon overlay.png
Error: OS parameter cannot be empty
Amazon.com
Icon overlay.png
Example: Amazon.
Error: key type '{{{5}}}' not recognised
Error: OS parameter cannot be empty
GOG.com
DRM-free
Example: Gog.com.
Error: key type '{{{5}}}' not recognised
Error: OS parameter cannot be empty
Origin
Origin
Example notes: GFWL (SSA) x 15 activations.
Error: key type '{{{5}}}' not recognised
Error: OS parameter cannot be empty
Steam
Icon overlay.png
Example: Steam.
Error: key type '{{{5}}}' not recognised
Error: OS parameter cannot be empty
Retail
Requires online activation
Example notes: SecuROM ∞ activations.
Error: key type '{{{5}}}' not recognised
Error: OS parameter cannot be empty
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.
Instructions

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

Save game location

(Linux only) State whether XDG is being followed (partially, completely, not at all)
Template:Game data/rowTemplate:Game data/rowTemplate:Game data/row
System Location
Steam Play (Linux) <Steam-folder>/steamapps/compatdata/207170/pfx/[Note 1]

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)

High frame rate

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

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

Issues unresolved

Issue

Issue

Issues fixed

Issue

Instructions

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

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 can be noted either above or below as a point like this instead of being included in the table.
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


Notes

  1. File/folder structure within this directory reflects the path(s) listed for Windows and/or Steam game data (use Wine regedit to access Windows registry paths). Games with Steam Cloud support may store data in ~/.steam/steam/userdata/<user-id>/207170/ in addition to or instead of this directory. The app ID (207170) may differ in some cases. Treat backslashes as forward slashes. See the glossary page for details.

References

  1. http://www.pcgamingwiki.com
  2. Cite error: Invalid <ref> tag; no text was provided for refs named Mantle support