three.js README

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

three.js

NPM Package Build Size NPM Downloads jsDelivr Downloads Discord

JavaScript 3D library

The aim of the project is to create an easy-to-use, lightweight, cross-browser, general-purpose 3D library. The current builds only include WebGL and WebGPU renderers but SVG and CSS3D renderers are also available as addons.

Examples — Docs — Manual — Wiki — Migrating — Questions — Forum — Discord

Usage

This code creates a scene, a camera, and a geometric cube, and it adds the cube to the scene. It then creates a WebGL renderer for the scene and camera, and it adds that viewport to the document.body element. Finally, it animates the cube within the scene for the camera.

import * as THREE from 'three';

const width = window.innerWidth, height = window.innerHeight;

// init

const camera = new THREE.PerspectiveCamera( 70, width / height, 0.01, 10 );
camera.position.z = 1;

const scene = new THREE.Scene();

const geometry = new THREE.BoxGeometry( 0.2, 0.2, 0.2 );
const material = new THREE.MeshNormalMaterial();

const mesh = new THREE.Mesh( geometry, material );
scene.add( mesh );

const renderer = new THREE.WebGLRenderer( { antialias: true } );
renderer.setSize( width, height );
renderer.setAnimationLoop( animate );
document.body.appendChild( renderer.domElement );

// animation

function animate( time ) {

	mesh.rotation.x = time / 2000;
	mesh.rotation.y = time / 1000;

	renderer.render( scene, camera );

}

If everything goes well, you should see this.

Cloning this repository

Cloning the repo with all its history results in a ~2 GB download. If you don't need the whole history you can use the depth parameter to significantly reduce download size.

git clone --depth=1 https://github.com/mrdoob/three.js.git

Change log

Releases

three.js (mrdoob/three.js)

Searching Database…

116.5K ·GitHub
Three.js
Что это такое?Это JavaScript-библиотека трёхмерной графики для браузера: проект ставит целью быть простым в использовании, лёгким, кроссбраузерным и универсальным. Существует с 2010 года, сейчас у него более 116 000 звёзд на GitHub.
Это готовое приложение или то, что я использую в своём коде?Это библиотека, которую вы подключаете в свой JavaScript-код, а не самостоятельное приложение. Основные сборки включают рендереры WebGL и WebGPU; рендереры SVG и CSS3D идут в виде аддонов.
Как выглядит минимальный рабочий пример?Рецепт — в разделе Usage файла README: создать сцену, добавить камеру и куб, привязать область просмотра рендерера к странице, а затем анимировать куб в цикле.
При установке он подтянет другие пакеты?Нет. В пакете ноль runtime-зависимостей; понадобится лишь браузер с поддержкой WebGL, чтобы что-то отрисовать.
Есть ли подводные камни, если я склонирую репозиторий, чтобы покопаться в коде?Только размер: клонирование с полной историей скачивает около 2 ГБ, так что передайте параметр depth, чтобы уменьшить объём.
Он умеет в VR и AR или только плоские 3D?Да — WebXR, виртуальная и дополненная реальность входят в список тем проекта на GitHub, так что иммерсивный контент в браузере охвачен наряду с обычным 3D-рендерингом.
What are similar projects?engine, Babylon.js, aframe, awesome-opus5-5-videos, sylva, pixijs, react-three-fiber, zdog
Which topics is it in?webaudio, augmented-reality, webgl2, virtual-reality, games, cross-browser, webgpu, html5, threejs, canvas, webgl, rendering
Creator
mrdoob
Size
1.6 GB
Stars
116.5K
Updated
CommitOct 17Releaser186Sep 24
Age
16y
Commits · 90 Days