Template:ModStatus/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
 
Line 7: Line 7:
<p style="text-align:left;margin-left:1.5em;"><span style="float:left;margin-right:.5em;">'''Usage:'''</span><code style="overflow:auto;display:block;">&#123;&#123;ModStatus <br />
<p style="text-align:left;margin-left:1.5em;"><span style="float:left;margin-right:.5em;">'''Usage:'''</span><code style="overflow:auto;display:block;">&#123;&#123;ModStatus <br />
| engine = ''<GoldSrc/Source/Source2>'' <br />
| engine = ''<GoldSrc/Source/Source2>'' <br />
| branch = ''<Source 2004/Source 2006/src04/src06/l4dbranch/...>'' <br />
| game = ''<Episode Two/Portal/...>'' <br />
| game = ''<Episode Two/Portal/...>'' <br />
| mode = ''<sp/mp/both/co-op>''<br />
| mode = ''<sp/mp/both/co-op>''<br />
Line 18: Line 19:


* If '''<code>size=<nowiki><big></nowiki></code>''' is included, this will make the box span across the top of the page.
* If '''<code>size=<nowiki><big></nowiki></code>''' is included, this will make the box span across the top of the page.
* If {{code|branch}} is specified, adds the page to {{code|Category:Source (version) engine branch mods}}. This is optional. This parameter relies on {{ent|Template:SourceBranchCategory}}.
* Please do not include '''<code>game</code>''' if the mod is based on [[Source SDK Base]] or one of its variants
* Please do not include '''<code>game</code>''' if the mod is based on [[Source SDK Base]] or one of its variants
* If you are including a '''<code>download</code>''' URL, then unless you are 100% sure you will never make another release link to your downloads page and ''not'' directly to the file. That way the URL won't need to be changed every time you come out with a new version of your mod.
* If you are including a '''<code>download</code>''' URL, then unless you are 100% sure you will never make another release link to your downloads page and ''not'' directly to the file. That way the URL won't need to be changed every time you come out with a new version of your mod.

Latest revision as of 06:13, 31 March 2025

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

Usage

Displays a status box on your mod's page, and adds it to the appropriate categories.

Usage:{{ModStatus
| engine = <GoldSrc/Source/Source2>
| branch = <Source 2004/Source 2006/src04/src06/l4dbranch/...>
| game = <Episode Two/Portal/...>
| mode = <sp/mp/both/co-op>
| status = <alpha/beta/released/hold/dead>
| size = <big> (Optional)
| side = <Right (Optional)/Left>
| image = <SomeFile.jpg>
| download = <url>
| apply = <url>
}}

  • If size=<big> is included, this will make the box span across the top of the page.
  • If branch is specified, adds the page to Category:Source (version) engine branch mods. This is optional. This parameter relies on Template:SourceBranchCategory.
  • Please do not include game if the mod is based on Source SDK Base or one of its variants
  • If you are including a download URL, then unless you are 100% sure you will never make another release link to your downloads page and not directly to the file. That way the URL won't need to be changed every time you come out with a new version of your mod.
  • Do not mark a mod dead if it ceased development after making a final (or near-final) release. Mark it released.
  • If size=big side parameter doesn't works.