Babylon.js

• We recommend using the Core ES6-supported version;

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

Any questions? Here is our official forum.

CDN

• https://cdn.babylonjs.com/babylon.js
• https://cdn.babylonjs.com/babylon.max.js

For the preview release, use the following URLs:

• https://preview.babylonjs.com/babylon.js
• https://preview.babylonjs.com/babylon.max.js

npm

BabylonJS and its modules are published on npm with full typing support. To install, use:

1npm install babylonjs --save

This will allow you to import BabylonJS entirely using:

1import * as BABYLON from 'babylonjs';

or individual classes using:

1import { Scene, Engine } from 'babylonjs';

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

1    ...
2    "types": [
3        "babylonjs",
4        "anotherAwesomeDependency"
5    ],
6    ...

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

Usage

See Getting Started:

1// Get the canvas DOM element
2var canvas = document.getElementById('renderCanvas');
3// Load the 3D engine
4var engine = new BABYLON.Engine(canvas, true, {preserveDrawingBuffer: true, stencil: true});
5// CreateScene function that creates and return the scene
6var createScene = function(){
7    // Create a basic BJS Scene object
8    var scene = new BABYLON.Scene(engine);
9    // Create a FreeCamera, and set its position to {x: 0, y: 5, z: -10}
10    var camera = new BABYLON.FreeCamera('camera1', new BABYLON.Vector3(0, 5, -10), scene);
11    // Target the camera to scene origin
12    camera.setTarget(BABYLON.Vector3.Zero());
13    // Attach the camera to the canvas
14    camera.attachControl(canvas, false);
15    // Create a basic light, aiming 0, 1, 0 - meaning, to the sky
16    var light = new BABYLON.HemisphericLight('light1', new BABYLON.Vector3(0, 1, 0), scene);
17    // Create a built-in "sphere" shape; its constructor takes 6 params: name, segment, diameter, scene, updatable, sideOrientation
18    var sphere = BABYLON.Mesh.CreateSphere('sphere1', 16, 2, scene, false, BABYLON.Mesh.FRONTSIDE);
19    // Move the sphere upward 1/2 of its height
20    sphere.position.y = 1;
21    // Create a built-in "ground" shape; its constructor takes 6 params : name, width, height, subdivision, scene, updatable
22    var ground = BABYLON.Mesh.CreateGround('ground1', 6, 6, 2, scene, false);
23    // Return the created scene
24    return scene;
25}
26// call the createScene function
27var scene = createScene();
28// run the render loop
29engine.runRenderLoop(function(){
30    scene.render();
31});
32// the canvas/window resize event handler
33window.addEventListener('resize', function(){
34    engine.resize();
35});

Documentation

• Documentation
• Examples

Contributing

Please see the Contributing Guidelines.

Useful links

• Official web site: www.babylonjs.com
• Online playground to learn by experimentating
• Online sandbox where you can test your .babylon and glTF 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
• Maya exporter can be used to generate a .babylon file from Maya
• Blender exporter can be used to generate a .babylon file from Blender 3d
• Unity 5 (deprecated) exporter can be used to export your geometries from Unity 5 scene editor(animations are supported)
• glTF Tools by KhronosGroup

Features

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