Module:Icon/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
LVL (talk | contribs)
Updated icon doc to reflect new change
LVL (talk | contribs)
Added explanation about legacyitems
Line 5: Line 5:
== Data Sources ==
== Data Sources ==
The module reads from [[Data:ResourceLookup.json]], a pre-indexed lookup table generated by [[User:Deadbot|Deadbot]] at deploy time. When the bot uploads new game files, icons update automatically.
The module reads from [[Data:ResourceLookup.json]], a pre-indexed lookup table generated by [[User:Deadbot|Deadbot]] at deploy time. When the bot uploads new game files, icons update automatically.
=== Legacy Items ===
Items that have been removed from the game files but still exist on the wiki (e.g., in "Unused" sections) are stored in a local <code>legacyItems</code> table within the module. This ensures icons for historical items continue to render correctly even after the bot removes them from the data JSON.
To add a new legacy item, edit the <code>legacyItems</code> table in [[Module:Icon]].


== Usage ==
== Usage ==

Revision as of 14:35, 26 March 2026

Main module for rendering game icons (heroes, abilities, and items).

Note: This module is not intended for direct use. Use the templates below.

Data Sources

The module reads from Data:ResourceLookup.json, a pre-indexed lookup table generated by Deadbot at deploy time. When the bot uploads new game files, icons update automatically.

Legacy Items

Items that have been removed from the game files but still exist on the wiki (e.g., in "Unused" sections) are stored in a local legacyItems table within the module. This ensures icons for historical items continue to render correctly even after the bot removes them from the data JSON.

To add a new legacy item, edit the legacyItems table in Module:Icon.

Usage

Any of these templates work for any icon type (hero, ability, or item). The module auto-detects the type:

  • {{HeroIcon}} - Can display heroes, abilities, or items
  • {{AbilityIcon}} - Can display heroes, abilities, or items
  • {{ItemIcon}} - Can display heroes, abilities, or items

Note: While all three templates work identically, you can use whichever name makes the wiki source code more readable (e.g., use {{AbilityIcon|Siphon Life}} for clarity even though {{HeroIcon|Siphon Life}} works the same).

Error Tracking

Icons that fail to render are tracked in: Category:Module:Icon ERROR

Aliases

Some icons have alternate names that redirect to the correct entry:

  • "Doorman" → "The Doorman"
  • "Mo and Krill" / "Mo" / "Krill" → "Mo & Krill"
  • "Curse" → "Cursed Relic"
  • "Debuff Remover" → "Dispel Magic"

To add new aliases, edit the aliases table in Module:Icon.