Installation

Alpha Release

three-flatland is in alpha. Expect breaking changes between releases. Consider pinning the exact version in your package.json until you’re ready to migrate.

Package Manager

npm

npm install three-flatland@alpha

pnpm

pnpm add three-flatland@alpha

yarn

yarn add three-flatland@alpha three koota

bun

bun add three-flatland@alpha

React Three Fiber (Optional)

React is not required. If you’re using React Three Fiber, add the additional dependencies:

npm

npm install three-flatland@alpha @react-three/fiber@alpha

pnpm

pnpm add three-flatland@alpha @react-three/fiber@alpha

yarn

yarn add three-flatland@alpha @react-three/fiber@alpha three koota react react-dom

bun

bun add three-flatland@alpha @react-three/fiber@alpha

Requirements

• Three.js: >= 0.183.1 (required for TSL/WebGPU support)
• koota: >= 0.1.0 (ECS for batch rendering)
• React: >= 19.0.0 (for three-flatland/react)
• @react-three/fiber: >= 10.0.0-alpha.2 (for three-flatland/react)
• Node.js: >= 22 (LTS)

TypeScript

three-flatland is written in TypeScript and ships with full type definitions. No additional @types packages are required.