How-To Guides

Practical guides for accomplishing specific tasks with Needle Engine.

Getting Started

• Install for Unity - Unity integration guide
• Install for Blender - Blender add-on guide
• Install for Web Projects - Vanilla JS and framework setup

Scripting & Components

Creating Custom Components

• Create Components - Write custom TypeScript components
• Use Lifecycle Hooks - awake, start, update, and more
• Use Coroutines - Time-based sequences and delays

Interaction

• Handle User Input - Mouse, touch, keyboard, VR controllers
• Perform Raycasting - Detect objects and hit points

Physics (Rapier)

• Use Physics - Rigidbodies, forces, collisions, triggers, character controllers — powered by Rapier

Accessibility

• Accessibility - Make 3D scenes accessible to screen readers and assistive technology

Built-in Components

• Camera Controls (OrbitControls) - Navigate 3D scenes
• Drag Objects (DragControls) - Drag with mouse, touch, or VR
• Scene Switcher - Load and switch glTF content
• UI Text - Spatial text with custom fonts
• Video Player - Play videos in 3D
• Scroll Follow - Scroll-based animations
• Duplicatable - Spawn object copies
• Contact Shadows - Realistic ground shadows
• Cursor Follow - Track mouse/touch position
• Drop Listener - Drag and drop files

XR (AR & VR)

• WebXR Overview - AR and VR development guide
• VR Performance Optimization - Profiling, bottlenecks, Quest tips
• iOS WebXR Support - Native iOS WebXR via App Clips
• Image Tracking - AR image tracking
• Everywhere Actions - Cross-platform interactions (iOS QuickLook)

Networking & Multiplayer

• Networking Overview - Multiplayer guide
• Set Up Networking - Quick start (5 minutes)
• Sync Component State - Automatic networking with @syncField
• Voice Chat (VoIP) - Built-in WebRTC voice chat with spatial audio
• Manual Networking - Custom messages
• Custom Servers - Self-hosted infrastructure

Export & Assets

• Export Overview - Export workflow and best practices
• MaterialX Support - Complex material networks

Web Integration

• Web Integration Overview - Frameworks and bundlers
• Progressive Web Apps (PWA) - Offline support, installability, auto-updates
• Responsive Design - Adaptive 3D layouts
• Embed in Websites - iframe, CDN, direct integration

Platform-Specific Integrations

• Framer - Framer websites
• WordPress - WordPress sites
• Adobe Experience Manager - AEM integration
• 8th Wall Migration - Transition guide for 8th Wall developers

Deployment & Optimization

Deployment

• Deployment Platforms - Netlify, Vercel, GitHub Pages, etc.
• Needle Cloud - Official Needle hosting

Optimization

• Optimization Guide - Texture/mesh compression, progressive loading, LODs
• gltf-progressive - Progressive loading for three.js projects

Debugging & Testing

• Needle Inspector - Chrome DevTools extension
• Needle MCP Server - AI-powered debugging and search
• Debugging Options - URL parameters, VSCode debugging
• Testing Guide - Test on devices, VR headsets, certificates
• Detect Mobile Devices - Platform detection