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

Mr.doob 298f4b8e62 r148 2 years ago
.github 155048691d Clean up. 2 years ago
build 03349e98aa r148 2 years ago
docs 87223b87ed Add Mesh.getVertexPosition (#25049) 2 years ago
editor 31bcc6d84f Material: Add `TwoPassDoubleSide`. (#25165) 2 years ago
examples 87223b87ed Add Mesh.getVertexPosition (#25049) 2 years ago
files cd7293a5e1 Examples: Added external tag (#24281) 3 years ago
manual 5e32db2874 Manual: Correct material table. (#25087) 2 years ago
src 03349e98aa r148 2 years ago
test 768ea935b9 Object3D: Added getObjectsByProperty() (#25006) 2 years ago
utils 1b31fef7c0 Remove examples/js. (#25043) 2 years ago
.editorconfig f1ba3a32ed Remove indent size from .editorconfig 6 years ago
.gitattributes 5446f535d1 git should handle the line endings 7 years ago
.gitignore 6bab8bdef3 test-treeshake: Add rollup-plugin-visualizer (#21657) 4 years ago
.lgtm.yml 9c3b8dd8d2 add lgtm config (#23062) 3 years ago
LICENSE 484f9e24f2 Update LICENSE (#23131) 3 years ago
README.md b71c5cfc94 "Officialize" renaming of examples classes to addons (#24579) 2 years ago
icon.png 9760d3d86b Optimize icon image (#23238) 3 years ago
package-lock.json b4ec85b9c5 Updated package.json (#25044) 2 years ago
package.json 03349e98aa r148 2 years ago

README.md

three.js

NPM Package Build Size NPM Downloads DeepScan 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 a WebGL renderer but WebGPU (experimental), SVG and CSS3D renderers are also available as addons.

ExamplesDocsManualWikiMigratingQuestionsForumDiscord

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';

// init

const camera = new THREE.PerspectiveCamera( 70, window.innerWidth / window.innerHeight, 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( window.innerWidth, window.innerHeight );
renderer.setAnimationLoop( animation );
document.body.appendChild( renderer.domElement );

// animation

function animation( time ) {

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

	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 ~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