Module:Icon/doc: Difference between revisions

(8 intermediate revisions by 2 users not shown)

Line 1:

Main module for rendering icons ~~with some personalization options. Note: This module is not intended for direct use~~.

Main module for rendering game icons.

* Data: [[~~Module~~:~~Icon/data~~]]

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

* Tracking error category: [[~~:Category:~~Module:Icon ~~ERROR~~]]

== 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 ==

* {{tl|HeroIcon}} ~~- heroes.~~

Any of the following templates can be used. The module automatically detects the icon type:

* {{tl|AbilityIcon}} ~~- abilities.~~

* {{tl|HeroIcon}}

* {{tl|ItemIcon}} ~~- items~~.

* {{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>

Module:Icon/doc: Difference between revisionsGive feedback

Mgpt (talk | contribs)

@@ Line 1: / Line 1: @@
-Main module for rendering icons with some personalization options. Note: This module is not intended for direct use.
+Main module for rendering game icons.
-* Data: [[Module:Icon/data]]
+'''Note: This module is not intended for direct use.''' Use the templates below.
-* Tracking error category: [[:Category:Module:Icon ERROR]]
+== 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 ==
-* {{tl|HeroIcon}} - heroes.
+Any of the following templates can be used. The module automatically detects the icon type:
-* {{tl|AbilityIcon}} - abilities.
+* {{tl|HeroIcon}}
-* {{tl|ItemIcon}} - items.
+* {{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>