Module:Icon/doc - Revision history

Mgpt: mc

2026-05-23T02:22:43Z

← Older revision		Revision as of 02:22, 23 May 2026
Line 4:		Line 4:

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

	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.		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.		See [[Module:Icon/data]] for manual overrides, legacy items, aliases, and renames used by this module.

Mgpt: mc

2026-05-17T22:39:36Z

← Older revision		Revision as of 22:39, 17 May 2026
Line 8:		Line 8:
	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.		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.

	See ~~also:~~ [[Module:Icon/data]]		See [[Module:Icon/data]] for manual overrides, legacy items, aliases, and renames used by this module.

	== Usage ==		== Usage ==
	Any of the following templates ~~work for any icon type~~. The module ~~auto-~~detects the type:		Any of the following templates can be used. The module automatically detects the icon type:
	* {{tl\|HeroIcon}}		* {{tl\|HeroIcon}}
	* {{tl\|AbilityIcon}}		* {{tl\|AbilityIcon}}
Line 17:		Line 17:
	* {{tl\|EntityIcon}}		* {{tl\|EntityIcon}}

	'''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).		'''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 ==		== Error tracking ==
	Icons that fail to render are added to [[:Category:Module:Icon ERROR]].		Icons that fail to render are added to [[:Category:Module:Icon ERROR]].
	<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>		<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>

Mgpt at 22:10, 17 May 2026

2026-05-17T22:10:39Z

← Older revision		Revision as of 22:10, 17 May 2026
Line 20:		Line 20:

	== Error tracking ==		== Error tracking ==
	Icons that fail to render are added to [[:Category:Module:Icon ERROR]].<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>		Icons that fail to render are added to [[:Category:Module:Icon ERROR]].
			<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>

Mgpt at 22:10, 17 May 2026

2026-05-17T22:10:14Z

← Older revision		Revision as of 22:10, 17 May 2026
Line 20:		Line 20:

	== Error tracking ==		== Error tracking ==
	Icons that fail to render are added to [[:Category:Module:Icon ERROR]].<includeonly>[[:Category:Modules]]</includeonly><noinclude>[[:Category:Module documentation]]</noinclude>		Icons that fail to render are added to [[:Category:Module:Icon ERROR]].<includeonly>[[Category:Modules]]</includeonly><noinclude>[[Category:Module documentation]]</noinclude>

Mgpt: New doc version. Moved table info.

2026-05-17T22:08:58Z

New doc version. Moved table info.

← Older revision		Revision as of 22:08, 17 May 2026
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~~]].

LVL: Added explanation about legacyitems

2026-03-26T14:35:02Z

Added explanation about legacyitems

← Older revision		Revision as of 14:35, 26 March 2026
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 ==

LVL: Updated icon doc to reflect new change

2026-03-11T16:34:14Z

Updated icon doc to reflect new change

← Older revision		Revision as of 16:34, 11 March 2026
Line 4:		Line 4:

	== Data Sources ==		== Data Sources ==
	The module ~~automatically~~ reads from:		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.
	* [[Data:~~HeroData~~.json]] - ~~Hero information~~
	* [[~~Data~~:~~AbilityData.json~~]] ~~- Ability information~~
	* [[Data:ItemData.~~json]] - Item information~~

	When the bot uploads new game files, icons update automatically.

	== Usage ==		== Usage ==

LVL at 15:59, 9 February 2026

2026-02-09T15:59:09Z

← Older revision		Revision as of 15:59, 9 February 2026
Line 18:		Line 18:
	* {{tl\|ItemIcon}} - 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 {{AbilityIcon\|Siphon Life}} for clarity even though {{HeroIcon\|Siphon Life}} works the same).		'''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 ==		== Error Tracking ==

LVL at 15:57, 9 February 2026

2026-02-09T15:57:58Z

@@ 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 (heroes, abilities, and items).
-* Data: [[Module:Icon/data]]
+'''Note: This module is not intended for direct use.''' Use the templates below.
-* Tracking error category: [[:Category:Module:Icon ERROR]]
 == Usage ==
-* {{tl|HeroIcon}} - heroes.
+Any of these templates work for any icon type (hero, ability, or item). The module auto-detects the type:
-* {{tl|AbilityIcon}} - abilities.
-* {{tl|ItemIcon}} - items.
+* {{tl|HeroIcon}} - Can display heroes, abilities, or items

Mgpt: created main doc

2025-05-16T23:24:04Z

created main doc

New page

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

* Data: [[Module:Icon/data]]
* Tracking error category: [[:Category:Module:Icon ERROR]]

== Usage ==
* {{tl|HeroIcon}} - heroes.
* {{tl|AbilityIcon}} - abilities.
* {{tl|ItemIcon}} - items.