V3d-core NPM | npm.io

v3d-core

WebGL-based humanoid model rendering engine.

Objectives

This project aims to be an easy-to-use library for rendering 3D and pseudo-2D humanoid models. We choose WebGL because of its portability across platforms, as well as the broad support from JavaScript community.

This project will be part of project Gamma, a free and open virtual casting solution strives to provide a friendly and safe environment for streamers.

Features

Contains one simple API for interacting with scene and models
Supports .vrm file loading, including:
- Unity Humanoid bone mapping
- BlendShape morphing
- Secondary Animation
- MToonMaterial

Usage

Install from NPM

npm install v3d-core

In browser

Some older browsers may not be supported.

Please see examples/browser for an example.

A more complicated example can be found in examples/classroom.

On Babylon.js Playground

Currently, this is not possible since we use a modified Babylon.js fork.

For node.js and webpack

All modules support ES6 imports.

Please see index-test.ts for an example.

Contributing

See CONTRIBUTING.md.

Build

Clone this repo and submodules:

git clone https://github.com/phantom-software-AZ/v3d-core.git --recurse-submodules

If your Internet connection is slow, try the following instead:

git clone https://github.com/phantom-software-AZ/v3d-core.git --recurse-submodules --shallow-submodules

Build Babylon.js

cd lib/Babylon.js && git checkout master-custom && npm install
cd Tools/Gulp && npm install
gulp typescript-libraries --noGlobalInstall && gulp npmPackages-es6 --noGlobalInstall
cd ../../../..