import { readdirSync } from "node:fs"; import { extname, join } from "node:path"; import { BLOCK_DEFINITIONS, GROUND_DEFINITIONS, BlockType } from "../../../shared/definitions/tiles.js"; import { ITEM_DEFINITIONS } from "../../../shared/definitions/items.js"; import { MOB_DEFINITIONS } from "../../../shared/definitions/mobs.js"; import { HERB_ORDER } from "../../../shared/definitions/herbs.js"; import { ORE_BEARING_MATERIALS, oreBoulderState, materialTintColor, WOOD_TIER_ORDER } from "../../../shared/definitions/materialTiers.js"; import { FLOWER_COLOR_ORDER, flowerBlockState, flowerColorRgb } from "../../../shared/definitions/dyes.js"; import { bloomImageName, equipBloomImageName, equipImageName, isCompanionSpriteStem, parseSpriteStem, spriteImageName } from "../../../shared/definitions/tileSprites.js"; import { preferredSeasonalDefaultState, typeHasSeasonalStates, isSeasonalOverlayVariant } from "../../../shared/world/season.js"; import { composeNeighborConnectState, NEIGHBOR_CONNECT_MASK_COUNT } from "../../../shared/world/neighborConnect.js"; const CHARACTER_DEFINITIONS = Object.freeze({ "player-body-male": Object.freeze({ key: "player-body-male", id: "player-body-male" }), "player-body-female": Object.freeze({ key: "player-body-female", id: "player-body-female" }) }); export function buildSpriteCatalog (assetRoot) { const blockDefs = Object.fromEntries( Object.entries(BLOCK_DEFINITIONS).filter(([, def]) => def.key !== "herb") ); const grounds = scanLayer(join(assetRoot, "grounds"), GROUND_DEFINITIONS, "ground", "grounds"); const blocks = scanLayer(join(assetRoot, "blocks"), blockDefs, "block", "blocks"); const items = scanLayer(join(assetRoot, "items"), itemScanDefs(), "item", "items"); const herbs = scanHerbAssets(join(assetRoot, "herbs")); Object.assign(blocks.types, herbs.blockTypes); Object.assign(items.types, herbs.itemTypes); const mobs = scanMobLayers(assetRoot); const characters = scanLayer(join(assetRoot, "characters"), CHARACTER_DEFINITIONS, "character", "characters"); const fx = scanFx(join(assetRoot, "fx")); return { grounds: grounds.types, blocks: blocks.types, items: items.types, mobs: mobs.types, characters: characters.types, fx: fx.types, images: [ ...grounds.images, ...blocks.images, ...items.images, ...herbs.images, ...mobs.images, ...characters.images, ...fx.images ] }; } /** * Shared `assets/herbs/.png` — registered as both world block states and item icons. */ function scanHerbAssets (herbRoot) { const stems = new Set(listPngStems(herbRoot)); const missing = HERB_ORDER.filter((id) => !stems.has(id)); if (missing.length) { throw new Error(`Missing herb sprites in ${herbRoot}: ${missing.join(", ")}`); } const images = []; for (const herbId of HERB_ORDER) { const url = `/assets/herbs/${herbId}.png`; images.push({ name: spriteImageName("block", "herb", herbId), url, subImgTotal: 1, perRow: 1, loop: false, animationSpeed: 0 }); images.push({ name: spriteImageName("item", "herbs", herbId), url, subImgTotal: 1, perRow: 1, loop: false, animationSpeed: 0 }); } const blockTypes = { herb: { key: "herb", typeId: BlockType.herbPlant, states: [...HERB_ORDER], defaultState: HERB_ORDER[0], blooms: {}, equips: {}, equipBlooms: {}, frames: 1, framesPerRow: 1, animationSpeed: 0, outdoor: true, seasonal: false } }; const itemTypes = { herbs: { key: "herbs", typeId: "herbs", states: [...HERB_ORDER], defaultState: HERB_ORDER[0], blooms: {}, equips: {}, equipBlooms: {}, frames: 1, framesPerRow: 1, animationSpeed: 0, outdoor: false, seasonal: false } }; return { images, blockTypes, itemTypes }; } function itemScanDefs () { const defs = {}; for (const def of Object.values(ITEM_DEFINITIONS)) { if (def?.herb) { continue; } const folderKey = def.iconKey && def.iconKey !== def.key ? def.iconKey : def.key; if (!folderKey || defs[folderKey]) { continue; } defs[folderKey] = { key: folderKey, id: def.itemId, frames: def.frames ?? 1, framesPerRow: def.framesPerRow ?? 1, animationSpeed: def.animationSpeed ?? 0 }; } /** Shared metal armour worn overlays (items/armour/*-equip.png). */ if (!defs.armour) { defs.armour = { key: "armour", id: "armour-overlays", frames: 1, framesPerRow: 1, animationSpeed: 0 }; } return defs; } function mobScanDefs () { const defs = {}; for (const def of Object.values(MOB_DEFINITIONS)) { if (def.usePlayerBody) { continue; } // spriteKey reuses another mob's art folder (e.g. Shade → rat). const key = def.spriteKey ?? def.key ?? def.mobTypeId; if (defs[key]) { continue; } defs[key] = { key, id: def.mobTypeId, frames: def.frames ?? 1, framesPerRow: def.framesPerRow ?? 1, animationSpeed: def.animationSpeed ?? 0, assetFolder: def.assetFolder ?? "mobs" }; } return defs; } function scanMobLayers (assetRoot) { const byFolder = new Map(); for (const def of Object.values(mobScanDefs())) { const folder = def.assetFolder ?? "mobs"; if (!byFolder.has(folder)) { byFolder.set(folder, {}); } byFolder.get(folder)[def.key] = def; } const types = {}; const images = []; for (const [folder, defs] of byFolder) { const scanned = scanLayer(join(assetRoot, folder), defs, "mob", folder); Object.assign(types, scanned.types); images.push(...scanned.images); } return { types, images }; } function scanFx (fxRoot) { const types = {}; const images = []; let folders; try { folders = readdirSync(fxRoot, { withFileTypes: true }).filter((entry) => entry.isDirectory()); } catch (error) { if (error.code === "ENOENT") { return { types, images }; } throw error; } for (const entry of folders) { const key = entry.name; const defs = { [key]: { key, id: key, frames: 1, framesPerRow: 1, animationSpeed: 0 } }; const scanned = scanLayer(fxRoot, defs, "fx", "fx"); Object.assign(types, scanned.types); images.push(...scanned.images); } return { types, images }; } function scanLayer (layerDir, definitions, layer, urlFolder) { const types = {}; const images = []; for (const def of Object.values(definitions)) { const folder = join(layerDir, def.key); const { states: fileStates, blooms: fileBlooms, equips, equipBlooms } = listVisualStates(folder); if (fileStates.length === 0) { throw new Error(`No PNG states in ${folder}`); } const frames = Math.max(1, def.frames ?? 1); const framesPerRow = Math.max(1, def.framesPerRow ?? 1); const animationSpeed = Math.max(0, def.animationSpeed ?? 0); let states = [...fileStates]; let blooms = fileBlooms; const imagesForType = []; if (layer === "block" && def.key === "boulder") { states = states.filter((state) => state !== "boulder-ore" && state !== "boulder-ore-winter"); if (!states.includes("boulder")) { states.unshift("boulder"); } for (const material of ORE_BEARING_MATERIALS) { const state = oreBoulderState(material); if (!states.includes(state)) { states.push(state); } const tint = materialTintColor(material, { ore: true }); imagesForType.push({ name: spriteImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/boulder-ore.png`, subImgTotal: frames, perRow: framesPerRow, loop: animationSpeed > 0, animationSpeed, tint: { r: tint.r, g: tint.g, b: tint.b } }); const winterState = `${state}-winter`; if (!states.includes(winterState)) { states.push(winterState); } imagesForType.push({ name: spriteImageName(layer, def.key, winterState), url: `/assets/${urlFolder}/${def.key}/boulder-ore-winter.png`, subImgTotal: frames, perRow: framesPerRow, loop: animationSpeed > 0, animationSpeed, tint: { r: tint.r, g: tint.g, b: tint.b } }); } } if (layer === "block" && def.key === "flower") { states = []; for (const colorId of FLOWER_COLOR_ORDER) { const state = flowerBlockState(colorId); states.push(state); const tint = flowerColorRgb(colorId); imagesForType.push({ name: spriteImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/flower.png`, subImgTotal: frames, perRow: framesPerRow, loop: animationSpeed > 0, animationSpeed, tint: { r: tint.r, g: tint.g, b: tint.b } }); } } if (layer === "block" && def.key === "campfire") { states = []; const nextBlooms = {}; for (const material of WOOD_TIER_ORDER) { states.push(material); const tint = materialTintColor(material); imagesForType.push({ name: spriteImageName(layer, def.key, material), url: `/assets/${urlFolder}/${def.key}/campfire.png`, subImgTotal: frames, perRow: framesPerRow, loop: animationSpeed > 0, animationSpeed, tint: { r: tint.r, g: tint.g, b: tint.b } }); imagesForType.push({ name: bloomImageName(layer, def.key, material), url: `/assets/${urlFolder}/${def.key}/campfire-bloom.png`, subImgTotal: frames, perRow: framesPerRow, loop: animationSpeed > 0, animationSpeed }); nextBlooms[material] = true; } blooms = nextBlooms; } if (layer === "block" && def.key === "table") { // Magenta mask sources `0`–`15` (+ optional artist `wood`); expand per wood tier. states = []; for (const material of WOOD_TIER_ORDER) { for (let mask = 0; mask < NEIGHBOR_CONNECT_MASK_COUNT; mask++) { const state = composeNeighborConnectState(def, material, mask); states.push(state); const tint = materialTintColor(material); imagesForType.push({ name: spriteImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/${mask}.png`, subImgTotal: frames, perRow: framesPerRow, loop: animationSpeed > 0, animationSpeed, tint: { r: tint.r, g: tint.g, b: tint.b } }); } } } types[def.key] = { key: def.key, typeId: def.id, states, defaultState: def.key === "boulder" && states.includes("boulder") ? "boulder" : def.key === "fishing-spot" && states.includes("fishing-spot") ? "fishing-spot" : (def.outdoor && preferredSeasonalDefaultState(states)) || states[0], blooms, equips, equipBlooms, frames, framesPerRow, animationSpeed, outdoor: !!def.outdoor, /** Calendar-driven only when outdoor and summer/fall/winter states exist. */ seasonal: !!def.outdoor && typeHasSeasonalStates(states) }; for (const state of states) { if (imagesForType.some((entry) => entry.name === spriteImageName(layer, def.key, state))) { continue; } /** Seasonal overlays (e.g. frozen water-winter) are static single-frame sprites. */ const overlay = isSeasonalOverlayVariant(state); const sheet = { subImgTotal: overlay ? 1 : frames, perRow: overlay ? 1 : framesPerRow, loop: !overlay && animationSpeed > 0, animationSpeed: overlay ? 0 : animationSpeed }; images.push({ name: spriteImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/${state}.png`, ...sheet }); if (blooms[state]) { images.push({ name: bloomImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/${state}-bloom.png`, ...sheet }); } if (equips[state]) { images.push({ name: equipImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/${state}-equip.png`, ...sheet }); } if (equipBlooms[state]) { images.push({ name: equipBloomImageName(layer, def.key, state), url: `/assets/${urlFolder}/${def.key}/${state}-equip-bloom.png`, ...sheet }); } } images.push(...imagesForType); } return { types, images }; } function listVisualStates (folder) { const stems = listPngStems(folder); const blooms = {}; const equips = {}; const equipBlooms = {}; const states = []; for (const stem of stems) { const parsed = parseSpriteStem(stem); if (parsed.companion) { if (!parsed.base) { continue; } if (parsed.equip && parsed.bloom) { equipBlooms[parsed.base] = true; } else if (parsed.equip) { equips[parsed.base] = true; } else if (parsed.bloom) { blooms[parsed.base] = true; } continue; } if (isCompanionSpriteStem(stem)) { continue; } states.push(stem); } const filterMap = (map) => { const next = {}; for (const state of states) { if (map[state]) { next[state] = true; } } return next; }; return { states, blooms: filterMap(blooms), equips: filterMap(equips), equipBlooms: filterMap(equipBlooms) }; } function listPngStems (folder) { let entries; try { entries = readdirSync(folder, { withFileTypes: true }); } catch (error) { if (error.code === "ENOENT") { return []; } throw error; } return entries .filter((entry) => entry.isFile() && extname(entry.name).toLowerCase() === ".png") .map((entry) => entry.name.slice(0, -extname(entry.name).length)) .sort((a, b) => a.localeCompare(b, "en", { numeric: true, sensitivity: "base" })); }