Code Monkey home page Code Monkey logo

v3d-core's Introduction

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.

Features

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

  1. 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
  2. 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 ../../../..
  3. Build v3d-core

    npm install
    npm run build

    Output files will be under dist folder.

Debugging

Go to root folder of this repository and run:

$ npm run debug

The debug page can be opened in any browser with http://localhost:8080/.

Demo Video

See this demo video.

Credits

Licenses

see LICENSE.

Babylon.js is licensed under Apache License 2.0.

v3d-core's People

Stargazers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.