Babylon.js: a complete JavaScript framework for building 3D games with HTML 5 and WebGL
TypeScript JavaScript HLSL HTML Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Better issue template Feb 12, 2018
.vscode Master Apr 20, 2018
Exporters Moved Exporters to https://github.com/BabylonJS/Exporters Oct 14, 2017
Playground Nightly Apr 26, 2018
Tools make sure viewer dependencies are installed Apr 20, 2018
Viewer scene flags and model enabling Apr 20, 2018
assets Add Full Float BRDF Apr 20, 2018
dist rc3 Apr 26, 2018
gui Fix #4157 Apr 19, 2018
inspector Fixed #4211 Apr 25, 2018
loaders Fix animation blending issue with glTF loader Apr 26, 2018
localDev Simplify Draco configuration Apr 5, 2018
materialsLibrary Simplify Background Material Apr 4, 2018
postProcessLibrary Removed strict:true for now Mar 16, 2018
proceduralTexturesLibrary Removed strict:true for now Mar 16, 2018
sandbox Sandbox Fix Apr 24, 2018
serializers change instanceof to typeof for number check Apr 13, 2018
src rc3 Apr 26, 2018
tests rc3 Apr 26, 2018
.gitattributes Ignore whitespace and new lines from windows OS Nov 25, 2015
.gitignore missing declaration Apr 19, 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 rc3 Apr 26, 2018
readme.md Update readme.md Feb 12, 2018
tslint.json "AAAAAAAAAAAAAAAAhhhhhaaaa" step 8 Oct 24, 2017
what's new.md Update Links for API Apr 20, 2018

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

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, {preserveDrawingBuffer: true, stencil: 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, false, BABYLON.Mesh.FRONTSIDE);
    // Move the sphere upward 1/2 of its height
    sphere.position.y = 1;
    // Create a built-in "ground" shape; its constructor takes 6 params : name, width, height, subdivision, scene, updatable
    var ground = BABYLON.Mesh.CreateGround('ground1', 6, 6, 2, scene, false);
    // 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.