GrizzledAlchemistb40f9cb5: module documentation

2026-07-05T17:15:18Z

module documentation

New page

This is the documentation page for [[Module:Sprite/Item]].

A pure data module (no functions): it returns a Lua table describing the Sanko item sprite atlas. It is consumed by [[Module:Sprite]] via <code>mw.loadData('Module:Sprite/Item')</code> and, through that, by [[Template:ItemSprite]] and [[Template:Sprite]].

== Table layout ==
{| class="wikitable sanko-table"
! Key !! Meaning
|-
| <code>url</code> || Atlas asset path (<code>/w/sanko-assets/Sanko_item_atlas.svg</code>). Not read by Module:Sprite; the image is applied by the <code>.sanko-sprite</code> site CSS.
|-
| <code>image</code> || Wiki file name of the atlas (<code>Sanko item atlas.svg</code>).
|-
| <code>cell</code> || Sprite cell size in pixels (32).
|-
| <code>columns</code> || Atlas columns (4).
|-
| <code>width</code>, <code>height</code> || Native atlas dimensions in pixels (128 × 1056).
|-
| <code>items</code> || Map of exact item name → <code>{ item_id, x, y }</code>, where <code>x</code>/<code>y</code> are the sprite's pixel offsets in the atlas at native size.
|}

== Usage ==
<pre>
local itemData = mw.loadData('Module:Sprite/Item')
local entry = itemData.items['Bronze Axe']
-- entry = { item_id = 4, x = 96, y = 0 }
</pre>

== Notes and sharp edges ==
* Keys are exact display names — case, spacing, and punctuation sensitive. <code>['Bronze Axe']</code> works; <code>['bronze axe']</code> renders the missing-sprite placeholder.
* <code>item_id</code> values track the game item catalog and are not contiguous (gaps exist, e.g. 29 and 98–100 are unassigned here); Module:Sprite only uses <code>x</code>/<code>y</code>, not <code>item_id</code>.
* <code>NA</code>, <code>NA2</code>, <code>NA3</code> are placeholder atlas cells, not real items.
* When adding an entry, its <code>x</code>/<code>y</code> must match the sprite's actual cell in the atlas image (columns advance x by 32, rows advance y by 32), and <code>height</code> must cover any new rows. Item IDs and catalog names are bot/API-owned fields per the [[SankoQuest:Style guide|style guide]] — keep them in sync with the catalog rather than inventing values.
* Loaded with <code>mw.loadData</code>, so the table must stay static data only (no functions, no metatables).

Module:Sprite/Item/doc - Revision history

GrizzledAlchemistb40f9cb5: module documentation