babylon-vrm-loader
VRM porting to babylon.js.
This loader is used as THE SEED ONLINE web VRM/VCI/glb viewer.
Supported version table
| babylon.js version | babylon-vrm-loader version |
|---|---|
| ~4.1.0 | <1.5.0 |
| ~4.2.0 | ^1.5.0 |
| ~5.x | unreleased(will be ^2.0.0) |
Features
- Supports
.vrmfile loading- with
extensions.VRMglTF Extension
- with
- Supports
.vcifile loading - Supports MToonMaterial
- Get bone(TransformNode) from Unity Humanoid bone mapping name
- BlendShape morphing
- Secondary Animation
- Supports VCI features(partial support)
VCAST_vci_material_unity- TODO:
VCAST_vci_meta - TODO:
VCAST_vci_embedded_script - TODO:
VCAST_vci_audios - TODO:
VCAST_vci_colliders - TODO:
VCAST_vci_rigidbody - TODO:
VCAST_vci_joints - TODO:
VCAST_vci_item
Usage
on browser
example is here.
on Babylon.js Playgound
example is here.
with npm/yarn
$ npm install --save @babylonjs/core @babylonjs/loaders babylon-vrm-loader
# or
$ yarn add @babylonjs/core @babylonjs/loaders babylon-vrm-loaderimport * as BABYLON from '@babylonjs/core'
// has side-effect
// ref. https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free
import 'babylon-vrm-loader'
// vrmFile is File object retrieved by <input type="file">.
const scene = await BABYLON.SceneLoader.LoadAsync('file:', vrmFile, engine);
const vrmManager = scene.metadata.vrmManagers[0];
// Update secondary animation
scene.onBeforeRenderObservable.add(() => {
vrmManager.update(scene.getEngine().getDeltaTime());
});
// Model Transformation
vrmManager.rootMesh.translate(new BABYLON.Vector3(1, 0, 0), 1);
// Work with HumanoidBone
vrmManager.humanoidBone.leftUpperArm.addRotation(0, 1, 0);
// Work with BlendShape(MorphTarget)
vrmManager.morphing('Joy', 1.0);Contributing
See CONTRIBUTING.md.
Build
$ yarn buildDebugging MToonMaterial
$ yarn debugYou can see inspector on http://localhost:8080/
Related Links
- BabylonJS/Babylon.js: Babylon.js: a complete JavaScript framework for building 3D games with HTML 5 and WebGL
- vrm-c/UniVRM: Unity package that can import and export VRM format
- virtual-cast/babylon-mtoon-material: Unity MToon Shader WebGL porting to babylon.js.
Licenses
see LICENSE.
This project uses babylon.js with Apache License, Version 2.0.