Complete API and configuration reference for Needle Engine
Technical documentation for APIs, components, configuration, and platform capabilities.
::: tip Looking for something else?
Learn the basics → Tutorials
Solve a specific problem → How-To Guides
Understand concepts → Explanation :::
Needle Engine API - Complete TypeScript API reference
Built-in Components - Catalog of 100+ components with descriptions
Component Lifecycle - awake, start, update, onEnable, etc.
Input Events - Mouse, touch, keyboard handling
Physics Events - Collisions and triggers
XR Events - WebXR-specific events
Time API - Time and deltaTime
Scripting Examples - Common code patterns
three.js Documentation - Official three.js API reference
Project Templates & Samples - Official starter templates and framework samples on GitHub
needle.config.json - Project configuration options
Vite Plugin Configuration - makeFilesLocal, PWA, build pipeline, and more
TypeScript Decorators - @serializable and metadata
<needle-engine> Web Component - HTML attributes and options
Unity Integration - Unity editor integration
Blender Integration - Blender add-on integration
Needle Cloud - Official hosting platform and license server
Needle MCP Server - AI integration for Claude Desktop, Copilot, etc.
Needle Inspector - Chrome DevTools extension
AI Resources - AI assistants and documentation tools
Compare Needle Engine with other 3D web platforms:
Compare 24+ Platforms - Interactive comparison tool
vs three.js - Productivity features and optimization
vs Unity WebGL - Performance and load times
vs 8th Wall - WebAR capabilities
vs Spline - Visual editing and deployment
vs Adobe Aero - AR authoring
Last updated