llms.txt
Compare with other sites' llms.txt files →# Aircada System Documentation
Welcome to the Aircada documentation index for LLMs and AI agents.
## Sections
- [Core Values](https://aircada.com/about/core-values) - The guiding design, performance, and engineering principles directing the development of the Aircada 3D product customization docs.
- [About](https://aircada.com/about) - About Aircada.
- [Company Timeline](https://aircada.com/about/timeline) - Chronological roadmap of Aircada's growth, from early headset AR to prompt-driven Web 3D configurators.
- [Capabilities](https://aircada.com/capabilities) - Aircada platform capabilities and custom features.
- [Documentation](https://aircada.com/docs) - The Aircada Platform Documentation & Architecture Guides.
- [Aircada Dev-Planner System](https://aircada.com/docs/planner) - The architectural planning, specification, and authoring framework for building production 3D configurators and spatial web applications in Aircada.
- [Integrations](https://aircada.com/integrations) - External platform, e-commerce, CMS, and workflow integrations for Aircada.
- [Learn](https://aircada.com/learn) -
- [Our Story](https://aircada.com/about/story) - The origins of Aircada, starting from industrial AR with HoloLens 2, Wylie's 10x caching algorithm, Chile's Gemini Telescope pilot, pivoting to web-native Three.js, and scaling e-commerce configurators with MountainFlow.
- [An overview of the lean team behind Aircada.](https://aircada.com/about/team) - Meet the executive team driving Aircada's vision, strategy, and execution.
- [Personalization](https://aircada.com/capabilities/personalization) - Methods and features for personalizing products.
- [APEX Protocol Architecture & Philosophy](https://aircada.com/docs/apex/architecture) - The architectural foundations of the APEX protocol, prioritizing flat domains, closed-loop state inspection, and atomic execution guarantees.
- [APEX Protocol](https://aircada.com/docs/apex) - The Agent Protocol for Engine Execution (APEX) is Aircada's strictly-typed, flat-domain communication protocol linking LLMs directly to live 3D contexts.
- [CLI Command Catalog](https://aircada.com/docs/cli/commands) - Complete command-line execution catalog for managing workspaces, local dev servers, cloud deployments, and authentication handshakes.
- [Aircada CLI](https://aircada.com/docs/cli) - The Aircada Command Line Interface guides, scripting extensions, and agent integrations.
- [Multi-Project Sharing & Path Aliases](https://aircada.com/docs/cli/multi-project-sharing) - Learn how to share TypeScript scripts, 3D math transformations, schemas, and React UI components across multiple Aircada projects using path aliasing and multi-root dev watchers.
- [CLI Security & Credentials Manager](https://aircada.com/docs/cli/security) - Security architecture of Aircada CLI, protecting session keys using localized AES-256-CBC platform-bound encryption.
- [CLI Project Anatomy & Config](https://aircada.com/docs/cli/workspace) - Understanding the local Aircada project workspace structure and air.config.json orchestration parameters.
- [Blueprint Examples Suite](https://aircada.com/docs/examples) - Curated suite of executable Aircada 3D configurator blueprints, React UI customization kits, unified storage patterns, and e-commerce purchaser operators.
- [Data & Option Models Blueprints](https://aircada.com/docs/examples/data) - Blueprints for synchronized datasets, option selection sets, material finishes, and pricing tiers.
- [Ecommerce & Purchaser Blueprints](https://aircada.com/docs/examples/ecommerce) - Blueprints for Purchaser operator bindings, pricing formulas, cart bundling, and checkout integration.
- [Getting Started Blueprints](https://aircada.com/docs/examples/getting-started) - Bare starter templates and initialization blueprints for Aircada projects.
- [Storage Subsystem Blueprints](https://aircada.com/docs/examples/storage) - Blueprints for offline IndexedDB caching and remote cloud store state persistence.
- [UI Customization Kit Blueprints](https://aircada.com/docs/examples/ui) - Blueprints for React UI input controls, layout templates, floating HUD overlays, and CSS theme templates.
- [Model Context Protocol (MCP)](https://aircada.com/docs/mcp) - Standardized bridging between LLM agents and active Aircada environments via Model Context Protocol servers.
- [IDE MCP Server Setup](https://aircada.com/docs/mcp/setup) - Step-by-step instructions on configuring the Aircada MCP server in your IDE or AI agent desktop client.
- [Spatial UI Aesthetics, Palettes & Typography](https://aircada.com/docs/planner/aesthetics) - Formulating curated luxury dark themes, typography hierarchy, contrast ratios, and Euclidean color distance swatch filtering.
- [Architectural Mental Models for 3D Spatial Applications](https://aircada.com/docs/planner/architectural-mental-models) - Foundational mental models for state orchestration, the Unidirectional 3D Triad, declarative-imperative separation, and subsystem boundaries.
- [Multimodal Asset Ingestion, Brand Tokens & 3D Mockups](https://aircada.com/docs/planner/assets-inspiration) - Autonomous browser scraping, computed CSS brand extraction, visual reference galleries, and synthesized 16:9 3D layout mockups.
- [Blueprint Lifecycle, Testing Standards & Reverse-Syncing](https://aircada.com/docs/planner/blueprint-lifecycle-and-testing) - Multi-blueprint workspace decomposition, singular test harness manifests (.airbpt), dev log telemetry assertions, and air bp sync reverse-syncing.
- [3D Camera Choreography & Viewport Staging](https://aircada.com/docs/planner/camera-and-view-modes) - Principles for staging orbital camera perspectives, FOV parameters, target focus anchors, and smooth phase transitions between customization steps.
- [Tabular Option Matrices & Datasets (.airpds)](https://aircada.com/docs/planner/datasets-pricing) - Architecting tabular option matrices, relational dataset IDs, column data types, and multi-component choice catalogs.
- [Custom Event Bus Signals & Telemetry Triggers](https://aircada.com/docs/planner/event-catalog) - Decoupled event-driven messaging, naming conventions for domain events, payload schemas, and telemetry instrumentation.
- [Sequential User Journey Steps & UI Panels](https://aircada.com/docs/planner/interface-flow) - Divide complex 3D product customization into intuitive sequential phases, mapping spatial UI controls to interactive 3D scene targets.
- [Commercial Pricing Formulas & Multi-Variant Rules (.airpm)](https://aircada.com/docs/planner/pricing-option-models) - Configuring base pricing, surcharge offsets, conditional option exclusivity rules, and stripped .airpm format compliance.
- [Canonical Project Setup & Workspace Scaffolding](https://aircada.com/docs/planner/project-setup-and-scaffolding) - Standardized directory anatomy, relational data porting (.airpds & .airpm), local SDK symlinking, and dual-pass compilation.
- [Reactive Store Blueprint & 3D Scene Synchronization](https://aircada.com/docs/planner/reactive-store) - Designing unified reactive store properties (store.properties), state categories, and bidirectional synchronization with 3D shaders and meshes.
- [3D Scene Composition & Mesh Slot Abstractions](https://aircada.com/docs/planner/scene-mesh-slot-abstractions) - Standardized mesh slot naming conventions (slot_*_mesh), runtime material swap pipelines, and decoupled 3D asset hierarchy bindings.
- [SDK Code Architecture: @System, @Operator & Blueprint Foundations](https://aircada.com/docs/planner/sdk-code-architecture) - Architectural decision matrix for @System singleton managers, @Operator scene mutators, React UI components, and contextual blueprint foundations.
- [Spatial UI Layout Archetypes & Responsive Docking](https://aircada.com/docs/planner/spatial-layouts) - Architecting glassmorphic UI overlay containers, safe viewport boundaries, and responsive desktop-to-mobile docking adaptations.
- [Aircada SDK](https://aircada.com/docs/sdk) - A unified framework for building rich, interactive 3D configurators, featuring global Twin-Proxy store synchronization, custom Event Bus signals, and strongly typed Operator scripting.
- [Aircada Studio](https://aircada.com/docs/studio) - The Aircada Studio.
- [Shopify](https://aircada.com/integrations/shopify) - Complete integration suite for connecting Aircada 3D configurators with Shopify stores.
- [Shopify Theme App Block Setup Guide](https://aircada.com/integrations/shopify/theme-app-embed-setup) - Video walkthrough and step-by-step guide for embedding the Aircada Product Configurator onto your Shopify storefront using Theme App Blocks.
- [Concepts](https://aircada.com/learn/concepts) -
- [Engraving](https://aircada.com/capabilities/personalization/engraving) - Engraving and text emboss dynamic personalization capability.
- [Image Upload](https://aircada.com/capabilities/personalization/image-upload) - Image upload and dynamic decal projection personalization capability.
- [APEX Entity Actions & Payloads Reference](https://aircada.com/docs/apex/entities) - Detailed API payload contracts and interfaces for mutating Scene Objects, Effects, Operators, Datasets, and Options.
- [APEX Engine Inspection & Live State Loops](https://aircada.com/docs/apex/inspection) - Sensing the live environment using ApexInspectionRequest and ApexInspectionResponse to drive the closed-loop See -> Think -> Act pattern.
- [APEX Type System & Action Schema](https://aircada.com/docs/apex/schema) - Complete type specifications for APEX operations, target domains, and the BaseApexAction contract.
- [APEX Atomic Transactions & Temporary ID Mapping](https://aircada.com/docs/apex/transactions) - How batch APEX actions are dispatched atomically, mapped via client-side temporary IDs, and recorded with intent telemetry.
- [APEX Transaction Usage](https://aircada.com/docs/apex/usage) - Production-ready JSON transaction usages demonstrating dataset management, row operations, option models, and selection groups.
- [APEX Agent Workflows](https://aircada.com/docs/apex/workflows) - Comprehensive workflows guiding agents on how to leverage APEX domains and transactions in common 3D scene configuration scenarios.
- [Dataset File Format (.airpds) & Local Authoring](https://aircada.com/docs/cli/datasets/file-format) - Specification for authoring .airpds dataset JSON files in local project workspaces for automatic CLI synchronization.
- [Dataset File Formats & Sync](https://aircada.com/docs/cli/datasets) - Specifications and local file rules for authoring .airpds dataset JSON files.
- [Option & Pricing Model Formats](https://aircada.com/docs/cli/option-models) - Specifications and local file rules for authoring .airpm stripped manifest files.
- [Option & Pricing Model Manifest Format (.airpm)](https://aircada.com/docs/cli/option-models/file-format) - Specification for authoring stripped .airpm option and pricing model files for local CLI synchronization.
- [Synchronization Architecture](https://aircada.com/docs/cli/sync) - CLI DevServer synchronization architecture and live file workflows.
- [CLI Local File Synchronization Workflow](https://aircada.com/docs/cli/sync/workflow) - Explains how CLI DevServer synchronizes local .airpds and .airpm files with Aircada Studio and Engine in real time.
- [MCP Knowledge Retrieval Tools](https://aircada.com/docs/mcp/knowledge-retrieval) - Overview of Aircada's Model Context Protocol (MCP) tools for dynamic documentation querying and exact node retrieval.
- [Philosophy](https://aircada.com/docs/sdk/architecture) - The core design principles, architectural background, and synchronized workflow of the Aircada SDK and Studio.
- [Datasets](https://aircada.com/docs/sdk/datasets) - Declarative data integration system mapping Cloud spreadsheets and tables directly into Engine Operator properties.
- [Effects](https://aircada.com/docs/sdk/effects) - Programmatic API to retrieve, configure, and animate dynamic visual and interactive effects on 3D objects using type-safe facades.
- [The Effects Facade API](https://aircada.com/docs/sdk/effects/proxy-api) - Detailed overview of the .effects collection object (EffectsCollectionFacade) and the underlying EffectFacade class that powers dynamic property reading and writing through JavaScript Proxies.
- [SDK Integration & Usage Pattern](https://aircada.com/docs/sdk/effects/usage) - Describes the core pattern for using visual effects in the Aircada SDK inside Operator classes, and how to reference effect IDs and built-in effect types safely.
- [Events](https://aircada.com/docs/sdk/events) - Decoupled message bus facilitating strongly typed, event-driven communication across the React UI, 3D Engine Operators, and headless Systems.
- [FlowStates](https://aircada.com/docs/sdk/flowstates) - Declarative animation system handling smooth, engine-driven transitions between public property values without manual tweening math.
- [Code-Generation Rules](https://aircada.com/docs/sdk/frontend/codegen-rules) - Checklist of constraints and patterns that code-generation agents must follow when creating frontend code.
- [Frontend Development](https://aircada.com/docs/sdk/frontend) - Root directory for frontend-implementation architectures, design systems, and framework integrations.
- [Vanilla Javascript Integration (Placeholder)](https://aircada.com/docs/sdk/frontend/vanilla) - Placeholder stub for building customizer frontends without structural JS frameworks.
- [Viewport DOM and Event Contract](https://aircada.com/docs/sdk/frontend/viewport-dom-contract) - Essential DOM layout and pointer event configurations required to prevent blocking 3D scene camera controls.
- [Vue.js Integration (Placeholder)](https://aircada.com/docs/sdk/frontend/vue) - Placeholder stub for building customizer frontends using the Vue framework.
- [SDK Guides](https://aircada.com/docs/sdk/guides) - A collection of best practices, architectural patterns, and step-by-step guidance scripts for the Aircada SDK.
- [Core Philosophy](https://aircada.com/docs/sdk/operators/behavior) - Operators serve as the 'brain' of a scene, bridging declarative property state with direct, imperative control of 3D objects.
- [Code Implementation Template (The Gold Standard)](https://aircada.com/docs/sdk/operators/boilerplate) - This is the flawless structural template for a modern Aircada Operator. Note the complete absence of 3D mesh code.
- [Anatomy of an Operator](https://aircada.com/docs/sdk/operators/definition) - Every Operator is a TypeScript class decorated with metadata. The @Operator decorator configures its identity within the visual docs.studio and the engine's query system.
- [Operators](https://aircada.com/docs/sdk/operators) - Modular logic centers in Aircada responsible for managing state, processing event bus signals, and directly manipulating 3D SceneObjects.
- [Runtime Instantiation](https://aircada.com/docs/sdk/operators/runtime-instantiation) - How to programmatically instantiate built-in or custom Operators at runtime using the Aircada Context API.
- [Setup Lifecycle and Async Coordination](https://aircada.com/docs/sdk/operators/setup-lifecycle) - How Aircada schedules, sequences, and resolves asynchronous setup actions in Operator components.
- [Built-in vs. Custom Operators](https://aircada.com/docs/sdk/operators/types) - Understand the distinction between built-in operators created via Aircada Studio and custom operators developed using the SDK.
- [Options](https://aircada.com/docs/sdk/options) - Architectural system synchronizing Cloud Datasets, React UI selection hooks, and 3D Engine Operators via the Twin-Proxy Vault.
- [Properties](https://aircada.com/docs/sdk/properties) - SDK decorators defining and exposing Operator instance fields to the Aircada synchronization engine and Visual Studio panels.
- [React Components](https://aircada.com/docs/sdk/react-components) - Systematic index and detailed documentation for the React components provided by @aircada/react for e-commerce 3D product configurations.
- [3D Scene](https://aircada.com/docs/sdk/scene) - Overview of the 3D scene architecture, bridging visual configurations from the Aircada Studio to strongly-typed SDK Operator references.
- [Scene Objects Reference](https://aircada.com/docs/sdk/scene-objects) - Comprehensive programmatic reference for all 3D scene objects and spatial facades in Aircada (e.g. Shapes, Text, Models).
- [Store](https://aircada.com/docs/sdk/store) - Central state management system utilizing the Twin-Proxy Vault for safe, high-performance synchronization between React UI and 3D simulation.
- [Systems](https://aircada.com/docs/sdk/systems) - Headless, singleton manager classes in the Aircada SDK decorated with @System to coordinate global state orchestration and background tasks.
- [Assets Panel](https://aircada.com/docs/studio/assets) - The central hub for managing media, 3D models, and other project files.
- [3D Asset Importing](https://aircada.com/docs/studio/importing) - Pipelines for importing and optimizing external 3D models and assets into the Aircada Studio.
- [Project Publishing & Deployment](https://aircada.com/docs/studio/publishing) - Deployment tools, hosting options, and project visibility controls in the Aircada Studio.
- [Scene Composition](https://aircada.com/docs/studio/scene) - The visual 3D scene builder and layout system within the Aircada Studio.
- [View Modes](https://aircada.com/docs/studio/viewmodes) - Switch between XR and UI workspace environments to focus on spatial elements or interface design.
- [Why variants don't scale](https://aircada.com/learn/concepts/why-variants-dont-scale) - An in-depth look at why flat database SKU models fail for custom configurators, and how graph systems scale.
- [CLI Development Server](https://aircada.com/docs/cli/development-server) - Overview of Aircada's real-time hot-swapping development server and its WebSocket hot-reload pipeline.
- [Brush Effects](https://aircada.com/docs/sdk/effects/brush) - A suite of built-in brush effects used to customize and animate the materials, strokes, and rendering behavior of interactive 3D paint brushes.
- [Camera Control Effects](https://aircada.com/docs/sdk/effects/camera-control) - A suite of built-in camera control effects that manage collision detection, view clamping, automated framing, and player height adjustments.
- [Environment Effects](https://aircada.com/docs/sdk/effects/environment) - A suite of built-in environmental effects that customize skyboxes, global illumination, atmospheric fog, and ambient backgrounds.
- [Geometry Effects](https://aircada.com/docs/sdk/effects/geometry) - A suite of built-in geometry effects that manipulate, deform, align, and constrain the physical vertices of 3D meshes and models in real-time.
- [Material Effects](https://aircada.com/docs/sdk/effects/material) - A suite of built-in material effects used to apply texture coordinates, engravings, reflections, and advanced shaders to 3D models and shapes in Aircada.
- [Particle Effects](https://aircada.com/docs/sdk/effects/particle) - A suite of built-in particle effects used to dynamically filter, mask, color, and distort particle emissions in Aircada.
- [Post-Processing Effects](https://aircada.com/docs/sdk/effects/postprocessing) - A suite of built-in post-processing effects applied to the entire scene camera view for cinema-style rendering, color adjustments, and screen-space overlays.
- [Configurator Architecture](https://aircada.com/docs/sdk/frontend/architecture) - Overview of framework-agnostic design and organization patterns for interactive configurators.
- [Configurator Primitives](https://aircada.com/docs/sdk/frontend/design-system/configurator-primitives) - Specifications for recurring UI components used across interactive configurators.
- [Design System](https://aircada.com/docs/sdk/frontend/design-system) - Framework-agnostic design system guide covering tokens, recurring configurator primitives, and responsive pattern