Template:Software page/doc

This is a documentation subpage for Template:Software page.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

This template enables software pages to use a standardized, universal interface.

This template uses a strings subpage
Please follow the format on this subpage(s) to add translations.

Sandbox

This template searches for files based only on the information provided to it in the parameters, that is, you can create a fully functional copy of the conditional Half-Life 2 page anywhere else.

Use the template sandbox for your experiments.

Images

Supported formats: JPG, PNG.

Tip:.JPEG images are identical to .JPG images, so do not be afraid to change the file extension!

Tip:.JPG images are highly recommended for better loading times because they are more compressed, making them perfect for those with insufficient internet connections.

Warning:Avoid JPEG quality levels higher than 98 (or Quality 10+ in Photoshop), as that can result in larger file sizes than a PNG.

Tip:JPEG quality levels lower than 95 are generally unnecessary, and quality levels lower than 90 (or Quality 8 and below in Photoshop) should be avoided.

Maximum number of screenshots: 20.

Recommended aspect ratio of screenshots: 16:9 (,), 4:3 ()

Tip:Do not pad or crop 4:3 screenshots to 16:9 or vice versa

Recommended cover resolution: 460x215 or 960x430

Tip:The template will automatically resize the cover image to the correct dimensions.

Examples:

• Counter-Strike Source - Background.jpg
• Counter-Strike Source - Trailer Preview.jpg
• Counter-Strike Source - Screenshot 1.jpg
• Counter-Strike Source - Screenshot 2.jpg
• Software Cover - Counter-Strike Source.jpg

Translations:

At the moment, only screenshots have translation support. Below is an example of the names of the translated files.

• Counter-Strike Source - Screenshot 1 (de).jpg
• Counter-Strike Source - Screenshot 1 (ru).jpg
• Counter-Strike Source - Screenshot 1 (zh).jpg

Media:

• You can download a Photoshop document to create a software background.

Developers and Publishers

Use this in {{{developer}}} or {{{publisher}}}. You can also write something of your own and apply some special formatting to it.

Note:Custom links (for example, [http://valvesoftware.com Valve]) will not work. The introduction of categories has replaced user links to categories of organizations, where all brief information will be located, including links to the organizations websites (i.e., companies, studios, etc.).

Parameter Value	Result
Valve	Valve
Gearbox	Gearbox Software
TRS	Turtle Rock Studios
Ritual	Ritual
MD	Maverick Developments
Outerlight	Outerlight
RS	Reperio Studios
KRG	Kuma Reality Games
Paleo	Paleo
Facepunch	Facepunch Studios

Modes

Use this in {{{mode <2-4>}}}. You can also write something of your own and apply some special formatting to it.

Parameter Value	Result
SP	Single Player
MP	Multiplayer Game
COOP	Cooperative Game
MMO	MMO

Deck Verified Status

Use this in {{{deck}}}.

Parameter Value	Result	Notes
Verified		Use this if the game was Verified and fully supported on Steam Deck
Playable		Use this if the game was Playable and partially supported with some issues on Steam Deck
Unsupported		Use this if the game was Unsupported and not playable on Steam Deck.
Unknown		Use this if the game was also Unsupported, but marked as "Valve is still working on adding support for this game on Steam Deck" or not marked with anything, which means that this game is not tested.

Check the Deck Verified status on SteamDB or ProtonDB page of a game (or via your Steam Deck library), example: Half-Life 2 App Info page (on SteamDB) or Garry's Mod on ProtonDB, then scroll down and see the Steam Deck Compatibility section (SteamDB only).

Genres

Use this in {{{genre <2-6>}}}. You can also write something of your own and apply some special formatting to it.

Parameter Value	Result
Indie	Indie
FPS	First Person Shooter
TPS	Third Person Shooter
Fighting	Fighting
Arcade	Arcade
Stealth	Stealth
Adventure	Adventure
Platformer	Platformer
PAC	Point & Click
VN	Visual Novel
Racing	Racing
RP	Role Playing
Roguelike	Roguelike
Remake	Remake
MOBA	MOBA
RTS	Real-Time Strategy
Puzzle	Puzzle
Sandbox	Sandbox
Battle Royale	Battle Royale
Zombie	Zombie
Survival	Survival
Horror	Horror

Platforms

Use these in the {{{platform <2-5>}}} parameter. While you can specify your own platform, it is recommended you use these, otherwise the automatic Category placement could not work correctly.

Parameter Value	Result
PC	PC
Xbox	Xbox
X360	Xbox 360
Xbox_One	Xbox One
Xbox_XS	Xbox Series X|S
Ps2	PlayStation 2
Ps3	PlayStation 3
Ps4	PlayStation 4
Ps5	PlayStation 5
Switch	Nintendo Switch
Steamdeck	Steam Deck
Android	Android

Please only put the platforms the game released on; Do not list the entire Xbox series for a game that released on the original (although, if a game released on two consoles from the same family, do list them separately)

Engines and Branches

Use this in {{{engine <2>}}} or {{{branch <2>}}}.

Parameter Value	Preview
Engines
GoldSrc	GoldSrc
Source	Source
Source 2	Source 2
Branches
Source 04	Source 2004
Source 06	Source 2006
Source 07	Source 2007
Source 09	Source 2009
Source MP	Source Multiplayer
Source 13	Source 2013
Source 13 SP	Source 2013 Singleplayer
Source 13 MP	Source 2013 Multiplayer
Left 4 Dead	Left 4 Dead engine branch
Alien Swarm	Alien Swarm engine branch
Portal 2	Portal 2 engine branch
Titanfall	Titanfall branch
CSGO	CS:GO branch
Strata	Strata Source

You can also write something of your own in this parameter(s), but note that without {{{engine <2> template}}}, the text you wrote will be the simplest link.

Metacritic reviews

The background for the metacritic score box will change depending on what value you input into the {{{metacritic}}} parameter.

Below is a list of said values that you can use within the {{{metacritic}}} parameter.

Parameter value	Background color	Notes
Any value that prompts an expression error		A gray background will be used if all mathematical expressions fail to return a value of 1. In layman's terms, a gray background will (in most cases) be used by default if the value used within the {{{metacritic}}} is non-numerical.
75 > 100		Will result in a green background if a number is used that is equal to or greater than 75.
50 > 74		Will result in a yellow background if a number is used that is equal to or greater than 50.
0 < 49		Will result in a red background if a number is used that is less than 50.

Copy and Paste

{{Software page | name = | shortdesc = | release = | mode = | genre = | platform = | engine = | branch = | developer = | publisher = | desc = {{MultiPage}} }}

Parameters and Examples

Normal mode

Parameter	Description	Example
{{{name}}}	The full name of the game. Necessary for image detection.	| name = Counter-Strike: Source
{{{filename}}}	A short name in case files cannot use the full name due to system restrictions.	| filename = Counter-Strike Source
{{{type}}}	If specified, the template will replace some categories based on the specified value. Also, the template can add some additional interface elements, if there are any. Avaliable values: Mod Tool Package	| type = Mod | type = Tool | type = Package
{{{appid}}}	Steam AppID. Used in some links.	| appid = 440
{{{steamworks}}}	Includes a page in the Steamworks games category.	| steamworks = true
Topbar
{{{docs}}}	If standard is specified, the template will add a link to <Page Name>/Docs. You can also specify an article located inside this wiki. Removing {{{docs}}} if you want to hide the button.	| docs = standard | docs = Counter-Strike: Source Level Creation
{{{wiki}}}	Link to a wiki or website or blog.	| wiki = http://wiki.teamfortress.com
{{{website}}}		| website = http://www.teamfortress.com
{{{blog}}}		| blog = http://blog.counter-strike.net
{{{wikipedia}}}	Link to the Wikipedia page. If true is specified, the full page name or the value from {{{name}}} will be used.	| wikipedia = true | wikipedia = Counter-Strike:_Source
{{{pcgw}}}	Link to the PCGamingWiki page. If true is specified, the full page name or the value from {{{name}}} will be used.	| pcgw = true | pcgw = Team_Fortress_2
Background
{{{background}}}	Disables the background if the value false is specified. By default, the template searches for <Project> - Background.<format>, but you can specify any file in this parameter. External URLs are supported. The supported formats and recommended resolution can be seen in Images.	| background = false | background = [[File:Counter-Strike - Screenshot 1.jpg]] | background = https://www.l4d.com/blog/images/footer_img.jpg
{{{background color}}}	Background color.	| background color = #F1C40F
{{{background gradient}}}	Background gradient.	| background gradient = radial-gradient(ellipse at top, #2980B9, #3498DB)
{{{background size}}}	Background size. Warning:Only for automatically detected images.	| background size = 1800px
{{{background format}}}	Overwrites PNG to JPG for Background. It is needed for cases when you consider JPG more preferable.	| background format = jpg
{{{background opacity}}}	Background opacity. The default value is .1.	| background opacity = .5
Screenshots and Movies
{{{trailer}}}	Link to the trailer.	| trailer = http://cdn.cloudflare.steamstatic.com/steam/apps/256881738/movie480_vp9.webm
{{{trailer preview}}}	Specifies the format of the desired image. After specifying the format, creates a file based on {{{name}}} and {{{filename}}}. See Images for details.	| trailer preview = jpg
{{{screenshot <1-20>}}}	If the image format is specified (JPG or PNG), the template will search for images corresponding to the contents of {{{name}}} or {{{filename}}}. You can also specify any other image by writing its full name with the format. Tip:If your custom screenshot needs translation, add {{Autolang||<language code> = &nbsp;(<language code>)}} before the format.	| screenshot 1 = jpg | screenshot 16 = Counter-Strike 2 - ar_baggage.png | screenshot 16 = Dota Underlords - Screenshot 4{{Autolang||ru = &nbsp;(ru)}}.png
{{{screenshot <1-20> desc}}}	Screenshot description.	| screenshot 7 desc = Particle System
{{{screenshot <1-20> lang}}}	Screenshot translation.	| screenshot 7 lang = {{Autolang||de = de|ru = ru|zh = zh}}
Infopanel
{{{deck}}}	Steam Deck verified status. For avaliable values, see Deck Verified Status.	| deck = Verified
{{{shortdesc}}}	A short description of the software.	| shortdesc = Hello, World!
{{{release}}}	Release date. Available values: Soon – Coming soon TBA – To be announced TBD – To be determined	| release = TBA | release = 3 Mar 2023
{{{release planned}}}	Planned release date. If {{{release}}} is specified, then "Planned release date" is replaced by "Initial release date".	| release planned = 3 Mar 2003
{{{mode <2-4>}}}	Game mode(s). See Modes for details.	| mode = MP | mode 2 = Indie
{{{genre <2-4>}}}	The genre(s) of the game. See Genres for details.	| genre = Action | genre 2 = FPS
{{{platform <2-5>}}}	Platform(s) the game released on. See Platforms for details.	| platform = PC | platform 2 = Linux
{{{engine <2>}}}	Game engine(s). See Engines and Branches for details.	| engine = GoldSrc | engine = Unity
{{{engine <2> template}}}	Specifies the engine template for custom values.	| engine template = stratabranch | engine 2 template = stratabranch
{{{engine <2> comment}}}	Comments to the right of the engine(es).	| engine comment = Release | engine 2 comment = Port
{{{branch <2>}}}	Engine branch(es). See Engines and Branches for details.	| branch = Source 6 | branch 2 = Source 13 MP
{{{branch template}}}	Specifies the engine branch template for custom values.	| branch template = stratabranch
{{{branch <2> comment}}}	Comments to the right of the branch(es).	| branch comment = Outdated | branch 2 comment = Steam
{{{developer <2-4>}}}	Game developer(s). See Developers and Publishers for details.	| developer = Valve
{{{publisher <2-4>}}}	Publisher(s) of the game. See Developers and Publishers for details.	| publisher = Valve
{{{workshop}}}	If this is a mod located in the workshop of some game, then you can specify its ID here.	| workshop = 2269588821
{{{moddb}}}	Software location on ModDB.	| moddb = mods/black-mesa-blue-shift-remake
{{{metacritic}}}	Metacritic score.	| metacritic = 100
{{{metacritic link}}}	Metacritic review page.	| metacritic link = pc/garrys-mod
Software Description
{{{desc}}}	Description of the software. This is the main body of the article, and is usually where the {{MultiPage}} template is placed.	| desc = {{MultiPage}}

Experimental mode

Parameter	Description	Example
{{{experimental}}}	Includes experimental features, if any.	| experimental = true

Used Categories

Warning:Not all categories can be used by this wiki, so do not turn red into blue if there is nothing in this category.

Games

• Games, Steamworks games
• Released Games
• Official Games, Third Party Games
• GoldSrc games, Source games, Source 2 games
• Third Party GoldSrc Engine Games, Third Party Source Engine Games, Third Party Source 2 Engine Games
• Source 2004 engine branch games, Source 2006 engine branch games, Source 2007 engine branch games, Source 2009 engine branch games, Source MP engine branch games, Source 2013 engine branch games, Source 2013 SP engine branch games, Source 2013 MP engine branch games, Left 4 Dead engine branch games, Alien Swarm engine branch games, Portal 2 engine branch games Counter-Strike: Global Offensive engine branch games
• Valve games, Gearbox Software games, Turtle Rock Studios games, Ritual games, Maverick Developments games, Outerlight games, Reperio Studios games, Kuma Reality Games games, Paleo games, Facepunch Studios games

Mods

• Mods
• Released Mods
• Official Mods, Third Party Mods
• GoldSrc mods, Source mods, Source 2 mods
• Third Party GoldSrc Engine Mods, Third Party Source Engine Mods, Third Party Source 2 Engine Mods
• Source 2004 engine branch mods, Source 2006 engine branch mods, Source 2007 engine branch mods, Source 2009 engine branch mods, Source MP engine branch mods, Source 2013 engine branch mods, Source 2013 SP engine branch mods, Source 2013 MP engine branch mods, Left 4 Dead engine branch mods, Alien Swarm engine branch mods, Portal 2 engine branch mods Counter-Strike: Global Offensive engine branch mods
• Valve mods, Gearbox Software mods, Turtle Rock Studios mods, Ritual mods, Maverick Developments mods, Outerlight mods, Reperio Studios mods, Kuma Reality mods mods, Paleo mods, Facepunch Studios mods

Tools

• Tools
• Released Tools
• Official Tools, Third Party Tools
• Third Party GoldSrc Engine Tools, Third Party Source Engine Tools, Third Party Source 2 Engine Tools
• Source 2004 engine branch tools, Source 2006 engine branch tools, Source 2007 engine branch tools, Source 2009 engine branch tools, Source MP engine branch tools, Source 2013 engine branch tools, Source 2013 SP engine branch tools, Source 2013 MP engine branch tools, Left 4 Dead engine branch tools, Alien Swarm engine branch tools, Portal 2 engine branch tools Counter-Strike: Global Offensive engine branch tools
• Valve tools, Gearbox Software tools, Turtle Rock Studios tools, Ritual tools, Maverick Developments tools, Outerlight tools, Reperio Studios tools, Kuma Reality tools tools, Paleo tools, Facepunch Studios tools

Packages

• Packages
• Released Packages
• Official Packages, Third Party Packages
• Valve packages, Gearbox Software packages, Turtle Rock Studios packages, Ritual packages, Maverick Developments packages, Outerlight packages, Reperio Studios packages, Kuma Reality packages packages, Paleo packages, Facepunch Studios packages

Other

• Upcoming Releases
• Modes, Genres, Platforms

Included Subpages

Below are the subpages that are used by this template for better code readability or something else.

• /components - Content to include in the template.
• /strings - Translatable strings and strings to include in the template.