Babylon.js README

The project's README from github.com/BabylonJS/Babylon.js. As one markdown file: README.md.

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

Features

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

Babylon.js (BabylonJS/Babylon.js)

Searching Database…

26.2K ·GitHub
Babylon.js
Что это такое?Babylon.js — это открытый 3D-движок для игр и рендеринга, упакованный в удобный JavaScript-фреймворк: вы создаёте сцены на TypeScript или JavaScript и отображаете их прямо в браузере.
Это фреймворк, который я подключаю в свой код, или отдельное приложение?Это библиотека и фреймворк: вы устанавливаете пакеты из npm и импортируете движок в свой проект на JavaScript или TypeScript. Пакеты в формате ES6 с поддержкой tree shaking позволяют импортировать всё сразу или только нужные классы.
Как добавить его в проект?Установите пакеты, опубликованные под пользователем babylonjs на npm, и импортируйте их в свой код. В TypeScript добавьте 'babylonjs' в поле 'types' в tsconfig.json; для простых экспериментов есть онлайн-песочница.
Что нужно установить на компьютере, чтобы запустить его?Нужен только современный браузер — всё рендерится на стороне клиента, сервер или бэкенд не требуется. Лишь для сборки самого исходного кода движка нужен зафиксированный набор инструментов: Node 20.19+/22.13+/24 и npm 11.18+.
Безопасно ли подключать его через CDN в продакшене?Нет — в README прямо сказано, что CDN предназначен только для обучения и небольших экспериментов. Для настоящего приложения лучше раздавать пакеты со своего CDN или собрать ES6-пакеты самостоятельно.
Где он работает — только в браузере или ещё и в нативных приложениях?Он работает в браузере: рендеринг идёт через WebGL, WebGL2 или WebGPU, для гарнитур используется WebXR/WebVR, для звука — WebAudio. Он запускается везде, где есть современный браузер; нативной сборки нет.
Можно попробовать без установки чего-либо?Да. В онлайн-песочнице (playground) много примеров для изучения API, онлайн-инструмент sandbox проверяет ваши сцены .babylon и glTF простым перетаскиванием, а ещё один онлайн-инструмент помогает создавать GLSL-шейдеры.
Можно ли импортировать модели из Blender, 3ds Max или Maya?Да — специальные плагины-экспортёры создают файлы .babylon из 3DS Max, Maya и Blender. Есть также экспортёр для Unity 5, но он устарел, а инструменты glTF от KhronosGroup покрывают работу с glTF.
What are similar projects?engine, three.js, tidewater, aframe, flutter_scene, LinearAbilityExtThreeJS, phaser, bgfx
Which topics is it in?webaudio, webgl2, webgpu, shaders, game-engine, webgl, rendering, game-development, game, 3d, real-time, browser
Creator
BabylonJS
Size
1.4 GB
Stars
26.2K
Updated
CommitOct 16Release9.30.0Oct 08
Age
13y
Commits · 90 Days