• Stars
    star
    22,116
  • Rank 1,012 (Top 0.03 %)
  • Language
    TypeScript
  • License
    Apache License 2.0
  • Created almost 11 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Babylon.js is a powerful, beautiful, simple, and open game and rendering engine packed into a friendly JavaScript framework.

Babylon.js

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.

npm version Build Status Average time to resolve an issue Percentage of issues still open Build size Twitter Discourse users

Any questions? Here is our official forum.

CDN

⚠️ WARNING: The CDN should not be used in production environments. The purpose of our CDN is to serve Babylon packages to users learning how to use the platform or running small experiments. Once you've built an application and are ready to share it with the world at large, you should serve all packages from your own CDN.

For the preview release, use the following URLs:

A list of additional references can be found here.

npm

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

npm install babylonjs --save

alternatively, you can now rely on our ES6 packages. Using the ES6 version will allow tree shaking among other bundling benefits.

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 respective package. A list of extra packages and their installation instructions can be found on the babylonjs user on 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 using the SphereBuilder
    var sphere = BABYLON.MeshBuilder.CreateSphere('sphere1', {segments: 16, diameter: 2, sideOrientation: BABYLON.Mesh.FRONTSIDE}, scene);
    // Move the sphere upward 1/2 of its height
    sphere.position.y = 1;
    // Create a built-in "ground" shape;
    var ground = BABYLON.MeshBuilder.CreateGround("ground1", { width: 6, height: 6, subdivisions: 2, updatable: false }, 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();
});

Contributing

If you want to contribute, please read our contribution guidelines first.

Documentation

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 our website.

More Repositories

1

Spector.js

Explore and Troubleshoot your WebGL scenes with ease.
TypeScript
1,215
star
2

Editor

Community managed visual editor for Babylon.js
TypeScript
804
star
3

BabylonNative

Build cross-platform native applications with the power of the Babylon.js JavaScript framework
C++
729
star
4

Exporters

Exporters for Babylon.js and gltf file formats
Mathematica
577
star
5

BabylonReactNative

Build React Native applications with the power of Babylon Native
C++
350
star
6

BlenderExporter

Exports From Blender to Babylon.JS in JSON / .babylon format
Python
280
star
7

Website

Main babylon.js website
JavaScript
196
star
8

Extensions

Extensions for Babylon.js
JavaScript
169
star
9

UnityExporter

Home of the community maintained Unity exporter for Babylon.js
159
star
10

SpacePirates

The Space Pirates game is a demo made to celebrate the Babylon.js 5.0 Release.
TypeScript
142
star
11

Assets

A place for public domain digital assets to use.
JavaScript
140
star
12

SummerFestival

Source code for game tutorial written by capucat
TypeScript
125
star
13

BabylonAR

Home of the Babylon.AR project
TypeScript
72
star
14

Documentation

Babylon.js's documentation website
TypeScript
68
star
15

OldDocumentationSite

Babylon.js documentation page
JavaScript
66
star
16

MeshesLibrary

Use this repo as a place to share your scenes and meshes
JavaScript
47
star
17

BabylonReactNativeSample

Java
33
star
18

CYOS

Create Your Own Shader
JavaScript
23
star
19

BabylonPolymorph

C++
22
star
20

SpacePiratesAR

Space Pirates Demo with Babylon React-Native and AR.
TypeScript
19
star
21

npm-package-template

JavaScript
16
star
22

Controls

Set of web controls using babylon.js and the GPU to render their content in a hardware accelerated way
TypeScript
14
star
23

JsRuntimeHost

The JsRuntimeHost is a library that provides cross-platform C++ JavaScript hosting for any JavaScript engines with Node-API support such as Chakra, V8, or JavaScriptCore.
C++
12
star
24

Brand-Toolkit

11
star
25

twgsl

C++
9
star
26

BabylonNativeExamples

A collection of sample code projects using Babylon Native to illustrate various scenarios
C++
8
star
27

UrlLib

UrlLib is a cross-platform C++ library that utilizes platform-specific implementations for URL-related functionality
C++
7
star
28

asset-host-template

5
star
29

Demos

A repository of Babylon.js Demos
TypeScript
5
star
30

havok

The Havok Physics plugin runtime files (wasm and js)
TypeScript
5
star
31

Documentation-search-engine

Website used to store documentation search engine
JavaScript
3
star
32

SpectorJSWebsite

Website for https://github.com/BabylonJS/Spector.js
JavaScript
3
star
33

CMakeExtensions

Helper functions for CMake
CMake
2
star
34

SnippetServerReference

JavaScript
1
star
35

AndroidExtensions

AndroidExtensions is a C++ utility library for Android development
C++
1
star