Dangoz / glTF-Compressor

To store the source code for the glTF-Compressor project

glTF-Compressor

This is the official Khronos glTF 2.0 image and geometry compression project using WebGL: glTF-Compressor

Table of Contents

• Version
• Credits
• Features
• Setup
• Web App

Version

Image compression using KTX 2, JPEG, PNG and WebP.

Geometry compression using DRACO, MeshOpt and MeshQuantization.

Credits

Developed by Phasmatic. Supported by the Khronos Group. Original code based on the glTF-Sample Viewer project.

Features

On top of existing glTF Sample Viewer features, this project adds functionality for:

• EXT_texture_webp
• EXT_meshopt_compression
• KHR_draco_mesh_compression
• KHR_mesh_quantization
• Images preview
• 3D mesh comparison (original/compressed images and geometry)
• 2D image comparison (original/compressed images) with zoom operation
• KTX 2 encoding
• JPEG encoding
• PNG encoding
• WebP encoding
• DRACO compression
• MeshOpt compression
• Mesh Quantization options
• Model export (gltf, gltf-embedded, glb)

Setup

For local usage and debugging, please follow these instructions:

0. Make sure Git LFS is installed.

1. Checkout the main branch

2. Pull the submodules for the required glTF sample models and environments git submodule update --init --recursive

Web App

You can find an example application for the glTF-Compressor in the app_web subdirectory of the glTF-Compressor repository. A live demo can be found at https://phasmatic3d.github.io/glTF-Sample-Viewer-KTX-demo/.

Running a local version

Open a terminal window in the repository root an run the following commands

cd app_web
npm install 
npm run dev

now you can access glTF-Compressor with Chrome or Firefox at the URL http://localhost:8000