<SYSTEM>This is the developer documentation for Needle.</SYSTEM>

# Needle

## Overview 

Needle Engine is a web engine for complex and simple 3D applications alike. Work on your machine and deploy anywhere. Needle Engine is flexible, extensible and has built-in support for collaboration and XR. It is built around the glTF standard for 3D assets.

Powerful integrations for Unity and Blender allow artists and developers to collaborate and manage web applications inside battle-tested 3d editors. These Integrations allow you to use editor features for creating models, authoring materials, animating and sequencing animations, baking lightmaps and more with ease.

Our powerful compression and optimization pipeline for the web makes sure your files are ready, small and load fast.

## Docs

- [Needle Website](https://needle.tools): Get an overview of Needle, learn about the company and products
- [Needle Engine Samples](https://engine.needle.tools/samples): See a variety of samples for Needle Engines that serve as starting points and reference for your own projects
- [Needle Engine API](https://engine.needle.tools/docs/api/latest): The Needle Engine API with detailed documentation for all classes and functions that the engine offers
- [Needle Engine Documentation](https://engine.needle.tools/docs): Learn how to use Needle Engine or the integrations for Unity or Blender
- [Needle Engine Releases](https://github.com/needle-tools/needle-engine-support/releases): Follow along the latest Needle Engine updates
- [Needle Engine: Getting started](https://engine.needle.tools/docs/getting-started/)
- [Needle Engine: Getting started with Unity](https://engine.needle.tools/docs/unity/)
- [Needle Engine: Getting started with Blender](https://engine.needle.tools/docs/blender/)
- [Needle Engine: Getting started without an editor](https://engine.needle.tools/docs/three/)
- [Needle Cloud Documentation](https://engine.needle.tools/docs/cloud/)
- [Needle Engine: Vision](https://engine.needle.tools/docs/vision.html)
- [Needle Engine: Feature Overview](https://engine.needle.tools/docs/features-overview.html)
- [Needle Engine: Technical Overview](https://engine.needle.tools/docs/technical-overview.html)
- [Needle Engine: Everywhere Actions](https://engine.needle.tools/docs/everywhere-actions.html)
- [Needle Engine: Deployment and Optimization](https://engine.needle.tools/docs/deployment.html)
- [Needle Engine: Networking](https://engine.needle.tools/docs/networking.html)
- [Needle Engine: WebXR: VR and AR](https://engine.needle.tools/docs/xr.html)
- [Needle Engine: `<needle-engine>` attributes](https://engine.needle.tools/docs/reference/needle-engine-attributes.html)
- [Needle Engine: `needle.config.json`](https://engine.needle.tools/docs/reference/needle-config-json.html)
- [Needle Engine: Scripting Examples](https://engine.needle.tools/docs/scripting-examples.html)
- [Needle Engine: Stub Component Compiler](https://engine.needle.tools/docs/component-compiler.html)
- [Needle Engine: Creating custom components](https://engine.needle.tools/docs/scripting.html)
- [Needle Engine: FAQ](https://engine.needle.tools/docs/faq.html)

## Typescript Examples

```ts
import { Behaviour } from "@needle-tools/engine";

export class MyComponent extends Behaviour { 

    start() {
        console.log("Hello World");
    }

    update() {
        console.log("Frame #" + this.context.time.frame);
    }

    onPointerClick() {
        console.log("CLICKED");
    }

}
```


## Optional

- [Community Support Forum](https://forum.needle.tools)
- [Developer Discord](https://discord.needle.tools)
- [Needle Customer Email](hi@needle.tools)