Template:ModuleInfobox/doc: Difference between revisions
(Create documentation) |
No edit summary |
||
Line 22: | Line 22: | ||
The title, type, creator, and versions parameters should always be set. | The title, type, creator, and versions parameters should always be set. | ||
"title" - name of the module | "title" - name of the module | ||
"type" - module type (Stand Alone, Base, Expansion, Reliant) | "type" - module type (Stand Alone, Base, Expansion, Reliant) | ||
"creator" - original creator of the module | "creator" - original creator of the module | ||
"versions" - the MC versions that the latest module version works with | "versions" - the MC versions that the latest module version works with | ||
If the module doesn't have an image, do not fill in the "icon" parameter. It will default to the GM4 logo if unset. | 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 "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 "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 "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 "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. |
Revision as of 21:11, 2 May 2020
[[File:{{{icon}}}]] | |
-------------------- | |
---|---|
Module Type | {{{type}}} |
Created by | creator |
Last Updated by | updater |
Required Modules | {{{requires}}} |
Complementary Modules | {{{complementary}}} |
Incompatible Modules | {{{incompatible}}} |
Latest MC Version(s) | {{{versions}}} |
This is an example Module Infobox, showing all available parameters.
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
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.