Module:Icon/doc: Difference between revisions

Jump to navigation Jump to search
Browse history interactively
← Older editNewer edit →

Mgpt (talk | contribs)

1 user group
3,193 edits
undo
VisualWikitext
LVL (talk | contribs)
Contributors, Interface administrators, Moderators
4,834 edits
Added explanation about legacyitems
New doc version. Moved table info.
Line 1: Line 1:
Main module for rendering game icons (heroes, abilities, and items).
Main module for rendering game icons.


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


== 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 ===
An additional resource for other icons can be found at [[Data:ResourceLookup2.json]], a manually maintained table used for other icons; some entries may rely on a dictionary key.
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]].
See also: [[Module:Icon/data]]


== Usage ==
== Usage ==
Any of these templates work for any icon type (hero, ability, or item). The module auto-detects the type:
Any of the following templates work for any icon type. The module auto-detects the type:
* {{tl|HeroIcon}}
* {{tl|AbilityIcon}}
* {{tl|ItemIcon}}
* {{tl|EntityIcon}}


* {{tl|HeroIcon}} - Can display heroes, abilities, or items
'''Note:''' While all four templates work identically, it is recommended to use the correct template (e.g., use <nowiki>{{AbilityIcon|Siphon Life}}</nowiki> for clarity even though <nowiki>{{HeroIcon|Siphon Life}}</nowiki> will work).
* {{tl|AbilityIcon}} - Can display heroes, abilities, or items 
* {{tl|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 <nowiki>{{AbilityIcon|Siphon Life}}</nowiki> for clarity even though <nowiki>{{HeroIcon|Siphon Life}}</nowiki> works the same).
== Error tracking ==
 
Icons that fail to render are added to [[:Category:Module:Icon ERROR]].<includeonly>[[:Category:Modules]]</includeonly><noinclude>[[:Category:Module documentation]]</noinclude>
== 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]].
Retrieved from "https://deadlock.wiki/Module:Icon/doc"