Module:Mods/list/doc

Documentation

[purge]

To add new mods to the list, add to the modsByAbbrv table. Keys are mod abbreviations, while values are a table of

{ link, optional unlocalized name, localized name }

where the middle entry only needs to be present if it's not the same as the link.

Exports

byName

Table, keys are mod names, values are mod information tables

byAbbrv

Table, keys are mod abbreviations, values are mod information tables.

Mod information tables

Key	Value
link	Name of the mod's page, without the language suffix
name	Name of the mod, unlocalized
localized	Name of the mod, localized

Abbreviation conventions

There are a few conventions for abbreviated mod names:

• Abbreviations should, of course, be based off the mod name.
• Use only the characters A to Z, 0 to 9, and -. Any other characters (including spaces) are not allowed.
• Smaller mods should use longer abbreviations, as the abbreviations are rarely used. For examples, BunnyTech is abbreviated as BUNTCH, and Long Fall Boots is abbreviated as LONGFALLBO.
• Larger mods should use shorter abbreviations when possible. For example, Tinkers' Construct is abbreviated as TC.
• When possible, mods that have common abbreviations should use those abbreviations. For example, IndustrialCraft 2 is abbreviated as IC2, and Thaumcraft 5 is abbreviated as TC5.
• One-character abbreviations should usually not be used unless the mod is very large and/or the abbreviation is very commonly used. For example, Vanilla Minecraft is abbreviated as V.

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.