@pixiv/three-vrm 2.1.2 → 3.0.0-beta.1

package/README.md

@@ -14,16 +14,6 @@ Use [VRM](https://vrm.dev/) on [three.js](https://threejs.org/)
 
 [API Reference](https://pixiv.github.io/three-vrm/packages/three-vrm/docs)
 
-## v1
-
-**three-vrm v1 has been released!**
-
-three-vrm v1 supports [VRM1.0](https://vrm.dev/vrm1/), which is a new version of VRM format (the previous version of VRM is also supported, don't worry!).
-It also adopts the GLTFLoader plugin system which is a relatively new feature of GLTFLoader.
-
-There are a lot of breaking changes!
-See [the migration guide](https://github.com/pixiv/three-vrm/blob/dev/docs/migration-guide-1.0.md) for more info.
-
 ## How to Use
 
 ### from HTML
@@ -102,7 +92,7 @@ Code like this:
 
 ```javascript
 import * as THREE from 'three';
-import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader';
+import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import { VRMLoaderPlugin } from '@pixiv/three-vrm';
 
 const scene = new THREE.Scene();
@@ -138,6 +128,41 @@ loader.load(
 );
 ```
 
+### Use with WebGPURenderer
+
+Starting from v3, we provide [WebGPURenderer](https://github.com/mrdoob/three.js/blob/master/examples/jsm/renderers/webgpu/WebGPURenderer.js) compatibility.
+To use three-vrm with WebGPURenderer, specify the WebGPU-compatible `MToonNodeMaterial` for the `materialType` option of `MToonMaterialLoaderPlugin`.
+
+`MToonNodeMaterial` only supports Three.js r161 or later.
+The NodeMaterial system of Three.js is still under development, so we may break compatibility with older versions of Three.js more frequently than other parts of three-vrm.
+
+```js
+import { VRMLoaderPlugin } from '@pixiv/three-vrm';
+import { MToonNodeMaterial } from '@pixiv/three-vrm/nodes';
+
+// ...
+
+// Register a VRMLoaderPlugin
+loader.register((parser) => {
+
+  // create a WebGPU compatible MToonMaterialLoaderPlugin
+  const mtoonMaterialPlugin = new MToonMaterialLoaderPlugin(parser, {
+
+    // set the material type to MToonNodeMaterial
+    materialType: MToonNodeMaterial,
+
+  });
+
+  return new VRMLoaderPlugin(parser, {
+
+    // Specify the MToonMaterialLoaderPlugin to use in the VRMLoaderPlugin instance
+    mtoonMaterialPlugin,
+
+  });
+
+});
+```
+
 ## Contributing
 
 See: [CONTRIBUTING.md](CONTRIBUTING.md)