Template:ModuleInfobox: Difference between revisions
(Make icon field suggested so it does appear when editing) |
m (Add resource pack compatibility for module infoboxes) |
||
| Line 11: | Line 11: | ||
| Stand Alone = Stand Alone {{#if: {{{retired|}}}| | [[Category: All Modules]] [[Category:Stand Alone Modules]] }} | | Stand Alone = Stand Alone {{#if: {{{retired|}}}| | [[Category: All Modules]] [[Category:Stand Alone Modules]] }} | ||
| Library = Library [[Category: All Modules]][[Category: Library]] | | Library = Library [[Category: All Modules]][[Category: Library]] | ||
|''unknown'' | | Resource | ||
| Resource Pack = [[Category: Resource Pack Only]] | |||
| ''unknown'' | |||
}} | }} | ||
| label3 = Created by | | label3 = Created by | ||
| Line 25: | Line 27: | ||
| label8 = Compatible MC Versions | | label8 = Compatible MC Versions | ||
| data8 = {{#if: {{{retired|}}} | {{#ifeq: {{{retired|}}} | true | ''none'' | Retired since {{{retired}}} }} | {{{versions|''unknown''}}} }} | | data8 = {{#if: {{{retired|}}} | {{#ifeq: {{{retired|}}} | true | ''none'' | Retired since {{{retired}}} }} | {{{versions|''unknown''}}} }} | ||
| label9 = Resource Pack | |||
| data9 = {{#switch: {{{resource|}}} | |||
| Required = Required | |||
| Optional = Optional | |||
| | |||
}} | |||
}} | |||
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
{{Documentation}} | {{Documentation}} | ||
Revision as of 19:32, 13 October 2024
| [[File:{{{icon}}}]] | |
| Module Type | {{{type}}} |
|---|---|
| Created by | creator |
| Last Updated by | updater |
| Required Modules | {{{requires}}} |
| Complementary Modules | {{{complementary}}} |
| Incompatible Modules | {{{incompatible}}} |
| Compatible MC Versions | {{{versions}}} |
 | |
| Module Type | unknown |
|---|---|
| Created by | unknown |
| Compatible MC Versions | unknown |
}}
This is an example Module Infobox, showing all available parameters.
Below that is the default Infobox, if no parameters are set.
The title, type, creator, and versions parameters should always be set.
"title" - name of the module
"type" - module type (Stand Alone, Base, Expansion, Reliant)
"creator" - original creator of the module
"versions" - the MC versions that the latest module version works with
The "icon" parameter should refer to the image file stored on the wiki. Icons should be named the same as the module name in snake_case (e.g. custom_crafters.png)
If the module doesn't have an image, do not fill in the "icon" parameter. It will default to the GM4 logo if unset.
The "updater" parameter is used only if the latest version of the module was modified by a specific user such that performance or mechanics were changed. This parameter should be the same as displayed on the module download page.
The "requires" parameter should be set if the module is a reliant module or expansion pack, and should link to the page of the base module.
The "complementary" parameter should be set to whatever modules are listed on the download page as a complementary module. Any listed module should be linked to their respective page.
The "incompatible" parameter should be set only if there are modules that conflict with other modules, though this case is very rare, and is more of a remnant before Gamemode 4 became heavily focused on compatibility.
| The above documentation is transcluded from Template:ModuleInfobox/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
The infoxbox on the right of module pages
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | Name
| Line | deprecated |
| Icon | icon | Icon
| File | deprecated |
| Type | type | Module Type (Base, Expansion, Reliant, Discontinued)
| Line | suggested |
| Creator | creator | List of authors upon release/initial publish
| Line | suggested |
| Updater | updater | List of everyone who has updated the module by a significant amount
| Line | suggested |
| Requires | requires | List of modules required for this module to function
| Line | suggested |
| Complementary | complementary | A list of complementary modules
| Line | suggested |
| Incompatible | incompatible | A list of incompatible modules | Line | optional |
| Versions | versions | The range of versions that this module has ever supported
| Line | suggested |
| Retired | retired | Module retirement version
| Line | optional |