---
title: Reference
description: Complete API and configuration reference for Needle Engine
---

# Reference

Precise, factual information for looking things up. API documentation, component catalog, configuration options, and changelogs.

---

## Core APIs

- [**Needle Engine API**](https://engine.needle.tools/docs/api/latest) - Complete TypeScript API reference
- [**Built-in Components**](/docs/reference/components) - Catalog of 100+ components with descriptions
- [Component Lifecycle](./api/lifecycle-methods) - awake, start, update, onEnable, etc.
- [Input Events](./api/input-events) - Mouse, touch, keyboard handling
- [Physics Events](./api/physics-events) - Collisions and triggers
- [XR Events](./api/xr-events) - WebXR-specific events
- [Time API](./api/time) - Time and deltaTime
- [Scripting Examples](./scripting-examples) - Common code patterns
- [three.js Documentation](https://threejs.org/docs/) - Official three.js API reference

---

## Configuration

- [<needle-engine> Web Component](/docs/reference/needle-engine-attributes) - HTML attributes and options
- [needle.config.json](/docs/reference/needle-config-json) - Project configuration options
- [Vite Plugin Configuration](/docs/reference/needle-vite-plugin) - makeFilesLocal, PWA, build pipeline, and more
- [TypeScript Decorators](/docs/reference/typescript-decorators) - @serializable, @syncField, and metadata

---

## Templates & Samples

- [**Project Templates & Samples**](/docs/reference/templates) - Official starter templates and framework samples on GitHub

---

## Tools & Integrations

- [Unity Integration](/docs/unity/) - Unity editor integration
- [Blender Integration](/docs/blender/) - Blender add-on integration
- [Needle Cloud](/docs/cloud/) - Official hosting platform and license server
- [Needle Inspector](/docs/three/needle-devtools-for-threejs-chrome-extension) - Chrome DevTools extension for three.js scenes
- [Needle MCP Server](/docs/ai/needle-mcp-server) - AI integration for Claude Desktop, Copilot, etc.
- [AI Resources](/docs/ai/) - AI assistants and documentation tools

---

## Comparisons

Compare Needle Engine with other 3D web platforms:

- [**Compare 24+ Platforms**](https://cloud.needle.tools/compare) - Interactive comparison tool
- [vs three.js](https://cloud.needle.tools/compare/needle-vs-threejs) - Productivity features and optimization
- [vs Unity WebGL](https://cloud.needle.tools/compare/needle-vs-unity-webgl) - Performance and load times
- [vs 8th Wall](https://cloud.needle.tools/compare/needle-vs-8thwall) - WebAR capabilities
- [vs Spline](https://cloud.needle.tools/compare/needle-vs-spline) - Visual editing and deployment
- [vs Adobe Aero](https://cloud.needle.tools/compare/needle-vs-aero) - AR authoring

---

## Changelogs

Automatically generated from package release notes.

- [**Needle Engine**](/docs/reference/changelogs/needle-engine) 🌵 - Core runtime changelog
- [**gltf-progressive**](/docs/reference/changelogs/gltf-progressive) - Progressive loading changelog
- [**three-animation-pointer**](/docs/reference/changelogs/three-animation-pointer) - Animation pointer changelog
- [**Needle MaterialX**](/docs/reference/changelogs/materialx) - MaterialX changelog
- [**Component Compiler**](/docs/reference/changelogs/component-compiler) - Component Compiler changelog
- [**UnityGLTF**](/docs/reference/changelogs/unitygltf) - UnityGLTF changelog

---

## Help & Legal

- [FAQ](./faq) - Frequently asked questions and troubleshooting
- [Pricing](https://needle.tools/pricing) - License plans and pricing
- [EULA](https://needle.tools/eula) - End user license agreement

---

::: tip Looking for something else?
- [**Tutorials**](/docs/tutorials/) — Step-by-step lessons to learn Needle Engine by building projects
- [**How-To Guides**](/docs/how-to-guides/) — Practical solutions for specific tasks like networking, XR, and deployment
- [**Explanation**](/docs/explanation/) — Architecture, glTF pipeline, and design decisions
:::