Module:Icon/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
created main doc
 
LVL (talk | contribs)
No edit summary
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]]
 
== Data Sources ==
The module automatically reads from:
* [[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 ==
* {{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
* {{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 {{AbilityIcon|Siphon Life}} for clarity even though {{HeroIcon|Siphon Life}} works the same).
 
== 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]].

Revision as of 15:57, 9 February 2026

Main module for rendering game icons (heroes, abilities, and items).

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

Data Sources

The module automatically reads from:

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

Usage

Any of these templates work for any icon type (hero, ability, or item). The module auto-detects the type:

  • {{HeroIcon}} - Can display heroes, abilities, or items
  • {{AbilityIcon}} - Can display heroes, abilities, or items
  • {{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 Siphon Life for clarity even though Siphon Life works the same).

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.