Getting Started with CloudXR.js#

Note

Complete setup guides, tutorials, and code samples are provided as part of the CloudXR.js Early Access Program artifacts on NGC. Refer to the CloudXR.js User Guide to join the program.

This guide provides a high-level workflow of building CloudXR.js streaming applications.

High-Level Workflow#

Building a CloudXR.js application involves three main steps:

  1. Set up the Server: Install CloudXR Runtime with an OpenXR-compatible server application

  2. Build the Client: Create a web client using CloudXR.js

  3. Connect and Stream: Access your web app from a VR/AR headset or desktop browser

Before proceeding, review the CloudXR.js Requirements for server, client, and network requirements.

Server Setup#

You need CloudXR Runtime with an OpenXR compatible server application. Refer to Getting Started with CloudXR Runtime for detailed server setup instructions.

CloudXR Runtime supports various OpenXR applications including:

  • Isaac Lab - Robot learning and teleoperation workflows

  • LÖVR: Lightweight VR framework

  • Custom OpenXR Applications: Any OpenXR-compliant application

Important

Ensure CloudXR Runtime is configured with device profile set to auto-webrtc for web clients.

Client Setup#

In the early access program, CloudXR.js is distributed as an npm package tarball. Enter this command to install it:

npm install </path/to/cloudxr-js-npm-package-tarball>

We provide example projects to help you get started:

  • Simple WebGL Example: Minimal implementation using vanilla WebGL

  • React Three Fiber Example: Advanced example using React and Three.js

See Example Applications for available examples and Client Setup Guide for device configuration.

Connection Modes#

CloudXR.js supports two connection modes:

HTTP Mode (Development)

  • Simplest setup - no proxy required

  • Direct WebSocket connection to CloudXR Runtime

  • Requires browser flags on Meta Quest 3

  • Not supported on Pico 4 Ultra

HTTPS Mode (Production)

  • Works on all supported devices including Pico 4 Ultra

  • Requires WebSocket SSL proxy setup

  • Production-ready with TLS communication

See WebSocket Proxy Setup for WebSocket proxy setup and Network Setup for network configuration.

Next Steps#

For detailed setup instructions, tutorials, and troubleshooting guides, refer to the documentation included in the Early Access Program artifacts on NGC.

On this page