node-three-gltf

This package offers a modified three.js GLTFLoader to load glTF files in a Node.js environment. Files can be loaded from local file system or from web resources. DRACO-compressed glTF files are also supported. GLTFExporter lets you parse a three.js scene and store it as json or binary file.

In order to work in a non-browser environment, following classes had to be adopted from three.js and modified:

• GLTFLoader
• DRACOLoader
• GLTFExporter
• FileLoader
• ImageLoader
• TextureLoader

All are exposed and can be used independently.

Installation

Install via NPM:

npm install node-three-gltf

Usage

Use with ES modules or TypeScript:

import {
  DRACOLoader,
  FileLoader,
  GLTFExporter,
  GLTFLoader,
  ImageLoader,
  loadGltf,
  TextureLoader,
} from 'node-three-gltf';

Init GLTFLoader and pass a path to a local file or a url to a web resource:

const loader = new GLTFLoader();
const dracoLoader = new DRACOLoader();
loader.setDRACOLoader(dracoLoader);

const gltf = await loader.loadAsync('path/to/file');
console.log(gltf.scene.children);

// dispose dracoLoader after usage to terminate workers
dracoLoader.dispose();

A small utility function instantiates GLTFLoader and DRACOLoader and returns a Promise with the loaded content. It finally disposes the DRACO decoder resources.

const gltf = await loadGltf('path/to/file');
console.log(gltf.scene.children);

Use GLTFExporter to export a scene or objects as json .gltf or binary .glb file:

const exporter = new GLTFExporter();

const jsonData = exporter.parseAsync(scene);
fs.writeJson('export.gltf', jsonData, { spaces: 2 });

const glbBuffer = await exporter.parseAsync(scene, { binary: true });
fs.writeFile('export.glb', glbBuffer);

Use TextureLoader, ImageLoader, or FileLoader independently:

const texture = new TextureLoader().loadAsync('path/to/file');
console.log(texture);