docs
Getting Started
Tutorials
How-To Guides
Explanation
Reference
Help
Getting Started
Tutorials
How-To Guides
Explanation
Reference
Help

Reference

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


Core APIs

  • 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

Configuration

  • <needle-engine> Web Component - HTML attributes and options
  • needle.config.json - Project configuration options
  • Vite Plugin Configuration - makeFilesLocal, PWA, build pipeline, and more
  • TypeScript Decorators - @serializable, @syncField, and metadata

Templates & Samples

  • Project Templates & Samples - Official starter templates and framework samples on GitHub

Tools & Integrations

  • Unity Integration - Unity editor integration
  • Blender Integration - Blender add-on integration
  • Needle Cloud - Official hosting platform and license server
  • Needle Inspector - Chrome DevTools extension for three.js scenes
  • Needle MCP Server - AI integration for Claude Desktop, Copilot, etc.
  • AI Resources - AI assistants and documentation tools

Comparisons

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

Changelogs

Automatically generated from package release notes.

  • Needle Engine 🌵 - Core runtime changelog
  • gltf-progressive - Progressive loading changelog
  • three-animation-pointer - Animation pointer changelog
  • Needle MaterialX - MaterialX changelog
  • Component Compiler - Component Compiler changelog
  • UnityGLTF - UnityGLTF changelog

Help & Legal

  • FAQ - Frequently asked questions and troubleshooting
  • Pricing - License plans and pricing
  • EULA - End user license agreement

Looking for something else?

  • Tutorials — Step-by-step lessons to learn Needle Engine by building projects
  • How-To Guides — Practical solutions for specific tasks like networking, XR, and deployment
  • Explanation — Architecture, glTF pipeline, and design decisions
Suggest changes
Last Updated: 4/21/26, 8:41 PM

Extras

Needle AI Ask Needle AI
Copy Markdown

Navigation

  • Getting Started
  • Tutorials
  • How-To Guides
  • Explanation
  • Reference
  • Help

Extras

Needle AI Ask Needle AI
Copy Markdown