Babylon.js

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.

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

CDN

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

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:

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

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

Import the library

Using an HTML file:

<script src="https://cdn.babylonjs.com/babylon.js"></script>

Or in Javascript/Typescript using a bundler such as Webpack or Parcel:

import * as BABYLON from 'babylonjs';

Add a script

// Create canvas html element on webpage
var canvas = document.createElement('canvas');;
document.body.appendChild(canvas);

// Initialize Babylon scene and engine
var engine = new BABYLON.Engine(canvas, true);
var scene = new BABYLON.Scene(engine);
engine.runRenderLoop(()=>{
    scene.render();
});

// Create objects in the scene
var camera = new BABYLON.FreeCamera("camera", new BABYLON.Vector3(0, 0, 0), scene);
camera.attachControl(canvas,true)
var light = new BABYLON.PointLight("light", new BABYLON.Vector3(10,10,0), scene);
var box = BABYLON.Mesh.CreateBox("box", 1.0, scene);
box.position.z = 5;

// Run's once per game frame
scene.onBeforeRenderObservable.add(()=>{
    box.position.x += 0.01;
    box.rotation.x += 0.01;
    box.rotation.y += 0.01;
});

Preview release

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

Documentation

• Documentation
• Samples
• Video overview (1 hour) of BabylonJS features
• Complete course (8 hours)

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.