render-glb

Render GLB (glTF 2.0 Binary) 3D models to PNG images using headless WebGL.

Features

- Headless rendering - no display required
- Auto-fit camera to model bounds
- Configurable output dimensions
- Cross-platform: macOS, Linux, Windows
- JSON output for scripting

Installation

``bash
npm install -g render-glb
`

Or use directly with bunx/npx (no install needed):

`bash
bunx render-glb model.glb output.png
npx render-glb model.glb output.png
`

Usage

`bash
render-glb [options]

Options:
--width N Output image width (default: 1024)
--height N Output image height (default: 1024)
--help, -h Show help message
`

Auto-scaling: The camera automatically adjusts to fit any model size, from millimeter-scale parts to large assemblies.

$3

`bash


Basic usage

render-glb model.glb output.png

Custom dimensions

render-glb model.glb output.png --width 1024 --height 1024

Linux headless (no display)

xvfb-run render-glb model.glb output.png
`

$3

Returns JSON to stdout:

`json
{
"success": true,
"input": "/path/to/model.glb",
"output": "/path/to/output.png",
"width": 512,
"height": 512,
"size_bytes": 12345,
"render_time_ms": 150
}
`

Platform Notes

$3

Works directly, no additional setup needed.

$3

Requires xvfb for virtual framebuffer:

`bash


Ubuntu/Debian

sudo apt-get install xvfb libgl1-mesa-dev

Run with xvfb-run

xvfb-run render-glb model.glb output.png
``

$3

Should work directly with Node.js 18+.

Dependencies

- three.js - 3D rendering engine
- gl - Headless WebGL
- node-three-gltf - GLB loader for Node.js
- pngjs - PNG encoding
- jsdom - DOM shim for Three.js

License

MIT