The Deadlock Wiki

Module:Icon/doc: Difference between revisions

Browse history interactively
← Older edit

Mgpt (talk | contribs)

1 user group
3,193 edits
undo
VisualWikitext
LVL (talk | contribs)
Contributors, Interface administrators, Moderators
4,834 edits
Updated icon doc to reflect new change
m mc
 
(5 intermediate revisions by 2 users not shown)
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, hero, ability, and item icons update automatically.


== Usage ==
An additional resource for other icons can be found at [[Data:ResourceLookup2.json]], a manually maintained table; some entries may rely on a dictionary key.
Any of these templates work for any icon type (hero, ability, or item). The module auto-detects the type:


* {{tl|HeroIcon}} - Can display heroes, abilities, or items
See [[Module:Icon/data]] for manual overrides, legacy items, aliases, and renames used by this module.
* {{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).
== Usage ==
 
Any of the following templates can be used. The module automatically detects the icon type:
== Error Tracking ==
* {{tl|HeroIcon}}
Icons that fail to render are tracked in: [[:Category:Module:Icon ERROR]]
* {{tl|AbilityIcon}}
* {{tl|ItemIcon}}
* {{tl|EntityIcon}}


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