View source for Template:Software status/doc

{{Doc/subpage}}
This is a replacement of {{t|Game release}} template and other based off this template, combining all of these into one. When this template was good enough, the original "{{t|Game release}}", "{{t|Game announced}}" (and variants of this templates, or similar) will be replaced with something similar to {{t|Banned spammer}}, a redirect page that automatically calls {{t|Software status}} with {{param|type|game}} instead.

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 Chromebook ready or Steam Deck verified.
== Translations ==
{{Strings notice}}

Translations for this template are located in [[/strings|strings subpage]], it uses the {{t|Autolang}} template.

== Copy and paste ==
=== For anything else ===
{{CodeBlock|<nowiki>{{Software status
		| appid = <appid>
		| type = <games/mods/tools>
		| free = <yes/no> <!-- optional, can be removed. - "No" by default -->
		| status = <announced/available/delisted/delisted-dl/earlyaccess (ea)/in development (dev/indev)> <!-- More values is available on testcases page. -->
		| os = all <!-- See template testcases for more values. -->
		| deck = <deck status> <!-- By default: Unknown. -->
		| chromebook = <Chromebook ready status>
		| 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>}}

=== 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 ==
{| class="standard-table" style="width:100%"
! style="width:15%" | {{Dictionary/common|Param}}
! style="text-align:center" | {{Dictionary/common|Desc}}
! style="text-align:center" | Value
! {{Dictionary/common|Previews}}
|-
| align="center" | {{Code|style=2|{{Param|type}}}}
| align="center" |Type of software, see more value on [[/testcases|testcases page]].<br> '''This must be specified'''.
| {{CodeBlock|margin=5px|<nowiki>| type = games</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| type = mods</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| type = tools</nowiki>}}
| {{Software status|nocat=1|appid = 220|type=mod}}<br>{{Software status|nocat=1|appid = 220|type=tools}}
|-
| align="center" | {{Code|style=2|{{Param|appid}}}}
| align="center" |Set the AppID for the software
| {{CodeBlock|margin=5px|<nowiki>| appid = 220</nowiki>}}
| {{Software status|nocat=1|appid = 220|type=game}}
|-
| align="center" | {{Code|style=2|{{Param|free}}}}
| 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.
| {{CodeBlock|margin=5px|<nowiki>| free = yes/no</nowiki>}}
| {{Software status|nocat=1|free = yes|type=game}}
|-
| align="center" | {{Code|style=2|{{Param|status}}}}
| 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|testcases page]].
| {{CodeBlock|margin=5px|<nowiki>| status = delisted</nowiki>}}{{CodeBlock|margin=5px|<nowiki>| status = ea</nowiki>}}
| {{Software status|nocat=1|status = delisted|type=game}}<br>{{Software status|nocat=1|status = ea|type=game}}
|-
| align="center" | {{Code|style=2|{{Param|os}}}}
| align="center" |Supported OS for the game, software, etc..., more can be found on [[/testcases|testcases page]].
| {{CodeBlock|margin=5px|<nowiki>| os = win</nowiki>|type=game}}
| {{Software status|nocat=1|os = win|type=game}}
|-
| align="center" | {{Code|style=2|{{Param|deck}}}}
| align="center" |Steam Deck support status, more value can be found on [[/testcases|testcases page]].
| {{CodeBlock|margin=5px|<nowiki>| deck = verified</nowiki>|type=game}}
| {{Software status|nocat=1|deck = verified|type=game}}
|-
| align="center" | {{Code|style=2|{{Param|chromebook}}}}
| align="center" |'''(EXPERIMENTAL)''' Chromebook ready status, more value can be found on [[/testcases|testcases page]].
| {{CodeBlock|margin=5px|<nowiki>| chromebook = playable </nowiki>|type=game}}
| {{Software status|nocat=1|chromebook = playable|type=game}}
|-
| align="center" | {{Code|style=2|{{Param|3rdpartystore}}}}
| 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 "•".
| {{CodeBlock|margin=5px|<nowiki>| 3rdpartylinks={{gog|vampire_the_masquerade_bloodlines|GOG.com}}</nowiki>|type=game}}
| {{Software status|nocat=1|appid=2600|deck = verified|type=game|3rdpartylinks={{gog|vampire_the_masquerade_bloodlines|GOG.com}}}}
|-
| align="center" | {{Code|style=2|{{Param|note}}}}
| align="center" | Add custom notices.
| {{CodeBlock|margin=5px|<nowiki>| note=Lorem ipsum</nowiki>}}
| {{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}}

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