Babylon.js: a complete JavaScript framework for building 3D games with HTML 5 and WebGL
TypeScript JavaScript HLSL HTML Other
Permalink
Failed to load latest commit information.
.vscode Particle System Update Jan 17, 2018
Exporters Moved Exporters to https://github.com/BabylonJS/Exporters Oct 14, 2017
Playground Add code comments for geometry class Jan 19, 2018
Tools Add what's new check in the build Fixed #3592 Jan 20, 2018
Viewer Adding config.json to the basic example Jan 19, 2018
assets Moving redirects to the right directory Dec 15, 2017
dist Add what's new check in the build Fixed #3592 Jan 20, 2018
gui Fix #3492 Jan 18, 2018
inspector Fixed issue with inspector adding meshes at each display Jan 16, 2018
loaders Merge pull request #3594 from kcoley/kcoley/refactorGLTFSerializer Jan 20, 2018
localDev Revert "fixed silder's GUI thumbWith issue, #3359" Dec 24, 2017
materialsLibrary Fix #3537 Jan 16, 2018
postProcessLibrary Fix type definition Nov 7, 2017
proceduralTexturesLibrary Ground color setter missed underscore Dec 12, 2017
sandbox Change sandbox to play only the first glTF animation Jan 2, 2018
serializers refactor glTF serializer to use glTF interface. Jan 20, 2018
src fix comments in pr Jan 20, 2018
tests merge master Jan 20, 2018
.gitattributes Ignore whitespace and new lines from windows OS Nov 25, 2015
.gitignore Add Unit Tests Skeleton and gulp tasks Jan 16, 2018
.gitmodules DAE Exporter Dec 5, 2013
.travis.yml Add what's new check in the build Fixed #3592 Jan 20, 2018
bower.json Update bower.json to latest version Jan 2, 2017
contributing.md Update contributing.md Mar 1, 2017
favicon.ico Browser stack readyness Jan 5, 2018
license.md Moved license to a separate file Jun 23, 2017
package.json Documentation (#3561) Jan 18, 2018
readme.md Corrects the information in the comments. Jan 11, 2018
tslint.json "AAAAAAAAAAAAAAAAhhhhhaaaa" step 8 Oct 24, 2017
what's new.md First mega merge Dec 12, 2017

readme.md

Babylon.js

Getting started? Play directly with the Babylon.js API via our playground. It contains also lot of simple samples to learn how to use it.

Build Status

BrowserStack Status

Any questions? Here is our official forum on www.html5gamedevs.com.

CDN

Additional references can be found on https://cdn.babylonjs.com/xxx where xxx is the folder structure you can find in the /dist folder like https://cdn.babylonjs.com/gui/babylon.gui.min.js

For preview release you can use the following ones:

Additional references can be found on https://preview.babylonjs.com/xxx where xxx is the folder structure you can find in the /dist/preview release folder like https://preview.babylonjs.com/gui/babylon.gui.min.js

NPM

BabylonJS and its modules are published on NPM with full typing support. To install use

npm install babylonjs --save

This will allow you to import BabylonJS entirely using:

import * as BABYLON from 'babylonjs';

or individual classes using:

import { Scene, Engine } from 'babylonjs';

If using TypeScript, don't forget to add 'babylonjs' to 'types' in tsconfig.json:

    ....
    "types": [
        "babylonjs",
        "anotherAwesomeDependency"
    ],
    ....

To add a module install the respected package. A list of extra packages and their installation instructions can be found on babylonjs' user at npm.

Usage

See Getting Started

// get the canvas DOM element
var canvas = document.getElementById('renderCanvas');
// load the 3D engine
var engine = new BABYLON.Engine(canvas, true);
// createScene function that creates and return the scene
var createScene = function(){
    // create a basic BJS Scene object
    var scene = new BABYLON.Scene(engine);
    // create a FreeCamera, and set its position to (x:0, y:5, z:-10)
    var camera = new BABYLON.FreeCamera('camera1', new BABYLON.Vector3(0, 5,-10), scene);
    // target the camera to scene origin
    camera.setTarget(BABYLON.Vector3.Zero());
    // attach the camera to the canvas
    camera.attachControl(canvas, false);
    // create a basic light, aiming 0,1,0 - meaning, to the sky
    var light = new BABYLON.HemisphericLight('light1', new BABYLON.Vector3(0,1,0), scene);
    // create a built-in "sphere" shape; its constructor takes 6 params: name, segment, diameter, scene, updatable, sideOrientation
    var sphere = BABYLON.Mesh.CreateSphere('sphere1', 16, 2, scene);
    // move the sphere upward 1/2 of its height
    sphere.position.y = 1;
    // create a built-in "ground" shape; its constructor takes the same 6 params : name, width, height, subdivision, scene, updatable
    var ground = BABYLON.Mesh.CreateGround('ground1', 6, 6, 2, scene);
    // return the created scene
    return scene;
}
// call the createScene function
var scene = createScene();
// run the render loop
engine.runRenderLoop(function(){
    scene.render();
});
// the canvas/window resize event handler
window.addEventListener('resize', function(){
    engine.resize();
});

Preview release

Preview version of 3.2 can be found here. If you want to contribute, please read our contribution guidelines first.

Documentation

Useful links

  • Official web site: www.babylonjs.com
  • Online sandbox where you can test your .babylon scenes with a simple drag'n'drop
  • Online shader creation tool where you can learn how to create GLSL shaders
  • 3DS Max exporter can be used to generate a .babylon file from 3DS Max
  • Blender exporter can be used to generate a .babylon file from Blender 3d
  • Unity 5 exporter can be used to export your geometries from Unity 5 scene editor(animations are supported)

Features

To get a complete list of supported features, please visit our website.