IsoDelve

Home › Developer guide › Art packs: downloading Ink Stone and what goes where

Art packs: downloading Ink Stone and what goes where

Developer guide · updated

An art pack is everything needed to draw maps: one sprite per piece, rendered at four isometric angles and three scales, packed into atlas images with exact anchor points. Maps never include art; they name pieces, and your code looks them up in the pack.

Ink Stone is free for everyone, forever (see the art license, which requires the credit “Map art by IsoDelve”). Additional art packs will come with paid plans later; none exist yet.

Versions and immutability

  • A pack is identified as id@major.minor.patch, for example ink-stone@1.1.0.
  • A published version never changes. Fixes and new pieces ship as a new version. That is why pack files are served with a one-year immutable cache header and why you can cache them forever.
  • Every map records the exact version it was built for in map.pack. Draw it with that version.
  • Newer versions of the same pack are supersets: Ink Stone 1.1.0 has all of 1.0.0’s pieces plus the gen-1.2.0 additions (rubble, damaged walls, breach, broken props, bedroom and study furniture, hearth, sconce).
Pack Pieces Default for
ink-stone@1.0.0 meant to be 66 (currently reports 91; being corrected) gen-1.0.0, gen-1.1.0
ink-stone@1.1.0 91 gen-1.2.0, gen-1.3.0
ink-stone@1.2.0 105 none yet (ask for it by name: "pack": "ink-stone@1.2.0"); the first pack with the low, medium and high quality tiers (quality= on renders; high is for paid plans) and short doors for short walls

Folder layout

All paths are relative to the pack’s baseUrl, https://api.isodelve.com/v1/packs/ink-stone/1.1.0/:

ink-stone/1.1.0/
├── manifest.json                  pieces, atlases, sprite frame sizes, units
├── atlases/
│   ├── iso0/
│   │   ├── 1/      atlas-0.png  atlas-0.json  atlas-1.png  atlas-1.json   full scale
│   │   ├── 0.5/    atlas-0.png  atlas-0.json  atlas-1.png  atlas-1.json   half scale
│   │   └── 0.25/   atlas-0.png  atlas-0.json  atlas-1.png  atlas-1.json   quarter scale
│   ├── iso90/   (same three scales)
│   ├── iso180/  (same)
│   └── iso270/  (same)
├── previews/                      served when a pack has them (Ink Stone has none yet)
└── models/                        3D GLB files: listed in the manifest, not served yet (coming later)

That is 24 atlases (4 angles × 3 scales × 2 sheets). Real download sizes for all four angles of Ink Stone 1.1.0, PNG plus JSON:

Scale Download Typical use
0.25 1.26 MB Thumbnails, phones, overviews
0.5 4.21 MB Most screens and VTTs
1 13.73 MB Print, very large screens

Download only the scale you draw at, and only the angles you show.

manifest.json

The key fields (real values):

{
  "specVersion": "isodelve-kit-1",
  "id": "ink-stone", "version": "1.1.0", "name": "Ink Stone",
  "license": "LicenseRef-IsoDelve-TBD",
  "units": "meters", "upAxis": "Y (glTF)",
  "grid": { "cellM": 1.524, "cellFt": 5 },
  "wall": { "heightM": { "full": 3.048, "cutaway": 0.9144, "half": 0.762 }, "thicknessM": 0.3048, "segmentLengthM": 1.2192 },
  "facings": ["iso0", "iso90", "iso180", "iso270"],
  "sprite": {
    "cellPx": [256, 128], "pxPerFoot": 31.35, "scales": [1, 0.5, 0.25],
    "frames": {
      "floor":   { "w": 256, "h": 176, "ax": 128, "ay": 64 },
      "segment": { "w": 256, "h": 512, "ax": 128, "ay": 448 },
      "portal":  { "w": 256, "h": 512, "ax": 128, "ay": 448 },
      "vertex":  { "w": 64,  "h": 512, "ax": 32,  "ay": 480 },
      "prop":    { "w": 256, "h": 512, "ax": 128, "ay": 448 }
    }
  },
  "atlases": [ { "facing": "iso0", "scale": 0.5, "image": "atlases/iso0/0.5/atlas-0.png", "data": "atlases/iso0/0.5/atlas-0.json", "w": 1024, "h": 1944 }, "…" ],
  "pieces": [ "… 91 entries …" ],
  "models": { "floor.slab.a": { "glb": "models/floor.slab.a.glb", "tris": 12 }, "…": "…" }
}
  • sprite.cellPx: [256, 128] is the size of one floor cell’s diamond at full scale: 256 px wide, 128 px tall.
  • sprite.frames gives the fixed canvas size and anchor (ax, ay) per kind at full scale. Multiply by the scale for smaller atlases. Props bigger than one cell get larger frames (below).

pieces

Each piece entry describes one kit piece. Real examples:

{ "id": "wall.seg.full.a", "kind": "segment", "height": "full", "topCap": "built-in", "weight": 6, "model": "models/wall.seg.full.a.glb" }
{ "id": "portal.door.closed", "kind": "portal", "height": "full", "jambs": true, "topCap": "built-in", "state": "closed", "blocksSight": true, "model": "models/portal.door.closed.glb" }
{ "id": "prop.dais.a", "kind": "prop", "footprint": [2, 2], "placement": "center", "rooms": ["shrine", "boss"], "blocksMove": true, "blocksSight": false, "model": "models/prop.dais.a.glb" }
{ "id": "light.torch.a", "kind": "prop", "footprint": [1, 1], "placement": "wall", "rooms": ["entrance", "guard", "storage", "tomb", "ossuary", "corridor"], "blocksMove": false, "blocksSight": false, "light": { "radiusFt": 20, "color": "#ffb46b" }, "model": "models/light.torch.a.glb" }

Useful fields for a client: kind (which frame size applies), footprint ([w, d] cells for props), blocksMove and blocksSight (for VTT movement and line of sight), light, and state for portals. Ink Stone 1.1.0 has 46 props (lights included), 15 vertex pieces, 13 wall segments, 10 floors and 7 portals.

Atlas files and sprite frames

Each atlas JSON lists the frames packed into its PNG. Real frames from atlases/iso0/0.5/atlas-0.json:

{ "image": "atlas-0.png", "w": 1024, "h": 1944, "scale": 0.5, "facing": "iso0",
  "frames": [
    { "id": "floor.slab.a",       "x": 0,   "y": 0,    "w": 128, "h": 88,  "ax": 64,  "ay": 32  },
    { "id": "wall.seg.full.a",    "x": 128, "y": 88,   "w": 128, "h": 256, "ax": 64,  "ay": 224 },
    { "id": "vertex.corner.full", "x": 320, "y": 344,  "w": 32,  "h": 256, "ax": 16,  "ay": 240 },
    { "id": "prop.throne.a",      "x": 768, "y": 1112, "w": 128, "h": 256, "ax": 64,  "ay": 224 },
    { "id": "prop.feast-table.a", "x": 0,   "y": 1368, "w": 192, "h": 288, "ax": 96,  "ay": 240 },
    { "id": "prop.dais.a",        "x": 192, "y": 1368, "w": 256, "h": 320, "ax": 128, "ay": 256 },
    "…"
  ] }
  • x, y, w, h: where the sprite sits in the PNG.
  • ax, ay: the anchor, measured from the frame’s top-left. It is the screen point of the piece’s footprint centre on the floor. Place the frame so its anchor lands on the projected position, and the piece lines up exactly.
  • Frames have fixed sizes per kind (the half-scale numbers above are the manifest’s frames × 0.5). A multi-cell prop with footprint [w, d] uses a frame 128n wide and 512 + 64(n − 2) tall at full scale, anchored at (64n, 384 + 32n), where n = w + d. The 2 × 2 dais (n = 4) is 512 × 640 at full scale, 256 × 320 at half.

The four angles

iso0, iso90, iso180 and iso270 are four camera directions a quarter turn apart, all at the same 2:1 isometric view (a floor cell is a 256 × 128 diamond at full scale). Every piece is rendered from all four, so turning a map is just switching to the next angle’s atlases. Pieces placed with a rotation use a different angle’s sprite: a piece with rot r seen from angle f uses the sprite rendered for angle FACINGS[(index(f) − r) mod 4]. The drawing page uses this.

Loading a pack in code

const base = "https://api.isodelve.com/v1/packs/ink-stone/1.1.0/";
const manifest = await (await fetch(base + "manifest.json")).json();
const scale = 0.5, sprites = {};
for (const ref of manifest.atlases.filter((a) => a.scale === scale)) {
  const data = await (await fetch(base + ref.data)).json();
  const img = new Image(); img.crossOrigin = "anonymous"; img.src = base + ref.image; await img.decode();
  for (const fr of data.frames) sprites[`${fr.id}|${ref.facing}`] = { img, ...fr };
}
// sprites["prop.throne.a|iso0"] -> { img, x, y, w, h, ax, ay }

Pack files need no key and allow cross-origin requests, so this runs in a browser. Next: Drawing a map.