com.mylasertools/kerfscript

Website · Playground · Models · Docs · npm

Write a part once as code, change a number, and get a new cut file. KerfScript is to laser cutters what OpenSCAD is to 3D printers, except it was designed for flat parts from the start: cut, score and engrave layers, kerf compensation, finger joints, living hinges, parts and sheets are part of the language.

It is also a library for building laser-cutting generators: a web page, web service, app or script that takes a few settings (a size, a name, a number of slots) and returns SVG or DXF files ready to cut. The design is a .kerf file; your code passes settings in and takes cut files out, in Node.js, the browser, or any language that runs WebAssembly. See Build a generator.

_{The playground runs the interpreter in your browser. A comment after a number turns it into a slider.}

Example

use <kerf/box> /* [Size] */ width = 120; // [40:5:400] depth = 80; // [40:5:400] height = 50; // [20:5:300] lid = true; /* [Material] */ $thickness = 3; // [1.5:0.5:10] $kerf = 0.15; // [0:0.01:0.5] box([width, depth, height], lid = lid);

npx @mylasertools/kerfscript render box.kerf -o box.svg -D width=200

That writes all six panels packed on a sheet, kerf compensated, as a millimetre SVG with one layer per operation. Output is checked automatically in Inkscape; see docs/compatibility.md for import settings in laser software.

kerf/box is one of the libraries in the standard library, built into every renderer: tabs and slots, living hinges and a box with round corners, egg-crate dividers, keyholes and hanging loops, enclosures with a screwed-on lid, and test pieces that measure your laser's kerf and how your sheet fits.

Build a generator

parameters() reads a design's settings, with their captions, ranges and choices, so you can build a form or an API from them. render() turns settings into cut files:

import { readFile } from 'node:fs/promises';
import { parameters, render } from '@mylasertools/kerfscript';

const design = await

... [View full README on GitHub](https://github.com/mylasertools/kerfscript#readme)