0.4.0 • Published 2 years ago

gltf-optimizer v0.4.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Demo

Caution

Only can compress .glb file now.
Will be support .gltf soon.

Introduce

Optimize glTF.
Draco compress and convert texture to WebP.

Using glTF-Transform and webp-converter-browser

Install

# If you want to use CLI
npm install --global gltf-optimizer

# npm
npm install gltf-optimizer

# yarn
yarn add gltf-optimizer

# pnpm
pnpm add gltf-optimizer

# bun
bun add gltf-optimizer

# If you install and use browser side
cp node_modules/gltf-optimizer/draco3d/* ./<your_static_path>/

Usage

import { optimizer } from 'gltf-optimizer'

// ...

// node (backend side)
const glb = fs.readFileSync('./target.glb')
const optimized = await optimizer.node(glb, { /* options */ })
fs.writeFileSync('./compressed.glb', optimized)

// browser (frontend side)
const optimized = await optimizer.web(glb, { /* options */ })
// if using get-file-using-a-tag (https://github.com/juunini/get-file-using-a-tag)
download({ fileName: 'compressed.glb', arrayBuffer: optimized })

Usage(CLI)

gltf-optimizer -i model.glb
gltf-optimizer -i model.glb -o ./output

Command-Line Flags

FlagDescriptionRequired
--help, -hDisplay helpNo
--input, -iPath to the glTF or glb file.:white_check_mark: Yes
--output, -oOutput path of the glTF or glb file. Separate resources will be saved to the same directory.No, default ./
--emissiveStrengthEmissive strength of the glTF file.No, default 1.0
--draco.methodedgebreaker or sequentialNo, default edgebreaker
--weld.toleranceTolerance, as a fraction of primitive AABB, used when merging similar vertices.No, default 0.0001
--simplify.enabledEnable/disable vertex simplification.No, default true
--simplify.ratioTarget ratio (0-1) of vertices to keep.No, default 0.75
--simplify.errorLimit on error, as a fraction of mesh radius.No, default 0.01
--texture.resize.resolutionMaximum width/height to enforce, preserving aspect ratio. For example, a 4096x8192 texture, resized with limit 2048, 2048 will be reduced to 1024x2048.No, default 1024
--texture.resize.filterResampling filter method. LANCZOS3 is sharper, LANCZOS2 is smoother.No, default LANCZOS3
0.4.0-alpha.4

2 years ago

0.4.0-alpha.3

2 years ago

0.4.0-alpha.2

2 years ago

0.4.0-alpha.1

2 years ago

0.4.0-alpha.5

2 years ago

0.3.6

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.4.0

2 years ago

0.3.5

2 years ago

0.3.4

2 years ago

0.3.3

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.2

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.0

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago