chess-snap 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 カット Katt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/config.d.ts

@@ -8,4 +8,5 @@ export declare const defaultLight = "#f0d9b5";
 export declare const defaultDark = "#b58863";
 export declare const defaultHighlight = "rgba(235, 97, 80, 0.8)";
 export declare const defaultStyle: PieceStyle;
+export declare const defaultFontFamily = "sans-serif";
 export declare const filePaths: Record<string, string>;

package/dist/config.js

@@ -7,6 +7,7 @@ export const defaultLight = '#f0d9b5';
 export const defaultDark = '#b58863';
 export const defaultHighlight = 'rgba(235, 97, 80, 0.8)';
 export const defaultStyle = 'merida';
+export const defaultFontFamily = 'sans-serif';
 export const filePaths = {
     wp: 'WhitePawn',
     wn: 'WhiteKnight',

package/dist/index.js

@@ -1,5 +1,8 @@
 import { Chess } from 'chess.js';
-import { defaultSize, defaultPadding, defaultLight, defaultDark, defaultHighlight, defaultStyle, white, black, cols } from './config.js';
+import { GlobalFonts } from '@napi-rs/canvas';
+import * as fs from 'fs';
+import * as path from 'path';
+import { defaultSize, defaultPadding, defaultLight, defaultDark, defaultHighlight, defaultStyle, defaultFontFamily, white, black, cols } from './config.js';
 import { generateBoardBuffer, writePNG } from './renderer.js';
 export default class ChessImageGenerator {
     chess;
@@ -10,6 +13,17 @@ export default class ChessImageGenerator {
         this.chess = new Chess();
         this.highlightedSquares = [];
         this.ready = false;
+        let fontFamilyName = options.fontFamily || defaultFontFamily;
+        if (options.fontPath && fs.existsSync(options.fontPath)) {
+            const familyFromFileName = path.basename(options.fontPath, path.extname(options.fontPath));
+            fontFamilyName = options.fontFamily || familyFromFileName;
+            try {
+                GlobalFonts.registerFromPath(options.fontPath, fontFamilyName);
+            }
+            catch (err) {
+                console.error(`Failed to register font from path ${options.fontPath}:`, err);
+            }
+        }
         this.options = {
             size: options.size || defaultSize,
             padding: options.padding || defaultPadding,
@@ -21,6 +35,8 @@ export default class ChessImageGenerator {
             notations: options.notations ?? false,
             notationColor: options.notationColor || '',
             notationStyle: options.notationStyle || 'inside',
+            fontFamily: fontFamilyName,
+            fontPath: options.fontPath || '',
             format: options.format || 'png',
             quality: options.quality ?? 80,
         };

package/dist/renderer.js

@@ -30,14 +30,15 @@ async function getPieceImage(style, pieceKey) {
 /**
  * Renders the algebraic notations (A-H, 1-8) around the board.
  */
-function drawNotations(ctx, size, flipped, light, dark, padding, notationStyle, notationColor) {
+function drawNotations(ctx, size, flipped, light, dark, padding, notationStyle, notationColor, fontFamily) {
     const paddingTop = padding[0];
     const paddingLeft = padding[3];
     const paddingBottom = padding[2];
     const paddingRight = padding[1];
     const squareSize = size / 8;
     const fontSize = Math.max(16, Math.floor(squareSize / 3.5));
-    ctx.font = `bold ${fontSize}px sans-serif`;
+    const fontSpec = fontFamily ? `"${fontFamily}", sans-serif` : 'sans-serif';
+    ctx.font = `bold ${fontSize}px ${fontSpec}`;
     ctx.textBaseline = 'top';
     const rows = flipped ? [1, 2, 3, 4, 5, 6, 7, 8] : [8, 7, 6, 5, 4, 3, 2, 1];
     const columns = flipped ? [...cols].reverse() : cols;
@@ -124,7 +125,7 @@ export async function generateBoardBuffer(chess, options, highlightedSquares) {
         ctx.strokeRect(paddingLeft, paddingTop, options.size, options.size);
     }
     if (options.notations) {
-        drawNotations(ctx, options.size, options.flipped, options.light, options.dark, options.padding, options.notationStyle, options.notationColor);
+        drawNotations(ctx, options.size, options.flipped, options.light, options.dark, options.padding, options.notationStyle, options.notationColor, options.fontFamily);
     }
     const format = options.format;
     const quality = options.quality;

package/dist/types.d.ts

@@ -20,6 +20,10 @@ export interface ChessImageOptions {
     notationColor?: string;
     /** Placement of the notations */
     notationStyle?: 'inside' | 'outside';
+    /** Custom font family for notations (e.g. 'Agency FB', 'Arial', 'sans-serif') */
+    fontFamily?: string;
+    /** Path to a local .ttf / .otf font file to automatically load & register */
+    fontPath?: string;
     /** Image output format (png, jpeg, webp) */
     format?: 'png' | 'jpeg' | 'webp';
     /** Image quality (0-100) for jpeg and webp formats */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chess-snap",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Generate high-quality Chess Boards (like chess.com & lichess) through FEN, PGN & Arrays using Napi-RS.",
   "type": "module",
   "main": "dist/index.js",