Template:Software status/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(→‎Parameters and Examples: - Changed table design)
Line 46: Line 46:


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



Revision as of 01:35, 21 March 2024

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

This is a replacement of {{Game release}} template and other based off this template, combining all of these into one. When this template was good enough, the original "{{Game release}}", "{{Game announced}}" (and variants of this templates, or similar) will be replaced with something similar to {{Banned spammer}}, a redirect page that automatically calls {{Software status}} with {{{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.

Copy and paste

For anything else

{{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... --> }}

System requirements section

To make the "See system requirements" button work, you must use this header:

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> ==

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 {{Sysreq}} for more info.

For announced games

See code
{{Software status | appid = <appid> | type = games | free = <!-- doesn't do anything with announced, but still useful --> | status = announced | deck = hide | website = <!-- Optional --> }}

To prevent categorization, add the following parameters:

| nocat = 1

Parameters and Examples

Parameter Description Value Previews
{{{type}}} Type of software, see more value on testcases page.
This must be specified.
| type = games
| type = mods
| type = tools

{{{appid}}} Set the AppID for the software
| appid = 220
{{{free}}} Is this software free?
If {{{free}}}=no or left blanks, mark the software as paid, if {{{free}}}=yes, mark it as a free software.
| free = yes/no
{{{status}}} Availability of the software, by default, it is marked as "available". If the game was delisted on Steam, set {{{status}}} to delisted
If this game is currently in Early Access, set {{{status}}} to ea or earlyaccess.
More value can be found on testcases page.
| status = delisted
| status = ea

{{{os}}} Supported OS for the game, software, etc..., more can be found on testcases page.
| os = win
{{{deck}}} Steam Deck support status, more value can be found on testcases page.
| deck = verified
{{{chromebook}}} (EXPERIMENTAL) Chromebook ready status, more value can be found on testcases page.
| chromebook = playable
{{{3rdpartystore}}} Used to put 3rd party stores links. Works similarly to "note" parameters.
Recommended templates:
{{gog}}
{{epic}}
{{gplay}} (for Nvidia Shield port), etc...
For spacing, use "•".
| 3rdpartylinks={{gog|vampire_the_masquerade_bloodlines|GOG.com}}
{{{note}}} Add custom notices.
| note=Lorem ipsum

Previews and testcases

  • Use {{Software status|type=game}} for:

System Requirements

If you have clicked on the ("See system requirements") button on the template, it should send you to this section.

Note.pngNote:To avoid slowing down loading times, see more examples on Testcases page.