View source for Template:Software status/doc

{{Doc/subpage}}
This is a replacement of {{t|Game release}} template and variants of it, combining all of these into one. This will make it quicker to maintenance and any edit on this template will apply to all the pages, instead of having to edit multiple separate [[Template:Game release]] template.

The purpose of this template is to tell users whether the game is announced, delisted or currently available on Steam or not, plus whether the game is Steam Deck verified.
== Usage (copy & paste) ==
=== For anything else ===
{{CodeBlock|<nowiki>{{Software status
		| appid = <appid>
		| type = games <!-- games/mods/tools -->
		| free = no <!-- yes/no - "No" by default -->
		| status = released <!-- announced/released/delisted/delisted-dl/earlyaccess (ea)/in development (dev/indev) --> <!-- More values is available on testcases page. -->
		| os = all <!-- See template testcases for more values. If you want to hide this, leave the parameter blank. -->
		| note = <!-- Put any custom notice here. Optional. -->
		<!-- OTHER STOREFRONTS
		This is for games that did uses Valve engines (or closely related to it), that was sold or available for free outside Steam. Works similarly to "note" parameters. 
		Beside that, you can also use this for console versions of the game sold on PlayStation Network (PS)/MS Store (Xbox)
		Do not use affiliate link as it's can affect users with adblockers. And remember to use "•" for spacing if there are sold in multiple other storefronts. -->
		| 3rdpartylinks = <!-- Example: "{{gog|vampire_the_masquerade_bloodlines|GOG.com}}" for VTMB (on GOG.com), "{{epic|quake|Epic Games}}" for Quake 1 (on Epic Games Store), etc... -->
		}}
</nowiki>}}
==== System requirements section ====
To make the "See system requirements" button work, you must use this header:
{{CodeBlock|<nowiki>Replace this: 
== System Requirements ==
with
== System Requirements<span id="Sysreq"><!--Used by Sysreq template, clicking on "See system requirements" will send you to this section.--></span> ==
</nowiki>}}
This will also works in other languages aswell, and in different text, as long if the "Sysreq" id is not changed.
To add the System requirements template, see {{T|Sysreq}} for more info.

=== For announced games ===
{{Expand|noborder=1|title=See code|
{{CodeBlock|<nowiki>{{Software status
		| appid = <appid>
		| type = games
		| free = <!-- doesn't do anything with announced, but still useful -->
		| status = announced
		| deck = hide
		| website = <!-- Optional -->
		}}
</nowiki>}}
}}
To prevent categorization, add the following parameters: {{CodeBlock|<nowiki>| nocat = 1</nowiki>}}

== Parameters and Examples ==
{| width="100%" class="unsortable" style="overflow: hidden; border-radius:.4em; border:2px solid #525252"
|- bgcolor="#3A3A3A" style="white-space:nowrap"
! style="width:15%" style="background-color:#4f5559; color:#FFF" | {{Dictionary/common|Param}}
! style="text-align:center" style="background-color:#4f5559; color:#FFF" | {{Dictionary/common|Desc}}
! style="text-align:center" style="background-color:#4f5559; color:#FFF" | Value
! style="background-color:#4f5559; color:#FFF" | {{Dictionary/common|Previews}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|type}}}}
| bgcolor="#3A3A3A" align="center" |Type of software, see more value on [[/testcases|testcases page]].<br> '''This must be specified'''.
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| type = games</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| type = mods</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| type = tools</nowiki>}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|appid = 220|type=mod}}<br>{{Software status|nocat=1|appid = 220|type=tools}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|appid}}}}
| bgcolor="#3A3A3A" align="center" |Set the AppID for the software
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| appid = 220</nowiki>}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|appid = 220|type=game}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|gamename}}<br>{{Param|customgamename}}}}
| bgcolor="#3A3A3A" align="center" | Set the custom game name.<br>{{Param|gamename}} must be set to {{code|other}}, then you put the game name on {{Param|customgamename}} parameters. Used on pages like {{bms|2}}.
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| gamename = other</nowiki><br><nowiki>| customgamename = Black Mesa</nowiki>}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|appid = 362890|type=game|gamename=other|customgamename=Black Mesa}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|free}}}}
| bgcolor="#3A3A3A" align="center" |Is this software free?<br>If {{code|{{param|free}}{{=}}no}} or left blanks, mark the software as paid, if {{code|{{param|free}}{{=}}yes}}, mark it as a free software.
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| free = yes/no</nowiki>}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|free = yes|type=game}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|status}}}}
| bgcolor="#3A3A3A" align="center" |Availability of the software, by default, it is marked as "available". If the game was delisted on Steam, set {{param|status}} to {{code|delisted}}<br>If this game is currently in Early Access, set {{param|status}} to {{code|ea}} or {{Code|earlyaccess}}. <br>More value can be found on [[/testcases/Availability|testcases/Availability page]].
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| status = delisted</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| status = ea</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| status = demo</nowiki>}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|status = delisted|type=game}}<br>{{Software status|nocat=1|status = ea|type=game}}<br>{{Software status|nocat=1|status = demo|type=game}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|os}}}}
| bgcolor="#3A3A3A" align="center" |Supported OS for the game, software, etc..., more can be found on [[/testcases|testcases page]].
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| os = win</nowiki>|type=game}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|os = win|type=game}}
|-
<!-- 
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|deck}}}}
| bgcolor="#3A3A3A" align="center" |Steam Deck support status, more value can be found on [[/testcases|testcases page]].
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| deck = verified</nowiki>|type=game}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|deck = verified|type=game}}
-->
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|3rdpartystore}}}}
| bgcolor="#3A3A3A" align="center" | Used to put 3rd party stores links. Works similarly to "note" parameters.<br>'''Recommended templates''': <br>{{t|gog}} <br>{{t|epic}} <br>{{t|gplay}} (for {{Nvidia|1}} Shield port), etc...<br> For spacing, use "•".
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| 3rdpartylinks={{gog|vampire_the_masquerade_bloodlines|GOG.com}}</nowiki>|type=game}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|appid=2600|deck = verified|type=game|3rdpartylinks={{gog|vampire_the_masquerade_bloodlines|GOG.com}}}}
|-
| bgcolor="#3A3A3A" align="center" | {{Code|style=2|{{Param|note}}}}
| bgcolor="#3A3A3A" align="center" | Add custom notices.
| bgcolor="#3A3A3A" | {{CodeBlock|margin=5px|<nowiki>| note=Lorem ipsum</nowiki>}}
| bgcolor="#3A3A3A" | {{Software status|nocat=1|appid=2600|deck = verified|type=game|note={{lorem}}}}
|}

== Previews and testcases ==
* Use {{code|<nowiki>{{Software status|type=game}}</nowiki>}} for:
{{Software status|type=game|nocat=1}}

=== System Requirements<span id="Sysreq"><!--Used by Sysreq template, clicking on "See system requirements" will send you to this section.--></span> ===
If you have clicked on the ("'''See system requirements'''") button on the template, it should send you to this section.

=== Similar templates ===
* {{t|Package}} - For packages.

{{Note|To avoid slowing down loading times, see more examples on [[/testcases|Testcases page]].}}