Module:Icon/doc: Difference between revisionsGive feedback
created main doc |
m mc |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Main module for rendering icons | Main module for rendering game icons. | ||
'''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 [[User:Deadbot|Deadbot]] at deploy time. When the bot uploads new game files, hero, ability, and item icons update automatically. | |||
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. | |||
See [[Module:Icon/data]] for manual overrides, legacy items, aliases, and renames used by this module. | |||
== Usage == | == Usage == | ||
* {{tl|HeroIcon}} | Any of the following templates can be used. The module automatically detects the icon type: | ||
* {{tl|AbilityIcon}} | * {{tl|HeroIcon}} | ||
* {{tl|ItemIcon}} | * {{tl|AbilityIcon}} | ||
* {{tl|ItemIcon}} | |||
* {{tl|EntityIcon}} | |||
'''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). | |||
== Error tracking == | |||
Icons that fail to render are added to [[:Category:Module:Icon ERROR]]. | |||
<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude> | |||
Latest revision as of 02:22, 23 May 2026
Main module for rendering game icons.
Note: This module is not intended for direct use. Use the templates below.
Data sources
[edit source]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, hero, ability, and item icons update automatically.
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.
See Module:Icon/data for manual overrides, legacy items, aliases, and renames used by this module.
Usage
[edit source]Any of the following templates can be used. The module automatically detects the icon type:
{{HeroIcon}}{{AbilityIcon}}{{ItemIcon}}{{EntityIcon}}
Note: While all four templates work identically, it is recommended to use the appropriate one for clarity (e.g., use {{AbilityIcon|Siphon Life}} even though {{HeroIcon|Siphon Life}} will also work).
Error tracking
[edit source]Icons that fail to render are added to Category:Module:Icon ERROR.