silphscope 1.3.0 → 1.3.2

package/README.md

@@ -1,5 +1,9 @@
 still a WIP however hopefully with some more work I can get this into a workable state...
 
+(Even Newer!) Update:
+
+moves now work... kinda... still working on getting it all the way done but it mostly works!
+
 (Newer!) Update:
 
 still a WIP :p but erm you can extract more graphics!
@@ -21,10 +25,11 @@ await renderAllGraphics(rom, {
     outputMonDir: "./Assets/monImages", // must I explain?
     outputIconDir: "./Assets/Icons", // same thing here :p
     outputTrainerDir: "./Assets/Trainers", // ...
+    outputMoveDir: "./Assets/Moves"
 });
 ```
 
-Of course though the above is for extracting all graphics (which is kinda a lie... In reality it only extracts mon images, item icons, and trainer images... but like I said this is a WIP :p so wait a bit please!).
+Of course though the above is for extracting all graphics (which is kinda a lie... In reality it only extracts mon images, item icons, trainer images, and move images... but like I said this is a WIP :p so wait a bit please!).
 
 But if you want say just the mon images or item icons refer below:
 
@@ -62,4 +67,15 @@ await renderAllTrainers(rom, {
     outputDir: "./Assets/trainers", // more stuff
     trainerBackPics: true, // renders the like 8 trainer back pics
 })
+```
+
+move image extraction:
+```JavaScript
+import fs from "fs";
+import { renderAllMoves } from "silphscope" // :O
+
+const rom = fs.readFileSync("pokefirered.gba") // stuff stuff stuff (more stuff!)
+await renderAllMoves(rom, {
+    outputDir: "./Assets/trainers", // (incredibly) more stuff
+})
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "silphscope",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "A firered/leafgreen ROM asset extractor for use in web applications",
   "main": "main.js",
   "exports": {
@@ -18,7 +18,11 @@
     "item-data/",
     "trainer-data",
     "rom-configs/",
-    "move-data/"
+    "move-data/",
+    "!src/icon-data-parser.js",
+    "!src/mon-data-parser.js",
+    "!src/trainer-data-parser.js",
+    "!src/move-data-parser.js"
   ],
   "keywords": [],
   "author": "chickenPoo",

package/src/graphics/graphics-extractor-main.js

@@ -104,6 +104,7 @@ export async function renderAllMoves(rom, options = {}) {
     const {
         moves: providedMoves = moves,
         outputDir = "./out",
+        renderMasterImage = true,
     } = options;
 
     fs.mkdirSync(outputDir, { recursive: true });
@@ -112,7 +113,10 @@ export async function renderAllMoves(rom, options = {}) {
     const reader = new RomReader(rom, config);
 
     for (const moveName of Object.keys(providedMoves)) {
-        await renderMove(moveName, providedMoves, reader, rom, { outputDir });
+        await renderMove(moveName, providedMoves, reader, rom, { 
+            outputDir,
+            renderMasterImage, 
+        });
         console.log(`Done: ${moveName}`);
     }
 }
@@ -146,6 +150,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
 
     await renderAllMoves(rom, {
         outputDir: outputMoveDir,
+        renderMasterImage: true,
     })
 }
 

package/src/graphics/moves/render-moves.js

@@ -37,7 +37,8 @@ const extractFrameFromImage = (imageData, fullWidth, frameData) => { // in theor
 
 export async function renderMove(moveName, moves, reader, rom, options = {}) {
     const {
-        outputDir = null
+        outputDir = null,
+        renderMasterImage = false,
     } = options;
     if (!rom || !(rom instanceof Uint8Array || Buffer.isBuffer(rom))) {
         throw new TypeError("renderMove(..., rom) requires a ROM Buffer/Uint8Array");
@@ -69,7 +70,12 @@ export async function renderMove(moveName, moves, reader, rom, options = {}) {
     if (outputDir) { // I will update this later but in theory it should also work... eventually though it will need a split inside to handle full image generation :p
         const dir = `${outputDir}/${moveName}`;
         if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
-
+        if (renderMasterImage) {
+            const png = new PNG({ width, height });
+            png.data = image;
+            const pngBuffer = await streamToBuffer(png.pack());
+            fs.writeFileSync(`${dir}/master.png`, pngBuffer);
+        }
         for (let i = 0; i < move.frames.length; i++) {
             const frame = move.frames[i];
             const frameImageData = extractFrameFromImage(image, width, frame);

package/src/graphics/moves/resolvers/move-pal-resolver.js

@@ -1,7 +1,7 @@
 export function resolveMovePal(move, reader, moveName) {
     const table = reader.getTable("moveAnimPaletteTable");
     const entryOffset = table + move.index * 8;
-    const ptr = reader.readOffset(entryOffset);
+    const ptr = reader.readPointer(entryOffset);
     return {
         name: `move_${moveName}_pal`,
         offset: ptr,

package/src/graphics/moves/resolvers/move-pic-resolver.js

@@ -1,7 +1,7 @@
 export function resolveMovePic(move, reader, moveName) {
     const table = reader.getTable("moveAnimPicTable");
     const entryOffset = table + move.index * 8;
-    const ptr = reader.readOffset(entryOffset);
+    const ptr = reader.readPointer(entryOffset);
     return {
         name: `move_${moveName}_pic`,
         offset: ptr

package/src/icon-data-parser.js

@@ -1,30 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-const itemIconDataMap = path.resolve("../item_graphics/item_icon_table.h");
-const iconDataLines = fs.readFileSync(itemIconDataMap, "utf-8").split("\n");
-
-const itemData = {};
-let itemIndex = 0;
-
-for (let i = 0; i < iconDataLines.length; i++) {
-    const match = iconDataLines[i].match(/\[(ITEMS?_[A-Z0-9_]+)\]\s*=\s*\{\s*([^,]+),\s*([^}]+)\}/);
-    if (match) {
-        let itemName = match[1]
-            .replace("ITEM_", "")
-            .replace("ITEMS_", "");
-        const icon = match[2].trim();
-        const palette = match[3].trim();
-        if (!itemData[itemName]) {
-            itemData[itemName] = {};
-        }
-        if (!itemData[itemName]["index"]) {
-            itemData[itemName]["index"] = itemIndex;
-            itemIndex++;
-        }
-        itemData[itemName]["icon"] = icon;
-        itemData[itemName]["palette"] = palette;
-    }
-}
-
-fs.writeFileSync("../item-data/itemData.json", JSON.stringify(itemData, null, 2));

package/src/mon-data-parser.js

@@ -1,118 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-const monFrontPicMap = path.resolve("../pokemon_graphics/front_pic_table.h");
-const monBackPicMap = path.resolve("../pokemon_graphics/back_pic_table.h");
-const monFootprintMap = path.resolve("../pokemon_graphics/footprint_table.h");
-const monPaletteMap = path.resolve("../pokemon_graphics/palette_table.h");
-const monShinyPaletteMap = path.resolve("../pokemon_graphics/shiny_palette_table.h");
-const monImageDimensionMap = path.resolve("../pokemon_graphics/front_pic_coordinates.h");
-const monIconPaletteIdxMap = path.resolve("../pokemon_icon.c");
-const frontPicLines = fs.readFileSync(monFrontPicMap, "utf-8").split("\n");
-const backPicLines = fs.readFileSync(monBackPicMap, "utf-8").split("\n");
-const footprintLines = fs.readFileSync(monFootprintMap, "utf8").split("\n");
-const paletteLines = fs.readFileSync(monPaletteMap, "utf-8").split("\n");
-const shinyPaletteLines = fs.readFileSync(monShinyPaletteMap, "utf-8").split("\n");
-const imageDimLines = fs.readFileSync(monImageDimensionMap, "utf-8").split("\n");
-const iconPalIdxLines = fs.readFileSync(monIconPaletteIdxMap, "utf-8").split("\n");
-const monData = {};
-
-function extractMonData(lines, category) {
-    let monIndex = 0;
-    for (let i = 0; i < lines.length; i++) {
-        let match;
-        let monName;
-        let secondArgument;
-        if (category !== "footprintPics" && category !== "imageDimensions" && category !== "iconPalIndex") {
-            match = lines[i].match(/\(([^,]+),\s*([^,]+)\)/);
-            if (match) {
-                monName = match[1];
-                secondArgument = match[2];
-            }
-        } else if (category === "footprintPics") {
-            match = lines[i].match(/\[(SPECIES_\w+)\]\s*=\s*(gMonFootprint_\w+)/);
-            if (match) {
-                monName = match[1].replace("SPECIES_", "");
-                secondArgument = match[2];
-            }
-        } else if (category === "imageDimensions" && lines[i].includes(".size = MON_COORDS_SIZE")) {
-            const prevLine = lines[i - 2];
-            match = lines[i].match(/MON_COORDS_SIZE\((\d+),\s*(\d+)\)/);
-            if (match) {
-                monName = prevLine.match(/\[(SPECIES_\w+)\]/)[1].replace("SPECIES_", "");
-                const width = match[1];
-                const height = match[2];
-                if (!monData[monName]) {
-                    monData[monName] = {};
-                }
-                monData[monName]["width"] = width;
-                monData[monName]["height"] = height;
-            }
-        } else if (category === "iconPalIndex") {
-            match = lines[i].match(/\[(SPECIES_\w+)\]\s*=\s*(\d+)\s*,?/);
-            if (match) {
-                monName = match[1].replace("SPECIES_", "");
-                secondArgument = match[2];
-            }
-        }
-        if (monName && secondArgument) {
-            if (!monData[monName]) {
-                monData[monName] = {};
-            }
-            if (!monData[monName][category]) {
-                monData[monName][category] = secondArgument;
-            }
-            if (!monData[monName]["index"]) {
-                monData[monName]["index"] = monIndex;
-                monIndex++
-            }
-        }
-    }
-}
-
-extractMonData(frontPicLines, "frontPics");
-extractMonData(backPicLines, "backPics");
-extractMonData(paletteLines, "normPalette");
-extractMonData(shinyPaletteLines, "shinyPalette");
-extractMonData(footprintLines, "footprintPics");
-extractMonData(imageDimLines, "imageDimensions");
-extractMonData(iconPalIdxLines, "iconPalIndex");
-function uncapitalize(string) {
-    return string.charAt(0) + string.slice(1).toLowerCase();
-}
-Object.entries(monData).forEach(([monName]) => {
-    let monName2 = uncapitalize(monName);
-    if (monName2.includes("Old_unown_") || monName2.includes("None")) {
-        monName2 = "QuestionMark";
-    }
-    if (monName2.includes("Unown_")) {
-        monName2 = monName2.slice(0, 5) + monName2[6].toUpperCase() + monName2.slice(7);
-        if (monName2 === "UnownEmark") {
-            monName2 = "UnownExclamationMark";
-        } else if (monName2 === "UnownQmark") {
-            monName2 = "UnownQuestionMark";
-        }
-    }
-    if (monName2.includes("Nidoran")) {
-        if (monName2.includes("Nidoran_f")) {
-            monName2 = "NidoranF";
-        }
-        if (monName2.includes("Nidoran_m")) {
-            monName2 = "NidoranM";
-        }
-    }
-    if (monName2.includes("Mr_mime")) {
-        monName2 = "Mrmime";
-    }
-    if (monName2 === "Unown") {
-        monName2 = "UnownA";
-    }
-    if (monName2 === "Ho_oh") {
-        monName2 = "HoOh";
-    }
-    console.log(monName2);
-    const iconName = `gMonIcon_${monName2}`
-    monData[monName]["Icon"] = iconName;
-})
-
-fs.writeFileSync("../mon-data/monData.json", JSON.stringify(monData, null, 2));

package/src/move-data-parser.js

@@ -1,169 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-// === CONFIG ===
-const USE_PREBUILT_TEMPLATES = true; // Set to true to load from moveStructData.json instead of parsing .c files
-// ===
-
-// Paths
-const movePicMap = path.resolve("../move_graphics/gBattleAnimPicTable.h");
-const moveDataPath = "../move-data/moveData.json";
-const unusedTagData = JSON.parse(fs.readFileSync(path.resolve("../move-data/unusedTags.json"), "utf-8"));
-
-// Read animation pic table to get move animation tags
-const movePicLines = fs.readFileSync(movePicMap, "utf-8").split("\n");
-
-const moveData = {};
-let moveIndex = 0;
-
-// Tags that are defined but never assigned a SpriteTemplate
-const unusedTags = new Set(Object.keys(unusedTagData));
-
-// Parse gBattleAnimPicTable.h for animation tags
-for (const line of movePicLines) {
-    const match = line.match(/\{\s*(gBattleAnimSpriteGfx_[A-Za-z0-9_]+)\s*,\s*(0x[0-9A-Fa-f]+)\s*,\s*(ANIM_TAG_[A-Za-z0-9_]+)\s*\},/);
-    if (match) {
-        const moveName = match[3].replace("ANIM_TAG_", "");
-        const moveTag = match[3];
-
-        if (!moveData[moveName]) {
-            moveData[moveName] = { index: moveIndex++ };
-        }
-        moveData[moveName].animTag = moveTag;
-
-        if (unusedTagData[moveTag]) {
-            Object.assign(moveData[moveName], unusedTagData[moveTag]);
-            moveData[moveName].unused = true;
-          }
-    }
-}
-
-// Parse SpriteTemplate structs from battle_anim_*.c files (or load prebuilt)
-let templates = {};
-
-if (USE_PREBUILT_TEMPLATES) {
-    // Load from prebuilt JSON
-    const prebuiltPath = "../move-data/moveStructData.json";
-    templates = JSON.parse(fs.readFileSync(prebuiltPath, "utf-8"));
-    console.log(`Loaded ${Object.keys(templates).length} templates from prebuilt file.`);
-} else {
-    // Parse from source files
-    const animFiles = [
-        "../move_graphics/battle_anim_bug.c", "../move_graphics/battle_anim_dark.c",
-        "../move_graphics/battle_anim_dragon.c", "../move_graphics/battle_anim_effects_1.c",
-        "../move_graphics/battle_anim_effects_2.c", "../move_graphics/battle_anim_effects_3.c",
-        "../move_graphics/battle_anim_electric.c", "../move_graphics/battle_anim_fight.c",
-        "../move_graphics/battle_anim_fire.c", "../move_graphics/battle_anim_flying.c",
-        "../move_graphics/battle_anim_ghost.c", "../move_graphics/battle_anim_ground.c",
-        "../move_graphics/battle_anim_ice.c", "../move_graphics/battle_anim_normal.c",
-        "../move_graphics/battle_anim_poison.c", "../move_graphics/battle_anim_psychic.c",
-        "../move_graphics/battle_anim_rock.c", "../move_graphics/battle_anim_water.c",
-        "../move_graphics/battle_anim_status_effects.c",
-    ];
-
-    for (const file of animFiles) {
-        const lines = fs.readFileSync(file, "utf-8").split("\n");
-        Object.assign(templates, parseStructs(lines));
-    }
-    console.log(`Parsed ${Object.keys(templates).length} templates from source files.`);
-}
-
-// Build template lookup by tileTag
-const templateByTag = Object.fromEntries(
-    Object.values(templates).map(t => [t.tileTag, t])
-);
-
-// Check for missing animTags
-const animTagsInPicTable = Object.values(moveData).map(item => item.animTag);
-const tileTagsInTemplates = Object.values(templates).map(t => t.tileTag);
-const missingTags = animTagsInPicTable.filter(tag => !tileTagsInTemplates.includes(tag));
-
-if (missingTags.length > 0) {
-    console.log("Missing animTags from templates:");
-    missingTags.forEach(tag => {
-        if (!unusedTags.has(tag)) console.log(tag);
-    });
-} else {
-    console.log("No missing animTags.");
-}
-
-// Extract OAM size info for each move
-for (const key in moveData) {
-    const item = moveData[key];
-    const template = templateByTag[item.animTag];
-
-    if (template?.oam) {
-        const size = extractOamSize(template.oam);
-        if (size) {
-            item.possibleFrameSize = size.raw;
-            item.possibleFrameWidth = size.width;
-            item.possibleFrameHeight = size.height;
-        }
-    }
-}
-
-// Write final output
-fs.writeFileSync(moveDataPath, JSON.stringify(moveData, null, 2));
-console.log(`Wrote ${Object.keys(moveData).length} moves to ${moveDataPath}`);
-
-// --- Helper Functions ---
-
-function parseStructs(fileLines) {
-    const results = {};
-    let current = null;
-    let braceDepth = 0;
-    let inStruct = false;
-
-    for (const line of fileLines) {
-        const trimmed = line.trim();
-        const startMatch = trimmed.match(/^(static\s+)?const\s+struct\s+SpriteTemplate\s+(\w+)/);
-
-        if (startMatch) {
-            current = { name: startMatch[2] };
-            inStruct = true;
-            braceDepth = trimmed.includes("{") ? 1 : 0;
-            continue;
-        }
-
-        if (!inStruct) continue;
-
-        // Track brace depth
-        for (const char of trimmed) {
-            if (char === "{") braceDepth++;
-            if (char === "}") braceDepth--;
-        }
-
-        // Parse struct fields
-        if (trimmed.startsWith(".")) {
-            const eqIndex = trimmed.indexOf("=");
-            if (eqIndex === -1) continue;
-
-            const key = trimmed.slice(1, eqIndex).trim();
-            let value = trimmed.slice(eqIndex + 1).replace(",", "").trim();
-            if (value === "NULL") value = null;
-            else if (value.startsWith("&")) value = value.slice(1);
-
-            current[key] = value;
-        }
-
-        // End of struct
-        if (inStruct && braceDepth === 0) {
-            results[current.name] = current;
-            current = null;
-            inStruct = false;
-        }
-    }
-
-    return results;
-}
-
-function extractOamSize(oam) {
-    const match = oam?.match(/(\d+)x(\d+)$/);
-    if (!match) return null;
-
-    return {
-        width: parseInt(match[1], 10),
-        height: parseInt(match[2], 10),
-        raw: match[0]
-    };
-}

package/src/trainer-data-parser.js

@@ -1,29 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-const trainerFrontPicMap = path.resolve("../trainer_graphics/front_pic_tables.h");
-const frontPicLines = fs.readFileSync(trainerFrontPicMap, "utf-8").split("\n");
-
-const trainerData = {};
-let trainerIndex = 0;
-
-for (let i = 0; i < frontPicLines.length; i++) {
-    const match = frontPicLines[i].match(/TRAINER_(SPRITE|PAL)\(\s*([A-Z0-9_]+)\s*,\s*(gTrainer(?:FrontPic|Palette)_[A-Za-z0-9_]+)/);
-    if (match) {
-        let trainerName = match[2];
-        if (!trainerData[trainerName]) {
-            trainerData[trainerName] = {};
-        }
-        if (match[1] === "SPRITE") {
-            trainerData[trainerName]["Pic"] = match[3];
-        } else {
-            trainerData[trainerName]["Palette"] = match[3];
-        }
-        if (trainerData[trainerName]["index"] === undefined) {
-            trainerData[trainerName]["index"] = trainerIndex;
-            trainerIndex++;
-        }
-    }
-}
-
-fs.writeFileSync("../trainer-data/trainerData.json", JSON.stringify(trainerData, null, 2));