xr/studio Documentation

Getting Started

Set up your account, create a workspace, and build your first story in xr/studio.

Core Concepts

Learn the key building blocks of xr/studio: workspaces, stories, scenes, Asset Manager, entities, and the inspector.

Editor Basics

Navigate the active scene, hierarchy, and inspector. Learn to move, rotate, scale entities and use undo, redo, autosave, and version history.

Scenes

Add and organise scenes in your story. Learn the different scene types and when to use each one.

Entities

Work with the hierarchy: entity types, parenting, selection, and inspector basics for everything inside a scene.

Image Tracking

Show content on a real image, such as a poster or a product box. Choose an image that tracks well, set its printed width, and start actions when the camera finds it.

Assets

Upload and manage files in the Asset Manager. Learn what formats are supported and how Studio processes your uploads.

Screen UI & GUI Entities

Build heads-up display panels, buttons, and labels that stay fixed on screen using GUI entities.

Actions

Build behaviours with event types, action types, conditions, entity actions, and scene actions.

Custom Code API

Script your story with the Custom Code action: the cyango namespace, its methods and types, reading GUI inputs, variables, navigation, and examples.

Custom Code Entity

Build an entity with your own code: the Three.js scope, params with inspector controls, loading assets, interfaces from markup, and screen space.

Publish & Share

Publish your story and share it as a link, embedded iframe, QR code, or installable PWA. Export for self-hosting.

AI agents & Cyango MCP

Install the cyango-mcp skill, connect MCP to xr/studio, and use AI agents safely with batched tools and official rules.