@city41/gba-convertpng 0.0.2 → 0.0.4

package/README.md

@@ -3,3 +3,23 @@
 This is a nodejs based tool for converting png images to the tile data format used in GBA games.
 
 HEADS UP: I make games for the e-Reader, and so far have not done mainstream GBA development. So possibly this tool is missing things for GBA dev. If so, please let me know.
+
+## Publishing
+
+gba-convertpng uses [semantic versioning](https://semver.org/)
+
+Publishing a new version is done by bumping the version in package.json
+
+```bash
+yarn version
+yarn version v1.22.19
+info Current version: 0.0.2
+question New version: 0.0.3
+info New version: 0.0.3
+Done in 16.19s.
+
+git push
+git push --tags
+```
+
+Once [the Publish action](https://github.com/city41/ereader-tools/actions/workflows/publish.yml) notices the version has changed, it will run a build and publish to npm.

package/dist/asm.d.ts

@@ -1,2 +1,3 @@
-declare function toAsm(data: number[], width: "b" | "w", numbersPerRow: number): string;
+import { Format } from "./types";
+declare function toAsm(data: number[], width: "b" | "w", numbersPerRow: number, format: Format): string;
 export { toAsm };

package/dist/asm.js

@@ -2,18 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toAsm = toAsm;
 const toHex_1 = require("./toHex");
-function toAsm(data, width, numbersPerRow) {
+function toAsm(data, width, numbersPerRow, format) {
+    if (format !== "asz80" && format !== "z80" && format !== "pyz80") {
+        throw new Error(`toAsm: given an incompatible format (${format})`);
+    }
     const hexFn = width === "b" ? toHex_1.toHexByte : toHex_1.toHexWord;
+    const dPrefix = format === "pyz80" ? "" : ".";
     const rows = [];
     let row = [];
     for (let i = 0; i < data.length; ++i) {
         if (row.length === numbersPerRow) {
-            rows.push(` .d${width} ${row.join(",")}`);
+            rows.push(` ${dPrefix}d${width} ${row.join(",")}`);
             row = [];
         }
         row.push(hexFn(data[i]));
     }
-    rows.push(` .d${width} ${row.join(",")}`);
+    rows.push(` ${dPrefix}d${width} ${row.join(",")}`);
     return rows.join("\r\n") + "\r\n";
 }
 //# sourceMappingURL=asm.js.map

package/dist/background.d.ts

@@ -1,8 +1,8 @@
-import { BackgroundSpec } from "./types";
+import { BackgroundSpec, Format } from "./types";
 type ProcessBackgroundResult = {
     tilesAsmSrc: string;
     paletteAsmSrc: string;
     mapAsmSrc: string;
 };
-declare function processBackground(bg: BackgroundSpec): Promise<ProcessBackgroundResult>;
+declare function processBackground(bg: BackgroundSpec, format: Format): Promise<ProcessBackgroundResult>;
 export { processBackground };

package/dist/background.js

@@ -9,6 +9,7 @@ const canvas_1 = require("./canvas");
 const palette_1 = require("./palette");
 const tile_1 = require("./tile");
 const isEqual_1 = __importDefault(require("lodash/isEqual"));
+const c_1 = require("./c");
 function extractMap(allTilesThatFormImage, dedupedTiles) {
     const map = [];
     allTilesThatFormImage.forEach((tile, i) => {
@@ -22,16 +23,17 @@ function extractMap(allTilesThatFormImage, dedupedTiles) {
     });
     return map;
 }
-async function processBackground(bg) {
+async function processBackground(bg, format) {
     const canvas = await (0, canvas_1.reduceColors)(await (0, canvas_1.createCanvasFromPath)(bg.file), 16);
     const palette = (0, palette_1.extractPalette)(canvas, !bg.trimPalette);
     const allTilesThatFormImage = (0, tile_1.extractTiles)(canvas, palette, 1);
     const dedupedTiles = (0, tile_1.dedupeTiles)(allTilesThatFormImage);
     const map = extractMap(allTilesThatFormImage, dedupedTiles);
+    const toSrcFun = format === "C" ? c_1.toC : asm_1.toAsm;
     return {
-        tilesAsmSrc: (0, asm_1.toAsm)(dedupedTiles.flat(1), "b", 4),
-        paletteAsmSrc: (0, asm_1.toAsm)(palette, "w", 4),
-        mapAsmSrc: (0, asm_1.toAsm)(map, "w", 8),
+        tilesAsmSrc: toSrcFun(dedupedTiles.flat(1), "b", 4, format),
+        paletteAsmSrc: toSrcFun(palette, "w", 4, format),
+        mapAsmSrc: toSrcFun(map, "w", 8, format),
     };
 }
 //# sourceMappingURL=background.js.map

package/dist/c.d.ts

@@ -1,2 +1,3 @@
-declare function toC(data: number[], width: "b" | "w", numbersPerRow: number): string;
+import { Format } from "./types";
+declare function toC(data: number[], width: "b" | "w", numbersPerRow: number, format: Format): string;
 export { toC };

package/dist/c.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toC = toC;
 const toHex_1 = require("./toHex");
-function toC(data, width, numbersPerRow) {
+function toC(data, width, numbersPerRow, format) {
+    if (format !== "C") {
+        throw new Error(`toC: given an incompatible format (${format})`);
+    }
     const hexFn = width === "b" ? toHex_1.toHexByte : toHex_1.toHexWord;
     const rows = [];
     let row = [];

package/dist/main.js

@@ -82,11 +82,18 @@ function hydrateJsonSpec(jsonSpecPath) {
         }),
     };
 }
+const formatToExt = {
+    C: "c.inc",
+    asz80: "asm",
+    z80: "asm",
+    pyz80: "asm",
+    bin: "bin",
+};
 async function main(jsonSpec) {
     if (jsonSpec.format === "bin") {
         throw new Error("convertpng does not support bin format");
     }
-    const ext = jsonSpec.format === "z80" ? "asm" : "c.inc";
+    const ext = formatToExt[jsonSpec.format];
     for (const sprite of jsonSpec.sprites) {
         const processResult = await (0, sprite_1.processSprite)(sprite, jsonSpec.format, sprite.forcePalette);
         if ((0, sprite_1.isBasicSpriteSpec)(sprite)) {
@@ -112,7 +119,7 @@ async function main(jsonSpec) {
         }
     }
     for (const bg of jsonSpec.backgrounds) {
-        const processResult = await (0, background_1.processBackground)(bg);
+        const processResult = await (0, background_1.processBackground)(bg, jsonSpec.format);
         const fileRoot = path.basename(bg.file, path.extname(bg.file));
         const tilesAsmPath = path.resolve(jsonSpec.outputDir, `${fileRoot}.tiles.asm`);
         const paletteAsmPath = path.resolve(jsonSpec.outputDir, `${fileRoot}.palette.asm`);

package/dist/sprite.js

@@ -28,12 +28,11 @@ async function processBasicSprite(sprite, format, forcedPalette) {
             paletteSrc: palette,
         };
     }
-    const tileSrcFun = format === "z80" ? asm_1.toAsm : c_1.toC;
-    const paletteSrcFun = format === "z80" ? asm_1.toAsm : c_1.toC;
+    const toSrcFun = format === "C" ? c_1.toC : asm_1.toAsm;
     return {
         canvas,
-        tilesSrc: [tileSrcFun(tiles, "b", 4)],
-        paletteSrc: paletteSrcFun(palette, "w", 4),
+        tilesSrc: [toSrcFun(tiles, "b", 4, format)],
+        paletteSrc: toSrcFun(palette, "w", 4, format),
     };
 }
 async function processSharedPaletteSprites(sharedPaletteSprite, format, forcedPalette) {
@@ -55,14 +54,13 @@ async function processSharedPaletteSprites(sharedPaletteSprite, format, forcedPa
         const t = (0, tile_1.extractTiles)(canvases[i], commonPalette, sharedPaletteSprite.sharedPalette[i].frames).flat(1);
         tiles.push(t);
     }
-    const tileSrcFun = format === "z80" ? asm_1.toAsm : c_1.toC;
-    const paletteSrcFun = format === "z80" ? asm_1.toAsm : c_1.toC;
+    const toSrcFun = format === "C" ? c_1.toC : asm_1.toAsm;
     return {
         // this is useless in this scenario, but canvas
         // really only exists for the puzzle generator
         canvas: canvases[0],
-        tilesSrc: tiles.map((t) => tileSrcFun(t, "b", 4)),
-        paletteSrc: paletteSrcFun(commonPalette, "w", 4),
+        tilesSrc: tiles.map((t) => toSrcFun(t, "b", 4, format)),
+        paletteSrc: toSrcFun(commonPalette, "w", 4, format),
     };
 }
 async function processSprite(sprite, format, forcedPalettePath) {

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export type Format = "C" | "z80" | "bin";
+export type Format = "C" | "z80" | "pyz80" | "asz80" | "bin";
 export type BasicSpriteSpec = {
     file: string;
     frames: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@city41/gba-convertpng",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Converts png images to GBA tile format",
   "main": "index.js",
   "repository": "github.com/city41/gba-convertpng",