Three.js 3D rendering library for javascript #gamedev #game-engine #rendering #javascript

Mr.doob 09e4bac4a8 Updated builds. 4 years ago
.github ffa72a4e66 Update CONTRIBUTING.md 4 years ago
build 09e4bac4a8 Updated builds. 4 years ago
docs 96c001f4f9 Docs: Clarify Raycaster.set(). 4 years ago
editor f5d1f18539 Editor: Clean up. 4 years ago
examples 326b83d6a1 Clean up. 4 years ago
files b963904e7a Examples: Fix toggle icon CSS issue. #19943 4 years ago
src c20528a800 Line: Removed mode parameter. See #20840 4 years ago
test 606b7f0df9 Merge pull request #20900 from takahirox/ExampleUnitTest 4 years ago
utils 326b83d6a1 Clean up. 4 years ago
.editorconfig f1ba3a32ed Remove indent size from .editorconfig 6 years ago
.gitattributes 5446f535d1 git should handle the line endings 7 years ago
.gitignore 08bac6a468 cleanup 5 years ago
LICENSE e122db35fe Update LICENSE 5 years ago
README.md 1d96c8105f Update README.md 4 years ago
icon.png c69db34ef8 Added icon.png 6 years ago
package-lock.json b429478bdd Update documentation 4 years ago
package.json 002ce5c79f Tests: Add npm run test-unit-examples command 4 years ago

README.md

three.js

NPM Package Build Size NPM Downloads Dev Dependencies Language Grade

JavaScript 3D library

The aim of the project is to create an easy to use, lightweight, 3D library with a default WebGL renderer. The library also provides Canvas 2D, SVG and CSS3D renderers in the examples.

ExamplesDocumentationWikiMigratingQuestionsForumSlackDiscord

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 './js/three.module.js';

let camera, scene, renderer;
let geometry, material, mesh;

init();
animate();

function init() {

	camera = new THREE.PerspectiveCamera( 70, window.innerWidth / window.innerHeight, 0.01, 10 );
	camera.position.z = 1;

	scene = new THREE.Scene();

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

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

	renderer = new THREE.WebGLRenderer( { antialias: true } );
	renderer.setSize( window.innerWidth, window.innerHeight );
	document.body.appendChild( renderer.domElement );

}

function animate() {

	requestAnimationFrame( animate );

	mesh.rotation.x += 0.01;
	mesh.rotation.y += 0.02;

	renderer.render( scene, camera );

}

If everything went well, you should see this.

Cloning this repository

Cloning the repo with all its history results in a ~2GB 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