> For the complete documentation index, see [llms.txt](https://docs.multiset.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.multiset.ai/webxr-sdk/webxr-sdk.md).

# Overview

The Multiset VPS WebXR SDK (`@multisetai/vps`) adds Visual Positioning System localization and object tracking to web-based AR applications. It captures camera frames from an active WebXR session, sends them to the Multiset cloud, and returns a precise 6-DOF pose that you can use to anchor virtual content to the real world.

{% hint style="warning" %}
WebXR immersive-ar is supported on **Android** (Chrome 81+, ARCore). Safari on iOS does not implement the `camera-access` feature required for VPS.
{% endhint %}

### Features

* 6-DOF VPS localization against single Maps and MapSets
* Object tracking for registered 3D objects
* Adapters for Three.js and Needle Engine
* Zero-dependency core for custom renderers
* Built-in AR button, mesh visualization, and confidence filtering

### Entry Points

The package ships four independent entry points. Install only what you need.

| Entry point              | Peer dependency                 | What you get                                    |
| ------------------------ | ------------------------------- | ----------------------------------------------- |
| `@multisetai/vps/core`   | None                            | `MultisetClient`, `XRSessionManager`, all types |
| `@multisetai/vps/three`  | `three >= 0.169.0`              | `ThreeAdapter`                                  |
| `@multisetai/vps/needle` | `@needle-tools/engine >= 5.1.2` | `NeedleAdapter`, `MapAnchor`, `MultisetVPS`     |
| `@multisetai/vps`        | None                            | Core + Three.js (convenience re-export)         |

### Installation

**Three.js projects:**

```bash
npm install @multisetai/vps three
```

**Needle Engine projects:**

```bash
npm install @multisetai/vps
```

Needle Engine ships its own Three.js fork, so you do not install `three` separately.

### Requirements

* Node.js 18+
* HTTPS (WebXR requires a secure context)
* AR-capable Android device with ARCore

{% hint style="info" %}
Your domain must be whitelisted to avoid CORS errors. See [Configuring Allowed Domains](/basics/credentials/configuring-allowed-domains-cors.md).
{% endhint %}

### Next Steps

* [Authentication](/webxr-sdk/authentication.md) — get credentials and authorize the client
* [Three.js Integration](/webxr-sdk/threejs-integration.md) — full working example with Three.js
* [Needle Engine Integration](/webxr-sdk/needle-engine.md) — Inspector-driven and programmatic usage
* [Object Tracking](/webxr-sdk/object-tracking.md) — detect and pose registered 3D objects
* [Localization Options](/webxr-sdk/localization-options.md) — hints, confidence filtering, background localization
* [Core Usage](/webxr-sdk/core-usage.md) — use without Three.js (custom renderers)
* [API Reference](/webxr-sdk/api-reference.md) — full parameter and callback reference


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.multiset.ai/webxr-sdk/webxr-sdk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.