Giter VIP home page Giter VIP logo

gltf-optimizer's Introduction

GLTF Optimizer


TypeScript GLTF


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

Flag Description Required
--help, -h Display help No
--input, -i Path to the glTF or glb file. โœ… Yes
--output, -o Output path of the glTF or glb file. Separate resources will be saved to the same directory. No, default ./
--emissiveStrength Emissive strength of the glTF file. No, default 1.0
--draco.method edgebreaker or sequential No, default edgebreaker
--weld.tolerance Tolerance, as a fraction of primitive AABB, used when merging similar vertices. No, default 0.0001
--simplify.enabled Enable/disable vertex simplification. No, default true
--simplify.ratio Target ratio (0-1) of vertices to keep. No, default 0.75
--simplify.error Limit on error, as a fraction of mesh radius. No, default 0.01
--texture.resize.resolution Maximum 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.filter Resampling filter method. LANCZOS3 is sharper, LANCZOS2 is smoother. No, default LANCZOS3

gltf-optimizer's People

Contributors

juunini avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.