From eaac9774e1919f77827d39ae1675500f9d2a2d6e Mon Sep 17 00:00:00 2001 From: Vaclav Vancura Date: Thu, 2 Apr 2026 20:33:04 +0200 Subject: [PATCH] docs(assets): fix stale 8x8 dimension references in docs and scripts Update README system font description and inline code comments from 8x8 to 6x14. Fix JSDoc in convert and export scripts to reflect the current 96x84 atlas and 1330-byte array size. Signed-off-by: Vaclav Vancura --- README.md | 6 +++--- scripts/convert-system-font.mjs | 2 +- scripts/export-system-font.mjs | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5358ef5..2d6df4f 100644 --- a/README.md +++ b/README.md @@ -381,7 +381,7 @@ BT.drawSprite(sheet, srcRect, destPos); // Draw with original palette colors BT.drawSprite(sheet, srcRect, destPos, 16); // Draw with paletteOffset=16 (color variation) BT.printFont(font, pos, text); // Draw text using bitmap font BT.printFont(font, pos, text, 8); // Draw text with paletteOffset=8 -BT.systemPrint(pos, paletteIndex, text); // Draw text with the built-in 8x8 system font +BT.systemPrint(pos, paletteIndex, text); // Draw text with the built-in 6x14 system font BT.systemPrintMeasure(text); // Measure system font text dimensions BT.spritesRefresh(); // Re-index all loaded sheets after palette swap ``` @@ -389,8 +389,8 @@ BT.spritesRefresh(); // Re-index all loaded sheets after palette swap **Palette offset:** The `paletteOffset` parameter shifts which palette range a sprite samples from at draw time. Useful for team colors, damage flashes, or palette-swap effects without duplicate assets. -**System font:** `BT.systemPrint()` renders text using the built-in IBM PC 8x8 bitmap font. For custom bitmap fonts with -proportional glyphs, use `BT.printFont()` with a loaded `BitmapFont`. +**System font:** `BT.systemPrint()` renders text using the built-in IBM PC 6x14 bitmap font. For custom bitmap fonts +with proportional glyphs, use `BT.printFont()` with a loaded `BitmapFont`. **Sprite Transforms:** Sprite transform flags (`BT.FLIP_H`, `BT.FLIP_V`, `BT.ROT_90_CW`, etc.) are defined but not yet implemented in `drawSprite()`. They are planned for a future release. diff --git a/scripts/convert-system-font.mjs b/scripts/convert-system-font.mjs index fdcf574..adb2b9f 100644 --- a/scripts/convert-system-font.mjs +++ b/scripts/convert-system-font.mjs @@ -49,7 +49,7 @@ const ON_THRESHOLD = 128; // Red channel >= this means "on". * Reads the PNG and extracts bit patterns for all 95 glyphs. * * @param {string} inputPath - Path to the 96x84 PNG atlas. - * @returns {number[]} Flat array of 760 bytes (95 glyphs x 8 rows). + * @returns {number[]} Flat array of 1330 bytes (95 glyphs x 14 rows). */ function extractBitmaps(inputPath) { const pngData = readFileSync(inputPath); diff --git a/scripts/export-system-font.mjs b/scripts/export-system-font.mjs index 0769407..a276edd 100644 --- a/scripts/export-system-font.mjs +++ b/scripts/export-system-font.mjs @@ -87,7 +87,7 @@ function parseBitmapData() { // #region PNG Generation /** - * Builds a 128x48 RGBA PNG from the bit-pattern data. + * Builds a 96x84 RGBA PNG from the bit-pattern data. * Set bits become white (255,255,255,255), clear bits become black (0,0,0,255). * * @param {number[]} bitmaps - The flat array of glyph bytes. -- 2.51.2