silphscope 1.4.12 → 1.4.14

package/README.md

@@ -55,7 +55,7 @@ const rom = fs.readFileSync("pokefirered.gba"); // replace with path to your own
 await renderAllGraphics(rom, {
     concurrency: 4, // handles how many concurrent promises are run. Set to 1 to run sequentially and conversly increase to run more promises at once (don't set too high though if your CPU / I/O can't handle it then it might actually be slower...)
     pngFilterType: 0, // view the explanation for this above
-    pngCompression: 4, // same thing :p explanation above
+    pngCompressionLevel: 4, // same thing :p explanation above
     outputMonDir: "./Assets/monImages", // must I explain?
     outputIconDir: "./Assets/Icons", // same thing here :p
     outputTrainerDir: "./Assets/Trainers", // ...
@@ -78,7 +78,7 @@ const rom = fs.readFileSync("pokefirered.gba")// once again replace with the pat
 await renderAllMons(rom, {
     concurrency: 4, // handles how many concurrent promises are run. Set to 1 to run sequentially and conversly increase to run more promises at once (don't set too high though if your CPU / I/O can't handle it then it might actually be slower...)
     pngFilterType: 0, // explanation above
-    pngCompression: 4, // explanation above
+    pngCompressionLevel: 4, // explanation above
     outputDir: "./Assets/monImages", // do I actually have to explain?
     icon: true, // set to false if you don't want icons I guess...
     footprint: true, // same as the above...
@@ -94,7 +94,7 @@ const rom = fs.readFileSync("pokefirered.gba")// find your own rom and so on :l
 await renderAllIcons(rom, {
     concurrency: 4, // handles how many concurrent promises are run. Set to 1 to run sequentially and conversly increase to run more promises at once (don't set too high though if your CPU / I/O can't handle it then it might actually be slower...)
     pngFilterType: 0, // explanation above
-    pngCompression: 4, // explanation above
+    pngCompressionLevel: 4, // explanation above
     outputDir: "./Assets/Icons" // no comment (wait... that was a comment :p)
 });
 ```
@@ -108,7 +108,7 @@ const rom = fs.readFileSync("pokefirered.gba") // stuff stuff stuff
 await renderAllTrainers(rom, {
     concurrency: 4, // handles how many concurrent promises are run. Set to 1 to run sequentially and conversly increase to run more promises at once (don't set too high though if your CPU / I/O can't handle it then it might actually be slower...)
     pngFilterType: 0, // explanation above
-    pngCompression: 4, // explanation above
+    pngCompressionLevel: 4, // explanation above
     outputDir: "./Assets/trainers", // more stuff
     trainerBackPics: true, // renders the like 8 trainer back pics
 })
@@ -123,7 +123,7 @@ const rom = fs.readFileSync("pokefirered.gba") // stuff stuff stuff (more stuff!
 await renderAllMoves(rom, {
     concurrency: 4, // handles how many concurrent promises are run. Set to 1 to run sequentially and conversly increase to run more promises at once (don't set too high though if your CPU / I/O can't handle it then it might actually be slower...)
     pngFilterType: 0, // explanation above
-    pngCompression: 4, // explanation above
+    pngCompressionLevel: 4, // explanation above
     outputDir: "./Assets/trainers", // (incredibly) more stuff
     renderMasterImage: true, // kinda forgot about this... basically it renders a uncut image of the move anim if you like
     sortUnused: true, // sorts unused moves into a sub-directory
@@ -139,7 +139,7 @@ const rom = fs.readFileSync("./path/to/your/rom.gba") // the file path explains
 await renderAllBalls(rom, {
     concurrency: 4, // handles how many concurrent promises are run. Set to 1 to run sequentially and conversly increase to run more promises at once (don't set too high though if your CPU / I/O can't handle it then it might actually be slower...)
     pngFilterType: 0, // explanation above
-    pngCompression: 4, // explanation above
+    pngCompressionLevel: 4, // explanation above
     outputDir: "./Assets/Balls",
     ballParticles: true, // set to false if you don't want the ball particles :p
     renderMasterBallImage: true, // set to false if you don't want the uncut image

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "silphscope",
-  "version": "1.4.12",
+  "version": "1.4.14",
   "description": "A firered/leafgreen ROM asset extractor for use in web applications",
   "main": "main.js",
   "exports": {

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

@@ -41,6 +41,7 @@ function isValidFilterType(filterTypeValue) {
 }
 
 export async function renderAllMons(rom, options = {}) {
+    const start = performance.now();
     if (!rom || !(rom instanceof Uint8Array || Buffer.isBuffer(rom))) {
         throw new TypeError("renderAllMons(rom, options) requires rom Buffer/Uint8Array as first argument");
     }
@@ -51,6 +52,9 @@ export async function renderAllMons(rom, options = {}) {
         concurrency = 4,
         pngFilterType = 0,
         pngCompressionLevel = 4,
+        verboseLogs = true,
+        showSummary = true,
+        returnFileBuffer = false,
         icon = true,
         footprint = true,
     } = options;
@@ -69,34 +73,65 @@ export async function renderAllMons(rom, options = {}) {
 
     const config = getRomConfig(rom);
     const reader = new RomReader(rom, config);
+    let totalFileCount = 0;
+    const finalResults = returnFileBuffer? [] : null;
 
     if (concurrency > 1) {
         await mapLimit(Object.keys(providedMons), concurrency, async (monName) => { // so in theory we should be running the function 4 times concurrently now...
-            await renderMon(monName, providedMons, reader, rom, {
+            const renderMonData = await renderMon(monName, providedMons, reader, rom, {
                 side: ["front", "back"],
                 variant: ["normal", "shiny"],
                 icon,
                 footprint,
                 pngFilterType,
                 pngCompressionLevel,
+                returnFileBuffer,
                 outputDir,
             });
-            console.log(`Done: ${monName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${monName}`);
+            }
+            totalFileCount += renderMonData.fullFileCount;
+            if (returnFileBuffer) {
+                finalResults.push(...renderMonData.results);
+            }
         });
     } else {
         for (const monName of Object.keys(providedMons)) {
-            await renderMon(monName, providedMons, reader, rom, {
+            const renderMonData = await renderMon(monName, providedMons, reader, rom, {
                 side: ["front", "back"],
                 variant: ["normal", "shiny"],
                 icon,
                 footprint,
                 pngFilterType,
                 pngCompressionLevel,
+                returnFileBuffer,
                 outputDir,
             });
-            console.log(`Done: ${monName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${monName}`);
+            }
+            totalFileCount += renderMonData.fullFileCount;
+            if (returnFileBuffer) {
+                finalResults.push(...renderMonData.results);
+            }
         }
     }
+
+    const elapsed = ((performance.now() - start) / 1000).toFixed(2);
+
+    if (showSummary) {
+        console.log(`
+            renderAllMons() Output Summary:
+            Rendered ${Object.keys(providedMons).length} Mons amounting to:
+            ${totalFileCount} Files written
+            Done in ${elapsed}s with SilphScope`);
+    }
+
+    return {
+        totalFileCount,
+        ...(returnFileBuffer && { finalResults }),
+    };
 }
 
 export async function renderAllIcons(rom, options = {}) {
@@ -109,6 +144,7 @@ export async function renderAllIcons(rom, options = {}) {
         concurrency = 4,
         pngFilterType = 0,
         pngCompressionLevel = 4,
+        verboseLogs = true,
         outputDir = "./out",
     } = options;
 
@@ -134,7 +170,9 @@ export async function renderAllIcons(rom, options = {}) {
                 pngCompressionLevel,
                 outputDir,
             });
-            console.log(`Done: ${itemName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${itemName}`);
+            }
         });
     } else {
         for (const itemName of Object.keys(providedIcons)) {
@@ -143,7 +181,9 @@ export async function renderAllIcons(rom, options = {}) {
                 pngCompressionLevel,
                 outputDir,
             });
-            console.log(`Done: ${itemName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${itemName}`);
+            }
         }
     }
 }
@@ -160,6 +200,7 @@ export async function renderAllTrainers(rom, options = {}) {
         concurrency = 4,
         pngFilterType = 0,
         pngCompressionLevel = 4,
+        verboseLogs = true,
         outputDir = "./out",
     } = options;
 
@@ -186,7 +227,9 @@ export async function renderAllTrainers(rom, options = {}) {
                 pngCompressionLevel,
                 outputDir
             });
-            console.log(`Done: ${trainerName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${trainerName}`);
+            }
         });
     } else {
         for (const trainerName of Object.keys(providedTrainers)) {
@@ -196,7 +239,9 @@ export async function renderAllTrainers(rom, options = {}) {
                 pngCompressionLevel,
                 outputDir
             });
-            console.log(`Done: ${trainerName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${trainerName}`);
+            }
         }
     }
 }
@@ -211,6 +256,7 @@ export async function renderAllMoves(rom, options = {}) {
         concurrency = 4,
         pngFilterType = 0,
         pngCompressionLevel = 4,
+        verboseLogs = true,
         outputDir = "./out",
         renderMasterImage = true,
         sortUnused = true,
@@ -240,7 +286,9 @@ export async function renderAllMoves(rom, options = {}) {
                 renderMasterImage,
                 sortUnused,
             });
-            console.log(`Done: ${moveName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${moveName}`);
+            }
         });
     } else {
         for (const moveName of Object.keys(providedMoves)) {
@@ -251,7 +299,9 @@ export async function renderAllMoves(rom, options = {}) {
                 renderMasterImage,
                 sortUnused,
             });
-            console.log(`Done: ${moveName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${moveName}`);
+            }
         }
     }
 }
@@ -266,6 +316,7 @@ export async function renderAllBalls(rom, options = {}) {
         concurrency = 4,
         pngFilterType = 0,
         pngCompressionLevel = 4,
+        verboseLogs = true,
         outputDir = "./out",
         ballParticles = true,
         renderMasterBallImage = true,
@@ -297,7 +348,9 @@ export async function renderAllBalls(rom, options = {}) {
                 renderMasterBallImage,
                 renderMasterBallParticleImage,
             });
-            console.log(`Done: ${ballName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${ballName}`);
+            }
         })
     } else {
         for (const ballName of Object.keys(providedBalls)) {
@@ -309,7 +362,9 @@ export async function renderAllBalls(rom, options = {}) {
                 renderMasterBallImage,
                 renderMasterBallParticleImage,
             });
-            console.log(`Done: ${ballName}`);
+            if (verboseLogs) {
+                console.log(`Done: ${ballName}`);
+            }
         }
     }
 }
@@ -323,6 +378,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
         concurrency = 4,
         pngFilterType = 0,
         pngCompressionLevel = 4,
+        verboseLogs = true,
         outputMonDir = "./out/mons",
         outputIconDir = "./out/icons",
         outputTrainerDir = "./out/trainers",
@@ -345,6 +401,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
         concurrency,
         pngFilterType,
         pngCompressionLevel,
+        verboseLogs,
         outputDir: outputMonDir,
         icon: true,
         footprint: true,
@@ -354,6 +411,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
         concurrency,
         pngFilterType,
         pngCompressionLevel,
+        verboseLogs,
         outputDir: outputIconDir,
     });
 
@@ -361,6 +419,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
         concurrency,
         pngFilterType,
         pngCompressionLevel,
+        verboseLogs,
         outputDir: outputTrainerDir,
         trainerBackPics: true,
     });
@@ -369,6 +428,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
         concurrency,
         pngFilterType,
         pngCompressionLevel,
+        verboseLogs,
         outputDir: outputMoveDir,
         renderMasterImage: true,
         sortUnused: sortUnusedMoves,
@@ -378,6 +438,7 @@ export async function renderAllGraphics(rom, options = {}) { // eventually I wil
         concurrency,
         pngFilterType,
         pngCompressionLevel,
+        verboseLogs,
         outputDir: outputBallDir,
         ballParticles: true,
         renderMasterBallImage: true,

package/src/graphics/mons/render-mon-foot.js

@@ -17,7 +17,8 @@ const streamToBuffer = (stream) => new Promise((resolve, reject) => {
 export async function renderMonFoot(monName, mons, reader, rom, options = {}) {
     const { 
         pngFilterType = null,
-        pngCompressionType = null,
+        pngCompressionLevel = null,
+        returnFileBuffer,
         outputDir = null,
     } = options;
 
@@ -25,12 +26,17 @@ export async function renderMonFoot(monName, mons, reader, rom, options = {}) {
         throw new TypeError("renderMonFoot(..., rom) requires a ROM Buffer/Uint8Array");
     }
 
+    let fileCount = 0;
     const mon = mons[monName];
     if (!mon) {
         throw new Error(`Missing mon entry for ${monName}`);
     }
 
-    if (monName.includes("UNOWN")) return;
+    if (monName.includes("UNOWN")) {
+        return {
+            fileCount: 0,
+        }
+    }
 
     const footAsset = resolveMonFootprint(mon, reader, monName); // possibly the easiest change ive had to do if it works first try :o
     if (!footAsset) {
@@ -76,7 +82,7 @@ export async function renderMonFoot(monName, mons, reader, rom, options = {}) {
     png.data = image;
     const pngBuffer = PNG.sync.write(png, { 
         filterType: pngFilterType,
-        deflateLevel: pngCompressionType,
+        deflateLevel: pngCompressionLevel,
     });
 
     if (outputDir) {
@@ -84,7 +90,11 @@ export async function renderMonFoot(monName, mons, reader, rom, options = {}) {
         await fs.promises.mkdir(dir, { recursive: true });
         const fileName = `${dir}/footprint.png`;
         await fs.promises.writeFile(fileName, pngBuffer);
+        fileCount += 1;
     }
 
-    return pngBuffer;
+    return {
+        ...(returnFileBuffer && { pngBuffer }),
+        fileCount,
+    };
 }

package/src/graphics/mons/render-mon-icon.js

@@ -16,16 +16,18 @@ const streamToBuffer = (stream) => new Promise((resolve, reject) => {
 });
 
 export async function renderMonIcon(monName, mons, reader, rom, options = {}) {
-    const { 
+    const {
         pngFilterType = null,
         pngCompressionLevel = null,
-        outputDir = null 
+        returnFileBuffer = false,
+        outputDir = null
     } = options;
 
     if (!rom || !(rom instanceof Uint8Array || Buffer.isBuffer(rom))) {
         throw new TypeError("renderMonIcon(..., rom) requires a ROM Buffer/Uint8Array");
     }
 
+    let fileCount = 0;
     const mon = mons[monName];
     if (!mon) {
         throw new Error(`Missing mon entry for ${monName}`);
@@ -41,10 +43,10 @@ export async function renderMonIcon(monName, mons, reader, rom, options = {}) {
     const height = 64;
 
     const image = render4bppImage({
-        tileData: iconData.data, 
-        paletteData: rawIconPalData.data, 
-        width, 
-        height, 
+        tileData: iconData.data,
+        paletteData: rawIconPalData.data,
+        width,
+        height,
     });
 
     const frameHeight = 32;
@@ -55,13 +57,13 @@ export async function renderMonIcon(monName, mons, reader, rom, options = {}) {
     pngFrame1.data = frame1;
     const pngFrame2 = new PNG({ width, height: frameHeight });
     pngFrame2.data = frame2;
-    const buffer1 = PNG.sync.write(pngFrame1, { 
+    const buffer1 = PNG.sync.write(pngFrame1, {
         filterType: pngFilterType,
-        deflateLevel: pngCompressionLevel, 
+        deflateLevel: pngCompressionLevel,
     });
-    const buffer2 = PNG.sync.write(pngFrame2, { 
+    const buffer2 = PNG.sync.write(pngFrame2, {
         filterType: pngFilterType,
-        deflateLevel: pngCompressionLevel, 
+        deflateLevel: pngCompressionLevel,
     });
 
     if (outputDir) {
@@ -69,10 +71,12 @@ export async function renderMonIcon(monName, mons, reader, rom, options = {}) {
         await fs.promises.mkdir(dir, { recursive: true });
         await fs.promises.writeFile(`${dir}/icon_frame1.png`, buffer1);
         await fs.promises.writeFile(`${dir}/icon_frame2.png`, buffer2);
+        fileCount += 2;
     }
 
     return {
-        frame1: buffer1,
-        frame2: buffer2,
+        ...(returnFileBuffer && { frame1: buffer1 }),
+        ...(returnFileBuffer && { frame2: buffer2 }),
+        fileCount,
     };
 }

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

@@ -25,6 +25,7 @@ export async function renderMon(monName, mons, reader, rom, options = {}) {
         footprint = false,
         pngFilterType = null,
         pngCompressionLevel = null,
+        returnFileBuffer = false,
         outputDir = null,
     } = options;
 
@@ -32,22 +33,35 @@ export async function renderMon(monName, mons, reader, rom, options = {}) {
         throw new TypeError("renderMon(..., rom) requires a ROM Buffer/Uint8Array");
     }
 
+    let fullFileCount = 0;
     const sides = Array.isArray(side) ? side : [side];
     const variants = Array.isArray(variant) ? variant : [variant];
+    const results = returnFileBuffer? [] : null;
 
     if (icon === true) {
-        await renderMonIcon(monName, mons, reader, rom, { 
+        const monIconData = await renderMonIcon(monName, mons, reader, rom, {
             pngFilterType,
             pngCompressionLevel,
+            returnFileBuffer,
             outputDir,
         });
+        fullFileCount += monIconData.fileCount;
+        if (returnFileBuffer) {
+            results.push(monIconData.frame1);
+            results.push(monIconData.frame2);
+        }
     }
     if (footprint === true) {
-        await renderMonFoot(monName, mons, reader, rom, { 
+        const monFootData = await renderMonFoot(monName, mons, reader, rom, {
             pngFilterType,
             pngCompressionLevel,
-            outputDir, 
+            returnFileBuffer,
+            outputDir,
         });
+        fullFileCount += monFootData.fileCount;
+        if (returnFileBuffer) {
+            results.push(monFootData.pngBuffer);
+        }
     }
 
     const mon = mons[monName];
@@ -68,7 +82,6 @@ export async function renderMon(monName, mons, reader, rom, options = {}) {
         palCache[variant] = extract(monPal, rom).data;
     }
 
-    const results = [];
     const width = 64;
     const height = 64;
     if (outputDir) {
@@ -78,17 +91,17 @@ export async function renderMon(monName, mons, reader, rom, options = {}) {
     for (const side of sides) {
         for (const variant of variants) {
             const image = render4bppImage({
-                tileData: picCache[side], 
-                paletteData: palCache[variant], 
-                width, 
-                height, 
+                tileData: picCache[side],
+                paletteData: palCache[variant],
+                width,
+                height,
             });
 
             const png = new PNG({ width, height });
             png.data = image;
-            const pngBuffer = PNG.sync.write(png, { 
+            const pngBuffer = PNG.sync.write(png, {
                 filterType: pngFilterType,
-                deflateLevel: pngCompressionLevel, 
+                deflateLevel: pngCompressionLevel,
             });
 
             if (outputDir) {
@@ -97,9 +110,15 @@ export async function renderMon(monName, mons, reader, rom, options = {}) {
                 await fs.promises.writeFile(fileName, pngBuffer);
             }
 
-            results.push(pngBuffer);
+            if (returnFileBuffer) {
+                results.push(pngBuffer);
+            }
+            fullFileCount += 1;
         }
     }
 
-    return results;
+    return { 
+        ...(returnFileBuffer && { results }),
+        fullFileCount,
+    }
 }