Project Templates & Samples
Get started quickly with these official templates and sample projects. Each repository can be cloned or used as a GitHub template to kickstart your project.
Quick Start
The fastest way to create a new project is with npm create needle or by visiting engine.needle.tools/new.
Templates
| Template | Description |
|---|---|
| Vite Template | The default Needle Engine starter — vanilla HTML/JS with Vite. Also available at engine.needle.tools/new |
| Scrollytelling Template | Kickstart 3D scroll-driven websites |
| React | Needle Engine with React |
| Vue.js | Needle Engine with Vue.js |
| SvelteKit | Needle Engine with SvelteKit (includes Needle Cloud deployment) |
| Svelte | Needle Engine with Svelte |
| Next.js | Needle Engine with Next.js / Vercel |
| React Three Fiber | Needle Engine with React Three Fiber |
Samples
| Sample | Description |
|---|---|
| 3D Over HTML | Overlay 3D content on top of regular HTML pages |
| Progressive Meshes | Automatic LOD generation and progressive mesh loading |
More Samples
Browse 100+ interactive samples at samples.needle.tools.
For Unity users, additional scene templates and sample scenes are available directly in the editor via Needle Engine > Explore Samples.
Create Needle CLI
You can scaffold a new project from the command line using create-needle:
npm create needle [directory] [options]| Option | Description |
|---|---|
--template, -t <key> | Template to use (e.g. vite, react, vue, svelte, sveltekit, nextjs) |
--list, -l | List available templates as JSON |
--force, -f | Overwrite existing directory |
--help, -h | Show help |
Examples:
npx create-needle my-app --template vite
npx create-needle my-app -t react
npx create-needle --list