Willow: the mass documenting

2026-06-20T11:54:59Z

the mass documenting

New page

'''Module:Reskins holds the master list of cosmetic reskin items (Cherub, Halloween, Valentine's, Christmas, Custom) and renders them either as a gallery for a theme page or as an "Applicable Reskins" list inside an item's infobox.'''
__TOC__

== Overview ==

A "reskin" is a cosmetic skin that can be applied to one or more item types (e.g. the Christmas "Sharpened Candy Cane" reskins any Sword). All of the reskins the wiki knows about are stored as a single Lua table inside this module — each entry records the skin's <code>name</code>, its <code>theme</code>, where it's <code>obtained</code>, a flavour <code>desc</code>, and the list of item <code>types</code> it applies to.

The module is used two ways:
# '''On theme pages''' (e.g. the Cherub reskins template) — it renders a full infobox gallery of every reskin in that theme.
# '''Inside {{tl|ItemInfobox}}''' — for a given item type it lists the named reskins that can be applied to that type, in the infobox's "Applicable Reskins" section.

Because the data lives in this module, adding or editing a reskin means editing the <code>reskins</code> table here — there is no separate per-reskin page to maintain.

== Functions / entry points ==

{| class="wikitable"
! Function (#invoke) !! What it does !! Called by
|-
| <code>p.forType</code> || Given an item type name (e.g. <code>Sword</code>), returns a <code><br></code>-separated list of clickable reskin entries (sprite icon + "<Name> Skin" linking to the Reskins page) for every reskin whose <code>types</code> include that type. Skips themes flagged <code>NO_APPLY</code> (currently <code>Custom</code>). Used to fill the Reskins section of an item infobox. || {{tl|ItemInfobox}} (via <code>{{#invoke:Reskins|forType|...}}</code>)
|-
| <code>p.theme</code> || Given a theme key (e.g. <code>Cherub</code>), renders a full {{tl|ItemInfobox}} for every reskin in that theme — using the skin's sprite, description, "Applies to:" type list, and "obtained" text. Returns <code>''No reskins in this category yet.''</code> if the theme has none. || Theme listing templates, e.g. {{tl|Cherub/Reskins}}, {{tl|Christmas/Reskins}}, {{tl|Custom/Reskins}}
|}

== How it's used ==

'''Inside the item infobox''' (already wired into {{tl|ItemInfobox}} — editors don't add this themselves). The infobox only requests reskins for untiered items (when none of T1–T8 are set):

<pre>
|ReskinList={{#if:{{{T1|}}}...{{{T8|}}}||{{#invoke:Reskins|forType|{{{type|{{#var:itemtype}}}}}}}}}
</pre>

'''On a theme page''' (e.g. the Cherub reskins listing template):

<pre>
<div class="display-items">
{{#invoke:Reskins|theme|Cherub}}
</div>
</pre>

To add a new reskin, edit the <code>reskins</code> table in the module and give it a <code>name</code>, <code>theme</code>, <code>obtained</code>, <code>desc</code> and <code>types</code>. To list a new theme on its own page, create a template that calls <code>{{#invoke:Reskins|theme|<ThemeName>}}</code>.

== Notes ==

* '''Sprite file naming.''' Reskin sprite files are built automatically as <code><ThemePrefix>Reskin-<NameWithoutSpaces>.png</code>. The theme prefixes are: Cherub → <code>CH</code>, Halloween → <code>H</code>, Valentines → <code>V</code>, Christmas → <code>C</code>, Custom → <code>Custom</code>. Example: the Cherub "Blade of False Eden" expects <code>File:CHReskin-BladeOfFalseEden.png</code>. The name is title-cased and stripped of spaces before the prefix is added, so the uploaded file must match that exact form.
* '''Type → sprite/link table.''' The module's <code>TYPES</code> table maps each item type to a T1 icon (e.g. <code>T1Sword.png</code>) and a section link (e.g. <code>Weapons#Swords</code>, <code>Abilities#Bombs</code>, or just <code>Armours</code>). This is used by <code>p.theme</code> to render the clickable "Applies to:" list.
* '''Custom theme is excluded from item infoboxes.''' <code>NO_APPLY = { Custom = true }</code> means custom/community reskins are shown only on their own theme page via <code>p.theme</code>, not in the per-item "Applicable Reskins" list.
* The CLAUDE/project convention notes that reskins live on a separate page rather than on the base item's page; this module is the mechanism behind that separation.
* '''Related:''' {{ml|Infobox}} (renders each infobox), {{ml|Equipment}} and {{ml|Shinies}} (sibling display modules), {{tl|ItemInfobox}}.

Module:Reskins/doc - Revision history

Willow: the mass documenting