BlueGit

timfa questward

Files

questward / server / src / assets / spriteCatalog.js

spriteCatalog.js

spriteCatalog.js 6.2 KiB Download Raw
1import { readdirSync } from "node:fs";
2import { extname, join } from "node:path";
3import { BLOCK_DEFINITIONS, GROUND_DEFINITIONS } from "../../../shared/definitions/tiles.js";
4import { ITEM_DEFINITIONS } from "../../../shared/definitions/items.js";
5import { MOB_DEFINITIONS } from "../../../shared/definitions/mobs.js";
6import {
7 bloomImageName,
8 equipBloomImageName,
9 equipImageName,
10 isCompanionSpriteStem,
11 parseSpriteStem,
12 spriteImageName
13} from "../../../shared/definitions/tileSprites.js";
14
15const CHARACTER_DEFINITIONS = Object.freeze({
16 "player-body-male": Object.freeze({ key: "player-body-male", id: "player-body-male" }),
17 "player-body-female": Object.freeze({ key: "player-body-female", id: "player-body-female" })
18});
19
20export function buildSpriteCatalog (assetRoot)
21{
22 const grounds = scanLayer(join(assetRoot, "grounds"), GROUND_DEFINITIONS, "ground", "grounds");
23 const blocks = scanLayer(join(assetRoot, "blocks"), BLOCK_DEFINITIONS, "block", "blocks");
24 const items = scanLayer(join(assetRoot, "items"), itemScanDefs(), "item", "items");
25 const mobs = scanMobLayers(assetRoot);
26 const characters = scanLayer(join(assetRoot, "characters"), CHARACTER_DEFINITIONS, "character", "characters");
27 const fx = scanFx(join(assetRoot, "fx"));
28 return {
29 grounds: grounds.types,
30 blocks: blocks.types,
31 items: items.types,
32 mobs: mobs.types,
33 characters: characters.types,
34 fx: fx.types,
35 images: [
36 ...grounds.images,
37 ...blocks.images,
38 ...items.images,
39 ...mobs.images,
40 ...characters.images,
41 ...fx.images
42 ]
43 };
44}
45
46function itemScanDefs ()
47{
48 const defs = {};
49 for (const def of Object.values(ITEM_DEFINITIONS))
50 {
51 // Items that reuse another folder's art via iconKey skip the scan.
52 if (def.iconKey && def.iconKey !== def.key)
53 { continue; }
54 defs[def.key] = {
55 key: def.key,
56 id: def.itemId,
57 frames: def.frames ?? 1,
58 framesPerRow: def.framesPerRow ?? 1,
59 animationSpeed: def.animationSpeed ?? 0
60 };
61 }
62 return defs;
63}
64
65function mobScanDefs ()
66{
67 const defs = {};
68 for (const def of Object.values(MOB_DEFINITIONS))
69 {
70 const key = def.key ?? def.mobTypeId;
71 defs[key] = {
72 key,
73 id: def.mobTypeId,
74 frames: def.frames ?? 1,
75 framesPerRow: def.framesPerRow ?? 1,
76 animationSpeed: def.animationSpeed ?? 0,
77 assetFolder: def.assetFolder ?? "mobs"
78 };
79 }
80 return defs;
81}
82
83function scanMobLayers (assetRoot)
84{
85 const byFolder = new Map();
86 for (const def of Object.values(mobScanDefs()))
87 {
88 const folder = def.assetFolder ?? "mobs";
89 if (!byFolder.has(folder))
90 { byFolder.set(folder, {}); }
91 byFolder.get(folder)[def.key] = def;
92 }
93 const types = {};
94 const images = [];
95 for (const [folder, defs] of byFolder)
96 {
97 const scanned = scanLayer(join(assetRoot, folder), defs, "mob", folder);
98 Object.assign(types, scanned.types);
99 images.push(...scanned.images);
100 }
101 return { types, images };
102}
103
104function scanFx (fxRoot)
105{
106 const types = {};
107 const images = [];
108 let folders;
109 try
110 { folders = readdirSync(fxRoot, { withFileTypes: true }).filter((entry) => entry.isDirectory()); }
111 catch (error)
112 {
113 if (error.code === "ENOENT")
114 { return { types, images }; }
115 throw error;
116 }
117 for (const entry of folders)
118 {
119 const key = entry.name;
120 const defs = {
121 [key]: { key, id: key, frames: 1, framesPerRow: 1, animationSpeed: 0 }
122 };
123 const scanned = scanLayer(fxRoot, defs, "fx", "fx");
124 Object.assign(types, scanned.types);
125 images.push(...scanned.images);
126 }
127 return { types, images };
128}
129
130function scanLayer (layerDir, definitions, layer, urlFolder)
131{
132 const types = {};
133 const images = [];
134 for (const def of Object.values(definitions))
135 {
136 const folder = join(layerDir, def.key);
137 const { states, blooms, equips, equipBlooms } = listVisualStates(folder);
138 if (states.length === 0)
139 { throw new Error(`No PNG states in ${folder}`); }
140
141 const frames = Math.max(1, def.frames ?? 1);
142 const framesPerRow = Math.max(1, def.framesPerRow ?? 1);
143 const animationSpeed = Math.max(0, def.animationSpeed ?? 0);
144 types[def.key] = {
145 key: def.key,
146 typeId: def.id,
147 states,
148 defaultState: states[0],
149 blooms,
150 equips,
151 equipBlooms,
152 frames,
153 framesPerRow,
154 animationSpeed
155 };
156 for (const state of states)
157 {
158 const sheet = {
159 subImgTotal: frames,
160 perRow: framesPerRow,
161 loop: animationSpeed > 0,
162 animationSpeed
163 };
164 images.push({
165 name: spriteImageName(layer, def.key, state),
166 url: `/assets/${urlFolder}/${def.key}/${state}.png`,
167 ...sheet
168 });
169 if (blooms[state])
170 {
171 images.push({
172 name: bloomImageName(layer, def.key, state),
173 url: `/assets/${urlFolder}/${def.key}/${state}-bloom.png`,
174 ...sheet
175 });
176 }
177 if (equips[state])
178 {
179 images.push({
180 name: equipImageName(layer, def.key, state),
181 url: `/assets/${urlFolder}/${def.key}/${state}-equip.png`,
182 ...sheet
183 });
184 }
185 if (equipBlooms[state])
186 {
187 images.push({
188 name: equipBloomImageName(layer, def.key, state),
189 url: `/assets/${urlFolder}/${def.key}/${state}-equip-bloom.png`,
190 ...sheet
191 });
192 }
193 }
194 }
195 return { types, images };
196}
197
198function listVisualStates (folder)
199{
200 const stems = listPngStems(folder);
201 const blooms = {};
202 const equips = {};
203 const equipBlooms = {};
204 const states = [];
205 for (const stem of stems)
206 {
207 const parsed = parseSpriteStem(stem);
208 if (parsed.companion)
209 {
210 if (!parsed.base)
211 { continue; }
212 if (parsed.equip && parsed.bloom)
213 { equipBlooms[parsed.base] = true; }
214 else if (parsed.equip)
215 { equips[parsed.base] = true; }
216 else if (parsed.bloom)
217 { blooms[parsed.base] = true; }
218 continue;
219 }
220 if (isCompanionSpriteStem(stem))
221 { continue; }
222 states.push(stem);
223 }
224 const filterMap = (map) =>
225 {
226 const next = {};
227 for (const state of states)
228 {
229 if (map[state])
230 { next[state] = true; }
231 }
232 return next;
233 };
234 return {
235 states,
236 blooms: filterMap(blooms),
237 equips: filterMap(equips),
238 equipBlooms: filterMap(equipBlooms)
239 };
240}
241
242function listPngStems (folder)
243{
244 let entries;
245 try
246 { entries = readdirSync(folder, { withFileTypes: true }); }
247 catch (error)
248 {
249 if (error.code === "ENOENT")
250 { return []; }
251 throw error;
252 }
253
254 return entries
255 .filter((entry) => entry.isFile() && extname(entry.name).toLowerCase() === ".png")
256 .map((entry) => entry.name.slice(0, -extname(entry.name).length))
257 .sort((a, b) => a.localeCompare(b, "en", { numeric: true, sensitivity: "base" }));
258}