Getting Started

Installation

Install only what you need. three and @threlte/core are the minimum required to get going. The remaining packages can be added anytime.

@threlte/gltf doesn’t require installation, instead run it with npx. The components generated by @threlte/gltf require @threlte/extras to be installed.

Choose the packages you want to use

Simple, transparent Three.js bindings. three is required as a peer dependency.

Components, helpers, hooks and more that add functionality.

A command-line tool that turns GLTF assets into declarative and re-usable Threlte components. The generated Threlte components need @threlte/extras to work.

Components and hooks to use the Rapier physics engine.

Components and hooks to use the animation library Theatre.js.

Components and hooks for VR and AR.

Components and hooks to use the flex engine Yoga.

Spatial Programming Toolset for Threlte.

TypeScript types for Three.js.

Install the packages with npm, pnpm, yarn or any other package manager you prefer.

npm install three @threlte/core

See this comment for tips on how to reduce bundle size when working with bundlers like Vite and Three.js.

Previous Page Your First Scene

Next Page App Structure