Template:Game release free/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)
 
(25 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation_subpage}}
{{Todo|Port all translations to [[Template:Software status]], before deprecating this template and turning it into a template redirect like [[Template:Banned spammer]] does.}}
{{Important|It is now recommended to use {{t|Software status}} instead. This template will be soon deprecated, the original template will be kept for compatibility with pages that haven't been updated.}}
 
==Translations==
{{Warning|From now on, add translations to {{t|Software status}} instead. This strings translation page along with templates itself will be soon partially deprecated, turning it into some kind of redirect.}}
<!-- SEE NOTICE ABOVE.-->
 
Some used strings are on the regular [[Template:Game release/strings|Game release's 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.<br> Some of them can be only found on the /strings subpage.}}
 
==Usage==
{{syntax|<nowiki>{{game release free|appid=<game appid>}}</nowiki>}}
{{syntax|<nowiki>{{game release free|appid=<game appid>}}</nowiki>}}
'''Optional:'''
'''Optional:'''
Line 7: Line 18:
{| class="standard-table plainlinks"
{| class="standard-table plainlinks"
! Parameters
! Parameters
! Result
! 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>
| <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.
| Set the AppID for the "<span style="color: #86BF39">'''Launch it now'''</span> or visit it's store page via "<span style="color: yellow">'''Browser'''</span> and <span style="color: yellow">'''Steam'''</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</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</code>
| <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 "'''Supported Systems:'''"
| 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</code>
| <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 "{{windows|4}}"
| 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</code>
| <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 "{{mac|4}}"
| 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</code>
| <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 "{{linux|4}}"
| 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 or set it to {{code|unknown}} 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>
| <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>
Line 28: Line 42:
|-
|-
|}
|}
== Example and preview ==
*'''By default (with nothing on it):'''
{{game release free}}


Leaving the <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>|sys=true|win=true|mac=true|linux=true|note=<insert text here></nowiki></code> omitted will hide the Supported Systems, OS and Notices.
*'''App ID set - {{tf2|4}}:'''
{{game release free|appid=440}}


== Example ==
*'''Everything marked as {{code|true}}:'''
{{game release free|appid=220|sys=true|win=true|mac=true|linux=true|note=This is an example text.}}
{{game release free|appid=440|sys=true|win=true|mac=true|linux=true|note=This is an example text.}}
== See Also ==
 
*'''Everything marked as {{code|false}}:'''
{{game release free|appid=440|sys=false|win=false|mac=false|linux=false|note=This is an example text.}}
 
== Deck Verified Status ==
*'''Default/leave blank (Unknown/Untested) and {{code|deck{{=}}unknown}}:'''
{{game release free|appid=440|sys=false|win=false|mac=false|linux=false|deck=|note=Verified Status Test}}
 
*'''Verified: ({{code|deck{{=}}verified}})'''
{{game release free|appid=440|sys=false|win=false|mac=false|linux=false|deck=verified|note=Verified Status Test}}
 
*'''Playable: ({{code|deck{{=}}hide}})'''
{{game release free|appid=440|sys=false|win=false|mac=false|linux=false|deck=playable|note=Verified Status Test}}
 
*'''Unsupported: ({{code|deck{{=}}unsupported}})'''
{{game release free|appid=440|sys=false|win=false|mac=false|linux=false|deck=unsupported|note=Verified Status Test}}
 
*'''Hides the status: ({{code|deck{{=}}hide}})'''
{{game release free|appid=440|sys=false|win=false|mac=false|linux=false|deck=hide|note=Verified Status Test}}
 
== See also ==
=== Software status (unified) ===
*[[Template:Software status]] - Recommended.
=== Game release + demo ===
*[[Template:Game release]] - For paid games.
*[[Template:Game release]] - For paid games.
*'''Template:Game release free''' - You are currently viewing this page
*[[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.
*[[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]] - For paid games that are delisted on Steam.
*[[Template:Game delisted free]] - For free 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]] - Paid version of Software/Tools.
*[[Template:Software release free]] - Free 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 05:54, 7 January 2024

Edit-copy.png
This is a documentation subpage for Template:Game release free.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Todo: Port all translations to Template:Software status, before deprecating this template and turning it into a template redirect like Template:Banned spammer does.
Icon-Important.pngImportant:It is now recommended to use {{Software status}} instead. This template will be soon deprecated, the original template will be kept for compatibility with pages that haven't been updated.

Translations

Warning.pngWarning:From now on, add translations to {{Software status}} instead. This strings translation page along with templates itself will be soon partially deprecated, turning it into some kind of redirect.

Some used strings are on the regular Game release's 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.
Some of them can be only found on the /strings subpage.

Usage

Syntax: {{game release free|appid=<game appid>}} Optional: Put {{game release free|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 visit it's store page via "Browser and Steam" 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 or set it to unknown will show Unknown Unknown. Set to hide will hide it.
note=<insert text here> Shows notices with custom text.

Example and preview

  • By default (with nothing on it):
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*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
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*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
  • Everything marked as true:
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*Only works if Steam has been installed, please install Steam if you haven't already.
Supported Systems for this game: Windows Windows macOS macOS Linux Linux + SteamOS SteamOS
Steam Deck support status: Unknown Unknown - More info on ProtonDB
Notice: This is an example text.
  • Everything marked as false:
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*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
Notice: This is an example text.

Deck Verified Status

  • Default/leave blank (Unknown/Untested) and deck=unknown:
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*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
Notice: Verified Status Test
  • Verified: (deck=verified)
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*Only works if Steam has been installed, please install Steam if you haven't already.
Steam Deck support status: Verified Verified - More info on ProtonDB
Notice: Verified Status Test
  • Playable: (deck=hide)
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*Only works if Steam has been installed, please install Steam if you haven't already.
Steam Deck support status: Playable Playable - More info on ProtonDB
Notice: Verified Status Test
  • Unsupported: (deck=unsupported)
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*Only works if Steam has been installed, please install Steam if you haven't already.
Steam Deck support status: Unsupported Unsupported - More info on ProtonDB
Notice: Verified Status Test
  • Hides the status: (deck=hide)
Steam logo - CTRL + F5 or purge if not loading correctly.
Game release free/doc is currently available on Steam, for free. Launch it now* or visit its store page on (Browser | Steam*).
*Only works if Steam has been installed, please install Steam if you haven't already.
Notice: Verified Status Test

See also

Software status (unified)

Game release + demo

  • Template:Game release - For paid games.
  • Template:Game release free - You are currently viewing this page
  • 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_free/doc&oldid=370915"