Template:Game release/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (Unicodifying, replaced: {{ModernWarning| → {{warning|, See Also → See also, {{windows → {{win)
 
(46 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Doc/subpage}}
{{Documentation_subpage}}
 
== Translations ==
{{Strings notice}}
Some of them are using strings, which are on [[/strings|strings subpage]]. Please follow the format to add translations for them.<br> To edit/translate the ProtonDB and the Steam purchase/free download link, please edit the main template itself instead due to a bug which requires workaround.
{{warning|Translation are not 100% accurate, some of those are done via Google Translate, it will need some improvements!<br>Some other languages may not fully translated.}}
 
==Usage==
{{syntax|<nowiki>{{game release|appid=<game appid>}}</nowiki>}}
{{syntax|<nowiki>{{game release|appid=<game appid>}}</nowiki>}}
'''Optional:'''
'''Optional:'''
Put <code><nowiki>{{game release|appid=<game appid>|sys=true|win=true|mac=true|linux=true|note=<insert text here>}}</nowiki></code> to show all supported systems (Win, Mac, Linux + SteamOS).  
Put <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}"><nowiki>{{game release|appid=<game appid>|sys=true|win=true|mac=true|linux=true|note=<insert text here>}}</nowiki></code> to show all supported systems (Win, Mac, Linux + SteamOS).  
'''Example below:'''
 
{{game release|appid=220|sys=true|win=true|mac=true|linux=true|note=This is an example text.}}
== Parameters ==
{| class="standard-table plainlinks"
! Parameters
! Description
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">appid=<game/software appid></code>
| Set the AppID for the "<span style="color: #86BF39">'''Launch it now'''</span> or <span style="color: yellow">'''buy it here'''</span>" button.
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">sys=<true/false></code> or <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}"><show/hide></code>
| Shows or Hide "'''Supported Systems:'''"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">win=<true> or <false></code>
| Shows or Hide "{{win|4}}"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">mac=<true> or <false></code>
| Shows or Hide "{{mac|4}}"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">linux=<true> or <false></code>
| Shows or Hide "{{linux|4}}"
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">deck=<see value on the left></code>
| This will show the Steam Deck verified status. <br>Available values: <br>{{code|verified}} = {{steamdeck verified|4}} <br>{{code|playable}} = {{steamdeck playable|4}} <br>{{code|unsupported}} = {{steamdeck unsupported|4}}. <br>Leave blank will show {{steamdeck unknown|4}}. Set to {{code|hide}} will hide it.
|-
| <code style="background:{{{bg|{{{background|rgb(0,0,0,.35)}}}}}}; border-radius:3px; color: {{{color|currentcolor}}}; padding:2px 3px; user-select:{{#switch:{{{select}}}|#default=text|1=all|2=none}}">note=<insert text here></code>
| Shows notices with custom text. Removing it will hide the "'''Notice:'''" text.
|-
|}
 
== Example and preview ==
{{game release|appid=220}}
See [[/testcases|Testcases]] page for more.
 
== See also ==
{{Todo|Merging all of these into one templates (currently W.I.P as {{tl|Software status}}).}}
=== Software status (unified) ===
*[[Template:Software status]] - Recommended.
=== Game release + demo ===
*'''Template:Game release''' - You are currently viewing this page
*[[Template:Game release free]] - For Games that are released for free.
*[[Template:Game demo]] - For paid games, with a free demo available. Or simply just have a demo-only release available.
=== Mod release ===
*[[Template:Mod release]] - For Mods that are released on Steam.
=== Delisted games ===
*[[Template:Game delisted]] - For paid games that are delisted on Steam.
*[[Template:Game delisted free]] - For free games that are delisted on Steam.
*[[Template:Game delisted free downloadable]] - Same as above, but instead you cannot view it's store page and still able to download the game using Steam URLs workaround.
=== Software release ===
*[[Template:Software release]] - Paid version of Software/Tools.
*[[Template:Software release free]] - Free version of Software/Tools.
{{Doc/Sandbox other|[[Category:Templates]]}}
{{Doc/Sandbox other|[[Category:Templates]]}}

Latest revision as of 07:00, 7 January 2024

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

Translations

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

Some of them are using strings, which are on strings subpage. Please follow the format to add translations for them.
To edit/translate the ProtonDB and the Steam purchase/free download link, please edit the main template itself instead due to a bug which requires workaround.

Warning.pngWarning:Translation are not 100% accurate, some of those are done via Google Translate, it will need some improvements!
Some other languages may not fully translated.

Usage

Syntax: {{game release|appid=<game appid>}} Optional: Put {{game release|appid=<game appid>|sys=true|win=true|mac=true|linux=true|note=<insert text here>}} to show all supported systems (Win, Mac, Linux + SteamOS).

Parameters

Parameters Description
appid=<game/software appid> Set the AppID for the "Launch it now or buy it here" button.
sys=<true/false> or <show/hide> Shows or Hide "Supported Systems:"
win=<true> or <false> Shows or Hide "Windows Windows"
mac=<true> or <false> Shows or Hide "macOS macOS"
linux=<true> or <false> Shows or Hide "Linux Linux"
deck=<see value on the left> This will show the Steam Deck verified status.
Available values:
verified = Verified Verified
playable = Playable Playable
unsupported = Unsupported Unsupported.
Leave blank will show Unknown Unknown. Set to hide will hide it.
note=<insert text here> Shows notices with custom text. Removing it will hide the "Notice:" text.

Example and preview

Steam logo - CTRL + F5 or purge if not loading correctly.
Game release/doc is currently available on Steam. Launch it now* or buy it from Steam (via browser or Steam client).
*Only works if Steam has been installed, please install Steam if you haven't already.
Steam Deck support status: Unknown Unknown - More info on ProtonDB

See Testcases page for more.

See also

Todo: Merging all of these into one templates (currently W.I.P as {{Software status}}).

Software status (unified)

Game release + demo

  • Template:Game release - You are currently viewing this page
  • Template:Game release free - For Games that are released for free.
  • Template:Game demo - For paid games, with a free demo available. Or simply just have a demo-only release available.

Mod release

Delisted games

Software release

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Game_release/doc&oldid=371079"