# AR Clip Documentation

> AR Clip is a platform for building augmented-reality and 3D experiences that run from a
> link in a browser, with no install. Scenes are built from entities and components; behaviour
> is written as editor events, visual patch graphs, or TypeScript.

## Start here if you are an AI assistant

- [Brief for assistants](https://docs.arclip.design/creators-engine/ai/brief-for-assistants): the mental model, naming rules, and the mistakes that
  produce confidently wrong answers about this platform. Read this before answering questions
  about AR Clip.
- [Connecting over MCP](https://docs.arclip.design/creators-engine/ai/mcp): drive a project directly, with an API
  token and scoped permissions.

## Creators Engine

How a scene behaves: entities and components, events, patches, scripts, physics, materials.

- [Creators Engine](https://docs.arclip.design/creators-engine/): Build interactive AR and 3D experiences on AR Clip — objects made of components, and two ways to give them behaviour.
- [Building with an AI assistant](https://docs.arclip.design/creators-engine/ai): Three ways an AI can help you build here — from a chat window, from your editor, or by driving the platform directly over MCP.
- [Brief for assistants](https://docs.arclip.design/creators-engine/ai/brief-for-assistants): A single page to hand to any AI model — the mental model, the naming rules and the mistakes that produce confidently wrong answers.
- [Connecting over MCP](https://docs.arclip.design/creators-engine/ai/mcp): Point Claude, Cursor or any MCP client at your project: the endpoint, tokens, scopes and what the tools can do.
- [The assistant's skills](https://docs.arclip.design/creators-engine/ai/skills): The guides the built-in assistant reads on demand — what each covers, and how to ask for one.
- [What agents are good for here](https://docs.arclip.design/creators-engine/ai/use-cases): Concrete jobs an AI assistant does well on this platform — from running a workshop on one shared canvas to building a game with you.
- [Animation](https://docs.arclip.design/creators-engine/authoring/animation): Four ways to move things, how to choose between them, easing, and the one rule that prevents most animation bugs.
- [Events](https://docs.arclip.design/creators-engine/authoring/events): When this happens, do that: the quickest way to make your scene interactive, with no code at all.
- [Game controls](https://docs.arclip.design/creators-engine/authoring/game-controls): Turn an object into a character your visitor can drive — movement, a follow camera, touch controls and what needs to be solid.
- [Particles](https://docs.arclip.design/creators-engine/authoring/particles): Fire, smoke, sparks, dust and rain: how the emitter works and which settings shape the look.
- [Patches](https://docs.arclip.design/creators-engine/authoring/patches): Logic you draw instead of type: nodes, wires, reusable graphs, and when to reach for one.
- [Paths](https://docs.arclip.design/creators-engine/authoring/paths): Draw a curve and use it two ways: as a shape swept along it, or as a route for something to follow.
- [Material graphs](https://docs.arclip.design/creators-engine/authoring/shader-graphs): Build a material as a node graph: what the nodes do, how the surface outputs work, and how to make a full-screen effect.
- [States](https://docs.arclip.design/creators-engine/authoring/states): Named snapshots of an object’s settings — the tidiest way to build a switch, a highlight or a door.
- [UI cards](https://docs.arclip.design/creators-engine/authoring/ui-cards): Buttons, menus, score displays: how the interface layer works and how it talks to your scene.
- [Cameras](https://docs.arclip.design/creators-engine/concepts/cameras): Control modes, field of view, and extra views like minimaps and security monitors.
- [Components](https://docs.arclip.design/creators-engine/concepts/components): What each component controls, the settings that are easy to misread, and the units that catch people out.
- [Lights](https://docs.arclip.design/creators-engine/concepts/lights): The five light types, how to aim them, a starting rig that works, and which settings can animate smoothly.
- [Loading and the launch screen](https://docs.arclip.design/creators-engine/concepts/loading): What is fetched before the scene opens and what arrives later, how to override it per asset, and how to replace the launch screen with your own.
- [Materials](https://docs.arclip.design/creators-engine/concepts/materials): Slots, the eight material types and their settings, texture maps and their options, and reusing materials across a project.
- [Objects and scenes](https://docs.arclip.design/creators-engine/concepts/objects-and-scenes): What an object really is, how parenting works, and how anchors decide which scene your visitor sees.
- [Physics](https://docs.arclip.design/creators-engine/concepts/physics): What makes something solid, which shapes the engine works out for you, and why a body sometimes will not move.
- [Prefabs and instancing](https://docs.arclip.design/creators-engine/concepts/prefabs-and-instancing): Two different kinds of copying: prefabs for reusing a design, instancing for drawing thousands of copies cheaply.
- [Resources](https://docs.arclip.design/creators-engine/concepts/resources): Models, images, sounds and scripts: how the project tree works and how objects point at files.
- [The shared packages](https://docs.arclip.design/creators-engine/concepts/shared-packages): What you can import (in a script, in a plugin, in a component extension) and what each package gives you.
- [Glossary and units](https://docs.arclip.design/creators-engine/glossary): What each term means here, and every unit of measurement in one table.
- [Component reference](https://docs.arclip.design/creators-engine/reference/components): Every component an object can carry, with all of its settings, types and defaults.
- [Material maps](https://docs.arclip.design/creators-engine/reference/material-maps): Which texture maps each material type accepts, and what each one is for.
- [Patch node reference](https://docs.arclip.design/creators-engine/reference/patch-nodes): Every node available in the patch editor, grouped by category, with its ports.
- [Shader node reference](https://docs.arclip.design/creators-engine/reference/shader-nodes): Every node available in the material graph editor, grouped by category.
- [Step reference](https://docs.arclip.design/creators-engine/reference/steps): Every action an event can perform, with its settings.
- [Trigger reference](https://docs.arclip.design/creators-engine/reference/triggers): Every trigger you can react to, with its branches and settings.
- [The ctx API](https://docs.arclip.design/creators-engine/scripting/ctx-reference): Everything on ctx: lifecycle, finding objects, input, camera, raycasting, physics, audio, storage and interface.
- [Your first script](https://docs.arclip.design/creators-engine/scripting/first-script): Write your first script in five minutes: the shape of one, settings you expose to the editor, and what the sandbox gives you.
- [Multiplayer](https://docs.arclip.design/creators-engine/scripting/multiplayer): Peers, channels, shared state, spawning for everyone, and how to draw someone else’s position smoothly.
- [Things you will actually build](https://docs.arclip.design/creators-engine/scripting/recipes): Complete, working scripts for the tasks that come up in nearly every project — copy one and change the numbers.
- [Where a script lives](https://docs.arclip.design/creators-engine/scripting/where-scripts-live): Object, scene, space or project — what each level survives, and which one your logic belongs in.
- [Troubleshooting](https://docs.arclip.design/creators-engine/troubleshooting): The questions that come up most often, and what is actually going on in each case.
- [Why this engine](https://docs.arclip.design/creators-engine/why-this-engine): What is actually different here: one model everywhere, graphs that compile to code, and work the runtime refuses to do until it has to.

## Studio

The editor: every panel, and how to build and publish a project.

- [Studio](https://docs.arclip.design/studio/): The AR Clip editor: build AR and 3D experiences in your browser, together with your team.
- [Your own components](https://docs.arclip.design/studio/component-extensions): The second kind of plugin: add your own component to objects, with a React interface drawn inside the editor.
- [Your first project](https://docs.arclip.design/studio/getting-started): Build and publish a small AR experience end to end, in about ten minutes.
- [Keyboard shortcuts](https://docs.arclip.design/studio/hotkeys): Every shortcut in Studio, grouped by what it acts on.
- [Figma and Sketchfab](https://docs.arclip.design/studio/integrations): Connect your Figma and Sketchfab accounts, bring designs into scenes, and pull in 3D models.
- [Interface tour](https://docs.arclip.design/studio/interface): Every panel, rail and button in Studio, and what each one is for.
- [Animation Controller](https://docs.arclip.design/studio/panels/animation-controller): The timeline editor: presets, bars, keyframes and easing, and how to play an animation.
- [Project assets](https://docs.arclip.design/studio/panels/assets): Your project’s own files: folders, creating scripts and patches, and dragging things into the scene.
- [AI assistant](https://docs.arclip.design/studio/panels/assistant): Describe what you want and have it built, then take over by hand.
- [Comments](https://docs.arclip.design/studio/panels/comments): Pin a note to a spot in the scene so feedback lands where the problem is.
- [Making things interactive](https://docs.arclip.design/studio/panels/events-editor): Building interactivity without code: choosing a trigger, adding steps, and picking what they affect.
- [What an object is made of](https://docs.arclip.design/studio/panels/inspector): The inspector: adding and removing components, and what each one contributes to an object.
- [Layers panel](https://docs.arclip.design/studio/panels/layers): The object tree of the current scene: selecting, renaming, re-parenting, hiding and locking.
- [Library](https://docs.arclip.design/studio/panels/library): Uploading your own files, and finding ready-made content from your team, the platform and Sketchfab.
- [Making things look right](https://docs.arclip.design/studio/panels/material-editor): Material slots, the editor fields, choosing and tuning textures, and the material library.
- [Patch Editor](https://docs.arclip.design/studio/panels/patch-editor): The node editor: adding nodes, wiring them up, port types, and saving a graph for reuse.
- [Scenes panel](https://docs.arclip.design/studio/panels/scenes): Where your spaces and scenes live: adding, reordering, and choosing what makes each scene appear.
- [UI Editor](https://docs.arclip.design/studio/panels/ui-editor): Design the 2D interface over your scene, and connect it to your objects and logic.
- [Writing a plugin](https://docs.arclip.design/studio/plugin-development): Build a Studio plugin: the folder layout, the manifest, the runtime globals, the editor API, and publishing.
- [Plugins](https://docs.arclip.design/studio/plugins): Extending Studio: finding and installing plugins, adding them to a project, and what trust and verification mean.
- [Project settings](https://docs.arclip.design/studio/settings/project-settings): Loading screen, analytics, languages, controls, capture and your custom domain.
- [Space settings](https://docs.arclip.design/studio/settings/space-settings): Background, grid, units, environment lighting, fog and camera — the settings every scene in a space shares.
- [Placing content in a real place (VPS)](https://docs.arclip.design/studio/vps-scenes): From scanning a location to a scene that appears in exactly the right spot — the whole path, end to end.

## VPS

Spatial mapping and visual positioning: SDKs, map building, localization.

- [Android SDK](https://docs.arclip.design/vps/Android Native SDK/introduction): Learn how to configure the AR Clip VPS Android native SDK, manage permissions, start localization, and troubleshoot production builds.
- [AR Clip SDK](https://docs.arclip.design/vps/AR Clip SDK/introduction): Build AR Clip experiences that stream WebGL content while using AR Clip VPS for localization, from package install to scene setup.
- [Supported Platforms](https://docs.arclip.design/vps/getting-started/compatibility): See which devices, SDKs, and hardware workflows AR Clip VPS supports together with mapping and localization recommendations.
- [Frequently Asked Questions](https://docs.arclip.design/vps/getting-started/faq): Review answers to common AR Clip VPS questions comparing features, limits, and advantages over other VPS platforms.
- [Introduction](https://docs.arclip.design/vps/getting-started/introduction): Understand how AR Clip VPS mapping and localization work, then follow the quick-start checklist to launch your first project.
- [Pricing](https://docs.arclip.design/vps/getting-started/pricing): Explore AR Clip VPS pricing plans, usage limits, and FAQs to choose the right tier for your spatial deployment.
- [iOS SDK](https://docs.arclip.design/vps/IOS Native SDK/introduction): Set up the AR Clip VPS iOS SDK with Swift Package Manager, permission prompts, service initialization, and localization callbacks.
- [CAD / BIM / Synthetic Assets](https://docs.arclip.design/vps/spatial-mapping/building-map/advanced/cad-bim): Convert CAD or BIM assets into AR Clip VPS maps with geometry preparation, anchor planning, and REST upload automation.
- [Photogrammetry (DSLR / Mirrorless)](https://docs.arclip.design/vps/spatial-mapping/building-map/advanced/custom-images): Turn photogrammetry photo sets into AR Clip VPS maps with capture tips, reconstruction steps, and REST upload examples.
- [Mobile Depth Supersets](https://docs.arclip.design/vps/spatial-mapping/building-map/advanced/depth-supersets): Merge multiple AR Clip sessions into dense indoor maps with the AR Clip depth superset workflow and REST merge jobs.
- [Terrestrial LiDAR Pipeline](https://docs.arclip.design/vps/spatial-mapping/building-map/advanced/lidar): Process terrestrial LiDAR scans into AR Clip VPS maps with cleaning, export, and REST upload best practices.
- [360° Panorama & Video Pipeline](https://docs.arclip.design/vps/spatial-mapping/building-map/advanced/panoramas-video): Convert 360° panoramas or stabilized walkthrough videos into AR Clip VPS maps using frame extraction and REST pipelines.
- [AR Clip Mapper](https://docs.arclip.design/vps/spatial-mapping/building-map/arclipmapper): AR Clip delivers instant WebAR playback without installs and includes the capture tool for AR Clip VPS maps.
- [Support](https://docs.arclip.design/vps/support): Find AR Clip VPS support channels on Discord or email and learn what project details to include for faster help.
- [Unity SDK](https://docs.arclip.design/vps/Unity SDK/introduction): Integrate the AR Clip VPS Unity SDK, install packages, wire localization services, and configure scenes for precise AR content.
- [Platform Support](https://docs.arclip.design/vps/Unity SDK/platforms): Overview of AR Clip Unity platform support outlining included mobile builds, enterprise headset add-ons, and access request steps.
- [Android & iOS](https://docs.arclip.design/vps/Unity SDK/platforms/android-ios): Deploy the AR Clip Unity SDK to ARKit and ARCore phones with setup checklists, enterprise add-ons, and testing recommendations.
- [Apple Vision Pro](https://docs.arclip.design/vps/Unity SDK/platforms/apple-vision-pro): Enterprise instructions for adapting the AR Clip Unity SDK to Apple Vision Pro with PolySpatial setup, provisioning, and localization diagnostics.
- [HoloLens 2](https://docs.arclip.design/vps/Unity SDK/platforms/hololens-2): Enterprise guide for bringing AR Clip VPS to HoloLens 2 with MRTK configuration, deployment scripts, and localization validation.
- [Magic Leap 2](https://docs.arclip.design/vps/Unity SDK/platforms/magic-leap-2): Enterprise build instructions for running AR Clip VPS on Magic Leap 2, including package feeds, prerequisites, and deployment best practices.
- [Pico](https://docs.arclip.design/vps/Unity SDK/platforms/pico): Enterprise instructions for optimizing AR Clip VPS on Pico headsets, covering OpenXR setup, kiosk tooling, and diagnostic workflows.
- [Rokid](https://docs.arclip.design/vps/Unity SDK/platforms/rokid): Enterprise playbook for deploying AR Clip VPS to Rokid optical headsets with package setup, feature toggles, and testing tasks.
- [WeChat Mini App](https://docs.arclip.design/vps/Unity SDK/platforms/wechat): Enterprise guide to packaging AR Clip Unity experiences for the WeChat Mini Program ecosystem with proxy configuration and validation steps.
- [XREAL](https://docs.arclip.design/vps/Unity SDK/platforms/xreal): Enterprise deployment guide for AR Clip VPS on XREAL glasses including Nebula integration, rendering profiles, and reliability checks.
- [Web SDK](https://docs.arclip.design/vps/Web SDK/introduction): Placeholder for the upcoming AR Clip Web SDK guide covering WebXR integration, localization APIs, and deployment recipes.
- [Welcome](https://docs.arclip.design/vps/welcome): Welcome to the AR Clip VPS documentation hub with quick links into getting started guides, SDKs, and platform support.

## Quick start

Account setup and first steps.

- [Quick Start](https://docs.arclip.design/docs/): Make your first AR experience in ten minutes, then pick a template and build something real.
- [What you can build here](https://docs.arclip.design/docs/what-you-can-build): AR is what the platform is known for. It is not the limit — anything 3D or interactive that should open from a link belongs here too.

## Optional

- [Everything in one file](https://docs.arclip.design/llms-full.txt)