A type-safe library for parsing and writing LightBurn files.
npm install lbrntsimport { LightBurnProject } from "lbrnts"
const project = LightBurnProject.parse(fs.readFileSync("project.lbrn2", "utf8"))
console.log(project.children)You can programmatically create LightBurn projects by constructing the project and its elements. Below is a table of all constructible classes with links to their documentation:
| Class | Description |
|---|---|
| LightBurnProject | Root project container |
| CutSetting | Cut/engrave settings (speed, power, etc.) |
| ShapePath | Custom paths with lines and bezier curves |
| ShapeRect | Rectangle shapes |
| ShapeEllipse | Ellipse/circle shapes |
| ShapeText | Text shapes |
| ShapeBitmap | Bitmap/image shapes |
| ShapeGroup | Group container for shapes |
| Notes | Project notes |
| VariableText | Variable text settings |
The root container for a LightBurn project.
new LightBurnProject(init?: {
appVersion?: string
formatVersion?: string
materialHeight?: number
mirrorX?: boolean
mirrorY?: boolean
children?: LightBurnBaseElement[]
})import { LightBurnProject, CutSetting, ShapePath } from "lbrnts"
const cutSetting = new CutSetting({
index: 0,
name: "Wood Cut",
priority: 0,
type: "Cut",
speed: 10,
maxPower: 80,
minPower: 60,
})
const path = new ShapePath({
cutIndex: 0,
verts: [
{ x: -25, y: -25 },
{ x: 25, y: -25 },
{ x: 25, y: 25 },
{ x: -25, y: 25 },
],
prims: [
{ type: 0 },
{ type: 0 },
{ type: 0 },
{ type: 0 },
],
isClosed: true,
})
const project = new LightBurnProject({
appVersion: "1.7.03",
formatVersion: "1",
materialHeight: 0,
children: [cutSetting, path],
})getChildren(): Returns the children array
Defines cutting/engraving settings for laser operations.
new CutSetting(init?: {
type?: string // "Cut", "Scan", "Image", etc.
index?: number // Layer index
name?: string // Layer name
priority?: number // Execution priority
minPower?: number // Minimum power (0-100%)
maxPower?: number // Maximum power (0-100%)
minPower2?: number // Secondary laser minimum power
maxPower2?: number // Secondary laser maximum power
speed?: number // Speed in mm/s
kerf?: number // Kerf offset in mm
zOffset?: number // Z-axis offset
enablePowerRamp?: boolean // Enable power ramping
rampLength?: number // Ramp length in mm
numPasses?: number // Number of passes
zPerPass?: number // Z increment per pass
perforate?: boolean // Perforate mode
dotMode?: boolean // Dot mode
scanOpt?: string // Scan optimization
interval?: number // Scan line interval
angle?: number // Scan angle
overScanning?: number // Over-scanning distance
lineAngle?: number // Line angle for fill
})const cutSetting = new CutSetting({
index: 0,
name: "Acrylic Engrave",
priority: 1,
type: "Cut",
speed: 150,
maxPower: 50,
minPower: 40,
numPasses: 3,
enablePowerRamp: true,
rampLength: 2,
})Custom paths with vertices and primitives (lines and bezier curves).
new ShapePath(init?: {
verts?: Vert[] // Array of vertices
prims?: Prim[] // Array of primitives (drawing commands)
isClosed?: boolean // Whether the path is closed
cutIndex?: number // Cut setting index to use
locked?: boolean // Lock the shape
xform?: Mat // Transformation matrix [a, b, c, d, tx, ty]
})
interface Vert {
x: number
y: number
c?: number // Control point flag
c0x?: number // Control point 0 x
c0y?: number // Control point 0 y
c1x?: number // Control point 1 x
c1y?: number // Control point 1 y
}
interface Prim {
type: number // 0 = LineTo, 1 = BezierTo
}
type Mat = [a: number, b: number, c: number, d: number, tx: number, ty: number]const square = new ShapePath({
cutIndex: 0,
verts: [
{ x: -25, y: -25 },
{ x: 25, y: -25 },
{ x: 25, y: 25 },
{ x: -25, y: 25 },
],
prims: [
{ type: 0 }, // LineTo
{ type: 0 }, // LineTo
{ type: 0 }, // LineTo
{ type: 0 }, // LineTo (close path)
],
isClosed: true,
})const curved = new ShapePath({
cutIndex: 0,
verts: [
{ x: 0, y: -30 },
{ x: 30, y: 0, c: 1, c0x: 30, c0y: -16.5, c1x: 30, c1y: -16.5 },
{ x: 0, y: 30, c: 1, c0x: 30, c0y: 16.5, c1x: 30, c1y: 16.5 },
{ x: -30, y: 0, c: 1, c0x: -30, c0y: 16.5, c1x: -30, c1y: 16.5 },
{ x: 0, y: -30, c: 1, c0x: -30, c0y: -16.5, c1x: -30, c1y: -16.5 },
],
prims: [
{ type: 1 }, // BezierTo
{ type: 1 }, // BezierTo
{ type: 1 }, // BezierTo
{ type: 1 }, // BezierTo
],
isClosed: true,
})Rectangle shape (currently read-only from parsed files).
new ShapeRect()w: Widthh: Heightcr: Corner radiuscutIndex: Cut setting indexlocked: Lock statexform: Transformation matrix
Ellipse/circle shape (currently read-only from parsed files).
new ShapeEllipse()rx: X radiusry: Y radiuscutIndex: Cut setting indexlocked: Lock statexform: Transformation matrix
Text shape (currently read-only from parsed files).
new ShapeText()text: Text contentfont: Font namebackupPath: Backup path representationcutIndex: Cut setting indexlocked: Lock statexform: Transformation matrix
Bitmap/image shape (currently read-only from parsed files).
new ShapeBitmap()w: Widthh: HeightdataBase64: Base64-encoded image datagrayscale: Grayscale modedpi: DPI settingditherMode: Dither modehalftone: Halftone modenegative: Negative modebrightnessAdjust: Brightness adjustmentcontrastAdjust: Contrast adjustmentgammaAdjust: Gamma adjustmentcutIndex: Cut setting indexlocked: Lock statexform: Transformation matrix
Container for grouping shapes together (currently read-only from parsed files).
new ShapeGroup()children: Array of child shapescutIndex: Cut setting indexlocked: Lock statexform: Transformation matrix
getChildren(): Returns the children array
Project notes that can be displayed when loading the project.
new Notes()showOnLoad: Whether to show notes on loadtext: Note text content
Variable text settings for dynamic text generation.
new VariableText()start: Start valueend: End valuecurrent: Current valueincrement: Increment valueautoAdvance: Auto-advance setting
You can generate SVG representations of your projects:
import { generateLightBurnSvg } from "lbrnts"
const svg = generateLightBurnSvg(project)