tinyusdz/readme.md

Tinyusdz wasm

# Tinyusdz WASM/JS

JS/WASM version of TinyUSDZ.

## Demos

[Github pages](https://lighttransport.github.io/tinyusdz/demos.html)


## Install

```
$ npm install tinyusdz
```

## Quick usage

We only provide a loader for Three.js at the moment.

```js
import { TinyUSDZLoader } from 'tinyusdz/TinyUSDZLoader.js'
import { TinyUSDZLoaderUtils } from 'tinyusdz/TinyUSDZLoaderUtils.js'

async function loadScenes() {

  const loader = new TinyUSDZLoader();

  // it is recommended to call init() before loadAsync()
  // (init() does wasm loading/compiling)
  await loader.init();

  const suzanne_url = "./assets/suzanne-pbr.usda";

  const usd_scene = await loader.loadAsync(suzanne_url);

  const usdRootNode = usd_scene.getDefaultRootNode();

  const defaultMtl = TinyUSDZLoaderUtils.createDefaultMaterial();

  const options = {
    overrideMaterial: false // override USD material with defaultMtl(default 'false')
  }

  const threeNode = TinyUSDZLoaderUtils.buildThreeNode(usdRootNode, defaultMtl, usd_scene, options);

  //
  // Add threeNode to threejs scene.
  //
} 
```

## Using zstd compressed wasm

TinyUSDZ WASM module consumes around 2 MB(as of 2025 Jun).
npm package contains zstd compressed WASM(roughly 420kb as of 2025 Jun).

If you want to use zstd compressed WASM, set 'useZstdCompressedWasm' true in `init()` arg.

```
  const loader = new TinyUSDZLoader();
  await loader.init({useZstdCompressedWasm: true});
```

## Find more on TinyUSDZ module

See https://github.com/lighttransport/tinyusdz/tree/release/web/demo 

## NPM packaging

See `<tinyusdz>/.github/workflows/wasmPublish.yml` to assemble files for npm packaging.