Template:Mod release/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (clean up, replaced: See Also → See also, {{windows → {{win, {{Documentation subpage → {{Doc/subpage)
 
(22 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Documentation subpage
{{Doc/subpage}}
| content = {{syntax|<nowiki>{{mod release|appid=<game appid>}}</nowiki>}}
{{syntax|<nowiki>{{mod release|appid=<game appid>}}</nowiki>}}
'''Optional:'''
'''Optional:'''
Put <code><nowiki>{{mod 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).  
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>{{mod release|game={{hl2|3.1}}|appid=<game appid>|sys=true|win=true|mac=true|linux=true|deck=verified|note=<insert text here>}}</nowiki></code> to show all supported systems (Win, Mac, Linux + SteamOS), game/mod notices, aswell as game name and Deck status to verified.
'''Example below:'''
 
{{mod release|appid=17520|sys=true|win=true|mac=true|linux=true|note=This is an example text.}}
== Parameters ==
}}
{| class="standard-table plainlinks"
! Parameters
! Result
|-
| <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">visit the store</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}}">game=<game name></code>
| Set the game name. Example/Preview: {{code|<nowiki>{{hl2|3.1}}</nowiki>}} > {{hl2|3.1}}.
|-
| <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>
| Show 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>
| Show 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>
| Show 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>
| Show 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>
| Shows notices with custom text.
|-
|}
 
==Example + Preview==
<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>{{mod release|game={{hl2|3.1}}|appid=17520|sys=true|win=true|mac=true|linux=true|deck=playable|note=This is an example text.}}</nowiki></code> will show this:
{{mod release|game={{hl2|3.1}}|appid=17520|sys=true|win=true|mac=true|linux=true|deck=playable|note=This is an example text.}}
== See also ==
=== Game release + demo ===
*[[Template:Game release]] - For paid games.
*[[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''' - You are currently viewing this page
=== 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]]}}

Latest revision as of 02:25, 12 January 2024

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

Syntax: {{mod release|appid=<game appid>}} Optional: Put {{mod release|game={{hl2|3.1}}|appid=<game appid>|sys=true|win=true|mac=true|linux=true|deck=verified|note=<insert text here>}} to show all supported systems (Win, Mac, Linux + SteamOS), game/mod notices, aswell as game name and Deck status to verified.

Parameters

Parameters Result
appid=<game/software appid> Set the AppID for the "Launch it now or visit the store" button.
game=<game name> Set the game name. Example/Preview: {{hl2|3.1}} > Half-Life 2.
sys=<true/false> or <show/hide> Show or Hide "Supported Systems:"
win=true Show or Hide "Windows Windows"
mac=true Show or Hide "macOS macOS"
linux=true Show 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 + Preview

{{mod release|game={{hl2|3.1}}|appid=17520|sys=true|win=true|mac=true|linux=true|deck=playable|note=This is an example text.}} will show this:

Logo-Steam-white-notext.png
This mod for Half-Life 2 is currently available on Steam. Launch it now* or visit it's store page via (Browser | Steam*).
For more information, click here to learn more about mods on 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: Playable Playable
Notice: This is an example text.

See also

Game release + demo

Mod release

  • Template:Mod release - You are currently viewing this page

Delisted games

Software release

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