https://github.com/virtual-cast/babylon-vrm-loader
glTF VRM extension Loader for babylon.js
https://github.com/virtual-cast/babylon-vrm-loader
babylonjs vrm webgl
Last synced: about 1 month ago
JSON representation
glTF VRM extension Loader for babylon.js
- Host: GitHub
- URL: https://github.com/virtual-cast/babylon-vrm-loader
- Owner: virtual-cast
- License: mit
- Created: 2019-05-08T02:00:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T13:34:05.000Z (about 1 year ago)
- Last Synced: 2025-03-05T23:47:27.586Z (about 2 months ago)
- Topics: babylonjs, vrm, webgl
- Language: TypeScript
- Homepage: https://virtual-cast.github.io/babylon-vrm-loader/
- Size: 35.7 MB
- Stars: 125
- Watchers: 9
- Forks: 23
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - virtual-cast/babylon-vrm-loader - glTF VRM extension Loader for babylon.js (TypeScript)
- awesome - virtual-cast/babylon-vrm-loader - glTF VRM extension Loader for babylon.js (TypeScript)
README
# babylon-vrm-loader
[](https://badge.fury.io/js/babylon-vrm-loader) [](https://circleci.com/gh/virtual-cast/babylon-vrm-loader) [](https://github.com/semantic-release/semantic-release)
VRM porting to babylon.js.
This loader is used as [VirtualCast](https://virtualcast.jp/) 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.19.0|^2.0.0|
|^6.0.0|will be ^3.0.0|
## Features
- Supports `.vrm` v0.x file loading
- with `extensions.VRM` glTF Extension
- TODO VRM v1.0 file loading
- Supports `.vci` file loading
- Supports [MToonMaterial](https://github.com/virtual-cast/babylon-mtoon-material)
- Get bone([TransformNode](https://doc.babylonjs.com/typedoc/classes/BABYLON.TransformNode)) from Unity Humanoid bone mapping name
- [BlendShape](https://vrm.dev/en/univrm/blendshape/index.html) morphing
- [SpringBone](https://vrm.dev/en/univrm/springbone/index.html)
- Supports [VCI](https://github.com/virtual-cast/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](https://codepen.io/anon/pen/zQXyxL?editors=1010).
### on Babylon.js Playgound
example is [here](https://playground.babylonjs.com/#K5W35Y).
### with npm/yarn
```s
$ npm install --save @babylonjs/core @babylonjs/loaders babylon-vrm-loader
# or
$ yarn add @babylonjs/core @babylonjs/loaders babylon-vrm-loader
```
```ts
import * 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 .
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](./CONTRIBUTING.md).
## Build
```s
$ yarn build
```
### Debugging MToonMaterial
```s
$ yarn debug
```
You 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](https://github.com/BabylonJS/Babylon.js)
- [vrm-c/UniVRM: Unity package that can import and export VRM format](https://github.com/vrm-c/UniVRM)
- [virtual-cast/babylon-mtoon-material: Unity MToon Shader WebGL porting to babylon.js.](https://github.com/virtual-cast/babylon-mtoon-material)
## Licenses
see [LICENSE](./LICENSE).
This project uses [babylon.js with Apache License, Version 2.0](https://github.com/BabylonJS/Babylon.js/blob/master/license.md).