> For the complete documentation index, see [llms.txt](https://needle.gitbook.io/needle-engine/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://needle.gitbook.io/needle-engine/readme.md).

# README

<br>

<p align="center"><a href="https://docs.needle.tools/getting-started"><img src="https://engine.needle.tools/branding/needle-logo.png" alt="logo"></a></p>

<h3 align="center">Needle Engine</h3>

[![Version](https://img.shields.io/npm/v/@needle-tools/engine?style=flat\&colorA=999\&colorB=999)](https://www.npmjs.com/package/@needle-tools/engine) [![Downloads](https://img.shields.io/npm/dt/@needle-tools/engine.svg?style=flat\&colorA=999\&colorB=999)](https://www.npmjs.com/package/@needle-tools/engine) [![Discord Shield](https://img.shields.io/discord/717429793926283276?style=flat\&colorA=999\&colorB=999\&label=discord\&logo=discord\&logoColor=ffffff)](https://discord.needle.tools) [![Forum Shield](https://img.shields.io/badge/forum-forum.needle.tools-blue?style=flat\&colorA=999\&colorB=999)](https://forum.needle.tools)

[Getting Started](https://docs.needle.tools/getting-started/) — [Samples](https://engine.needle.tools/samples) — [Documentation](https://engine.needle.tools/docs)

🚀 **Deploy Instantly to the Web** — Build on your machine, deploy to Needle Cloud or anywhere. Share your 3D experiences with a simple URL or QR code. No app stores, no waiting for approval, no installation required.

🌐 **True Cross-Platform** — One codebase runs everywhere – desktop, mobile, VR headsets (Meta Quest, Apple Vision Pro), and mobile AR including native iOS WebXR support. When new XR devices launch, your apps work automatically.

🎨 **Work in Unity, Blender, or Pure Code** — Full-featured integrations for both Unity and Blender — modeling, materials, animations, lightmaps, and more. Or skip the editors entirely and build from code with three.js.

🎯 **Built-in Rapier Physics** — Full physics simulation with rigidbodies, colliders, raycasting, and character controllers – powered by Rapier, ready to use with zero setup.

🤝 **Multiplayer & XR** — Built-In Collaboration and XR aren't afterthoughts – they're core features. Add multiplayer, voice chat, or immersive XR with a single component.

⚡️ **Optimized for Performance** — Powerful compression and optimization pipeline ensures your files are small and load fast. Built on the glTF standard for maximum compatibility.

<br>

[Getting Started](https://docs.needle.tools/getting-started/) — [Samples](https://engine.needle.tools/samples) — [Documentation](https://engine.needle.tools/docs)