AutoGineer
Generated banner for Omniverse Realtime Viewer
Generated logo for Omniverse Realtime Viewer

Omniverse Realtime Viewer

OpenAIOfficialCreated by NVIDIA OmniverseDistributed by OpenAI

  • Skill
  • Meta (authoring, orchestration, planning, memory)
  • Software development
  • Apache-2.0
  • Medium risk
Download ZIP

From the author

Use as the top-level router for Omniverse Realtime Viewer USD app requests and focused viewer reference documents.
— the description by NVIDIA Omniverse

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Omniverse Realtime Viewer skill acts as a central orchestrator for developing USD-based viewer applications. It provides a structured approach to selecting implementation recipes, enforcing architectural conventions, and managing dependencies. By utilizing a set of focused reference documents, it guides developers through the lifecycle of building, configuring, and validating viewer applications, ensuring consistent behavior across different delivery paths such as local workstations or streaming environments.

What it does

  • Routes development requests to specific implementation recipes based on the target delivery path.
  • Enforces architectural rules for USD rendering, stage management, and UI integration.
  • Provides guidance on camera selection, input handling, and viewport interaction.
  • Standardizes the integration of AOV switching and render product configuration.
  • Facilitates the capture of validation evidence for viewer readiness.
  • Maintains separation between user-provided USD files and application-specific session state.

When to use it

  • When initiating the development of a new USD viewer application within the Omniverse ecosystem.
  • When determining the appropriate delivery path for a viewer, such as local native or streaming.
  • When needing to implement consistent camera, selection, or UI behavior across viewer projects.
  • When integrating advanced rendering features like AOV switching into an existing viewer.

Advantages

  • Ensures architectural consistency across diverse viewer implementations.
  • Provides a clear, modular path for adding specific capabilities like input routing or data display.
  • Promotes clean separation of concerns between stage data and viewer-owned state.
  • Standardizes the validation process for consistent delivery.

Usage examples

“I need to build a browser-based viewer for USD files.”
The agent will route you to the streaming viewer recipe, providing guidance on WebRTC stream setup, UI integration, and viewport interaction.
“How do I implement AOV switching in my local USD viewer?”
The agent will provide the AOV switching reference, detailing how to map render vars and update the display state on the server.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/openai/omniverse-realtime-viewer/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip omniverse-realtime-viewer.zip -d .agents/skills

Documentation by NVIDIA Omniverse

<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->

<!-- SPDX-License-Identifier: Apache-2.0 -->

Omniverse Realtime Viewer

This is the top-level entry point for the Omniverse Realtime Viewer skill package. It is self-contained: all required routing, conventions, and validation guidance live in the selected references.

Use the focused reference documents as implementation recipes. This file chooses the right recipes and preserves the architectural rules that must hold across all generated viewer apps.

Instructions

Start by classifying the requested viewer, then read only the references needed for that delivery path and feature set. Implement the render path first, layer interaction and UI behavior on top of it, and finish by capturing validation evidence from references/validation.md.

Read Order

  1. Read references/routing.md to choose the delivery path and focused references.

  2. Read references/conventions.md before implementing camera, input, selection, viewport, streaming protocol, scene loading, or environment behavior.

  3. For broad viewer requests, read references/usd-viewer-app/README.md.

  4. If the delivery path is unclear, read references/streaming-vs-local/README.md.

  5. If the prompt includes layout, panels, controls, inspectors, status, or UX, read references/viewer-ux-workflow/README.md and then the focused viewer UI references. This applies to React/WebRTC, Tauri, Electron, ovui, ovwidgets, and Dear ImGui apps; "frontend" means user-facing UI, not only browser UI.

  6. For viewport interaction, read references/viewer-input-routing/README.md before references/camera-controls/README.md, references/native-picking-selection/README.md, or references/object-selection/README.md.

  7. Read only the focused capability references needed for the requested app.

  8. Use references/validation.md to capture review evidence before handoff.

Non-Negotiables

  • Use ovrtx for all USD and 3D rendering.

  • Browser apps display an ovstream WebRTC video stream plus UI. The browser does not render USD geometry.

  • Do not substitute WebGL, Three.js, Babylon.js, PlayCanvas, A-Frame, model-viewer, react-three-fiber, glTF browser viewers, or other client-side 3D renderers.

  • If local validation cannot run because the GPU/runtime environment is absent, scaffold the ovrtx path and document the runtime requirement. Do not add a browser-renderer fallback.

  • Keep user USD files unmodified. Viewer cameras, render products, render vars, settings, selection metadata, and runtime state belong in session/composite layers or app state.

  • Keep one owner for renderer.step(), stage mutation, native picking, selection writes, and live attribute writes.

  • Keep dependency acquisition in references/dependencies/README.md and deployment choices in references/cloud-deployment/README.md; do not duplicate package locations or deployment setup.

Focused Reference Families

  • Entry points and recipes: references/usd-viewer-app/README.md, references/streaming-viewer-recipe/README.md, references/ovui-local-viewer-recipe/README.md, references/streaming-vs-local/README.md, references/electron-shm-viewer/README.md, references/ovwidgets-editor-shell/README.md.

  • Rendering and stage: references/ovrtx-rendering/README.md, references/stage-loading/README.md, references/stage-management/README.md, references/render-settings/README.md, references/aov-switching/README.md, references/stage-hierarchy/README.md, references/stage-queries/README.md, references/stage-attribute-reads/README.md, references/prim-transform-safety/README.md, references/usd-sample-data/README.md.

  • Delivery and runtime: references/streaming-server/README.md, references/streaming-client/README.md, references/streaming-messages/README.md, references/streaming-lifecycle/README.md, references/local-viewer/README.md, references/tauri-local-viewer/README.md, references/cpp-native-viewer/README.md, references/headless-shm-cli/README.md, references/viewer-backend-interface/README.md, references/webgl-shm-transport/README.md.

  • Viewer UI/UX: references/viewer-ux-workflow/README.md, references/viewer-layout-patterns/README.md, references/viewer-control-patterns/README.md, references/viewer-data-view-patterns/README.md, references/viewer-feedback-status/README.md.

  • Interaction: references/viewer-input-routing/README.md, references/camera-controls/README.md, references/object-selection/README.md, references/native-picking-selection/README.md, references/selection-feedback/README.md, references/selection-animation/README.md, references/transform-manipulator/README.md, references/gl-viewport-overlay/README.md, references/ovui-library/README.md, references/prim-pick-effects/README.md, references/prim-info-display/README.md, references/viewport-overlays/README.md.

  • Infrastructure: references/dependencies/README.md, references/windows-native-setup/README.md, references/cloud-assets/README.md, references/cloud-deployment/README.md, references/troubleshooting/README.md.

Build Workflow

  1. Classify the prompt by delivery path, target user, required capabilities, runtime environment, validation needs, and explicit constraints.

  2. Select a small reference set. Start with the recipe or routing reference, then add focused capabilities such as camera, picking, hierarchy, properties, render settings, transform tools, cloud assets, or deployment.

  3. Read selected references before writing app code. Follow their build order, import order, data-channel contracts, and renderer ownership rules.

  4. Implement the core render path first, then input routing and camera, then selection and data panels, then scene/settings features, then packaging or deployment.

  5. Treat the selected references as the behavior contract for API shape, compatibility, and generated project structure.

  6. Capture validation evidence before calling the viewer ready.

Examples

  • For a browser viewer request, use the streaming recipe references plus camera, picking, hierarchy, properties, render settings, and stream-status references.

  • For a local workstation viewer request, use the local or native delivery references plus renderer setup, stage loading, viewport input, and validation.

Completion Checklist

  • Selected references match the user's intent and delivery path.

  • No code path uses a browser-side 3D renderer for USD.

  • The generated app has one clear owner for render stepping and stage mutation.

  • User USD files remain untouched by viewer-owned session data.

  • Camera, input, selection, scene loading, and stream behavior follow references/conventions.md.

  • Setup/build/run results and visual interaction evidence are captured with references/validation.md.

Files

references/cloud-assets/README.md

Cloud Assets

Triggers

Use this skill for requests mentioning S3 assets, MinIO, cloud assets, buckets, remote USD files, ovstorage, asset caches, object storage, asset catalogs, thumbnail grids, or S3 browsing.

ovrtx requires local filesystem paths. Cloud stages must be synced to a local cache that preserves relative directory structure for textures, materials, sublayers, and referenced USD files.

Architecture

Browser -> ov_web_viewer_server
  -> StorageManager
  -> ovstorage S3 client
  -> S3/MinIO bucket samples_data/
  -> local cache /tmp/ov-stage-cache/samples_data/
  -> renderer.open_usd(local_path) or open_usd_from_string(inline root)

The manager connects to S3, syncs the full tree on first load, validates cache by size on later loads, and resolves requested filenames to local cached paths.

MinIO Setup

curl -sSL https://dl.min.io/server/minio/release/linux-amd64/minio -o /tmp/minio && chmod +x /tmp/minio
curl -sSL https://dl.min.io/client/mc/release/linux-amd64/mc -o /tmp/mc && chmod +x /tmp/mc
mkdir -p /tmp/minio-data
MINIO_ROOT_USER=minioadmin MINIO_ROOT_PASSWORD=minioadmin /tmp/minio server /tmp/minio-data --address :9000 --console-address :9001 &
/tmp/mc alias set local http://localhost:9000 minioadmin minioadmin
/tmp/mc mb local/ov-viewer-samples
/tmp/mc cp --recursive samples/samples_data/ local/ov-viewer-samples/samples_data/

Dependencies

pip install ovstorage
pip install "boto3>=1.34"  # optional for generated direct-S3 helpers

Use ovstorage for the primary authenticated object-storage path. Generate the viewer-local StorageManager wrapper in the app server.

Config

@dataclass(frozen=True)
class StorageConfig:
    enabled: bool = False
    bucket_url: str = "s3://ov-viewer-samples"
    endpoint_url: str = "http://localhost:9000"
    region: str = "us-east-1"
    addressing_style: str = "path"  # MinIO uses path; AWS often uses virtual
    cache_dir: str = "/tmp/ov-stage-cache"
    prefix: str = "samples_data"

    @classmethod
    def from_env(cls):
        return cls(
            enabled=os.environ.get("OVSTORAGE_ENABLED", "0") == "1",
            bucket_url=os.environ.get("OVSTORAGE_BUCKET_URL", "s3://ov-viewer-samples"),
            endpoint_url=os.environ.get("OVSTORAGE_ENDPOINT_URL", "http://localhost:9000"),
            region=os.environ.get("OVSTORAGE_REGION", "us-east-1"),
            addressing_style=os.environ.get("OVSTORAGE_ADDRESSING", "path"),
            cache_dir=os.environ.get("OVSTORAGE_CACHE_DIR", "/tmp/ov-stage-cache"),
            prefix=os.environ.get("OVSTORAGE_PREFIX", "samples_data"),
        )

Manager Behaviors

class StorageManager:
    def __init__(self, config):
        self.config = config
        self.enabled = config.enabled
        if self.enabled:
            import ovstorage
            self._client = ovstorage.open(config.bucket_url, config=ovstorage.Config(
                s3_endpoint_url=config.endpoint_url,
                s3_region=config.region,
                s3_addressing_style=config.addressing_style,
            ))

    def sync_all(self) -> bool:
        entries = self._client.walk(f"{self.config.prefix}/", max_depth=10)
        files = [e for e in entries if e.kind.value == "file"]
        for entry in files:
            data = self._client.read(entry.relative_path)
            dest = Path(self.config.cache_dir) / entry.relative_path
            if dest.exists() and dest.stat().st_size == len(data):
                continue
            dest.parent.mkdir(parents=True, exist_ok=True)
            dest.write_bytes(data)
        return True

    def resolve_or_passthrough(self, path: str) -> str:
        if not self.enabled:
            return path
        self.sync_all()
        return self.resolve_stage(os.path.basename(path))

Server Integration

  • Add sibling imports for storage_config and storage_manager.

  • If using dynamic _import_sibling, register sys.modules[name] = mod before exec_module; Python dataclasses need __module__ resolvable.

  • Initialize StorageManager(StorageConfig.from_env()) in the server.

  • In _load_stage(), first line should resolve: url = self._storage.resolve_or_passthrough(url).

  • Add --storage CLI flag and set OVSTORAGE_ENABLED=1 when present.

Environment

VariableDefault
OVSTORAGE_ENABLED0
OVSTORAGE_BUCKET_URLs3://ov-viewer-samples
OVSTORAGE_ENDPOINT_URLhttp://localhost:9000
OVSTORAGE_REGIONus-east-1
OVSTORAGE_ADDRESSINGpath
OVSTORAGE_CACHE_DIR/tmp/ov-stage-cache
OVSTORAGE_PREFIXsamples_data
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEYcredentials

Run:

AWS_ACCESS_KEY_ID=minioadmin AWS_SECRET_ACCESS_KEY=minioadmin python3 server/ov_web_viewer_server.py --storage --port 49100

Expected logs include enabled bucket, sync start, sync counts, and loading from /tmp/ov-stage-cache/....

Troubleshooting

SymptomFix
ModuleNotFoundError: ovstorageinstall ovstorage in the server environment
dataclass NoneType.__dict__register dynamic import in sys.modules
0 synced, 0 cachedcheck bucket and prefix with mc ls
missing texturesverify full tree under $OVSTORAGE_CACHE_DIR/$OVSTORAGE_PREFIX
port conflict 49100stop old viewer or use another port

Public S3 Asset Browsing

For browsing NVIDIA content buckets that need no credentials, use direct HTTPS listing:

Bucket Discovery

List objects under a prefix using the S3 REST XML API:

import xml.etree.ElementTree as ET
import urllib.request
import urllib.parse

S3_BUCKET = "omniverse-content-production"
S3_BASE_URL = f"https://{S3_BUCKET}.s3.us-west-2.amazonaws.com"

def list_objects(prefix: str, delimiter: str = "/", max_keys: int = 1000) -> tuple[list[str], list[str]]:
    """List object keys and common prefixes (subdirectories) under a prefix."""
    params = urllib.parse.urlencode({
        "list-type": "2",
        "prefix": prefix,
        "delimiter": delimiter,
        "max-keys": str(max_keys),
    })
    url = f"{S3_BASE_URL}?{params}"
    with urllib.request.urlopen(url, timeout=15) as resp:
        tree = ET.fromstring(resp.read())
    ns = {"s3": "http://s3.amazonaws.com/doc/2006-03-01/"}
    keys = [c.text for c in tree.findall(".//s3:Key", ns) if c.text]
    prefixes = [c.text for c in tree.findall(".//s3:CommonPrefixes/s3:Prefix", ns) if c.text]
    return keys, prefixes
Asset Catalog & Manifest

Many NVIDIA content buckets include manifest files (manifest.json, index.json, catalog.json) at category roots. Check for these first — they list assets with metadata (name, path, tags, description) without needing full prefix enumeration:

MANIFEST_NAMES = ["manifest.json", "index.json", "catalog.json", "assets.json"]

def try_load_manifest(prefix: str) -> Optional[list[dict]]:
    for name in MANIFEST_NAMES:
        url = f"{S3_BASE_URL}/{urllib.parse.quote(prefix + name, safe='/')}"
        try:
            with urllib.request.urlopen(url, timeout=10) as resp:
                return json.loads(resp.read())
        except Exception:
            continue
    return None

Fall back to prefix listing when no manifest exists.

Thumbnail Loading

Thumbnails live alongside USD files (commonly .png or .jpg with matching stem, or in a thumbnails/ subdirectory). Load them lazily in background threads and cache locally:

from pathlib import Path
from concurrent.futures import ThreadPoolExecutor

THUMBNAIL_EXTS = [".png", ".jpg", ".jpeg", ".webp"]

def find_thumbnail_key(usd_key: str, available_keys: list[str]) -> Optional[str]:
    stem = PurePosixPath(usd_key).stem
    parent = str(PurePosixPath(usd_key).parent)
    candidates = [
        f"{parent}/{stem}{ext}" for ext in THUMBNAIL_EXTS
    ] + [
        f"{parent}/thumbnails/{stem}{ext}" for ext in THUMBNAIL_EXTS
    ]
    for c in candidates:
        if c in available_keys:
            return c
    return None

def download_thumbnail(url: str, cache_path: Path, timeout: float = 10.0) -> Optional[Path]:
    if cache_path.exists():
        return cache_path
    cache_path.parent.mkdir(parents=True, exist_ok=True)
    try:
        urllib.request.urlretrieve(url, str(cache_path))
        return cache_path
    except Exception:
        return None

Use a thread pool (4-8 workers) for concurrent thumbnail downloads. Decode and scale images off the UI thread.

Category Structure

Organize assets by S3 prefix hierarchy. Common prefix = category name:

from pathlib import PurePosixPath

def categorize_assets(keys: list[str], base_prefix: str) -> dict[str, list[str]]:
    categories: dict[str, list[str]] = {}
    for key in keys:
        if not any(key.endswith(ext) for ext in [".usd", ".usda", ".usdc"]):
            continue
        rel = PurePosixPath(key).relative_to(PurePosixPath(base_prefix))
        cat = str(rel.parent) if rel.parent != PurePosixPath(".") else "General"
        categories.setdefault(cat, []).append(key)
    return categories
Local Cache Strategy

Cache downloaded assets preserving the S3 key structure so relative USD references (textures, sublayers) resolve correctly:

def cache_path_for_key(key: str, cache_root: Path) -> Path:
    return cache_root / key

def download_asset_tree(usd_key: str, cache_root: Path) -> Path:
    """Download the USD file and its directory siblings (textures, materials)."""
    parent_prefix = str(PurePosixPath(usd_key).parent) + "/"
    sibling_keys, _ = list_objects(parent_prefix, delimiter="")
    for k in sibling_keys:
        dest = cache_path_for_key(k, cache_root)
        if not dest.exists():
            url = f"{S3_BASE_URL}/{urllib.parse.quote(k, safe='/')}"
            download_thumbnail(url, dest)  # reuse download helper
    return cache_path_for_key(usd_key, cache_root)

ovrtx file loads require a local filesystem path, so always resolve through the cache before calling renderer.open_usd() or composing an inline root with open_usd_from_string().

When To Use Direct HTTPS vs S3 API

ScenarioApproach
Public bucket, no credentials, browsing UIDirect HTTPS (urllib/requests)
Private bucket with IAM/credentialsovstorage
USD asset resolver behaviorGenerate a local resolver/cache wrapper around ovstorage
Simple file download and cacheDirect HTTPS
Full tree sync with change detectionovstorage.walk() + size-based cache validation

See also: stage-management, stage-loading, cloud-deployment.

Requirements and compatibility

Written for: OpenAI Codex

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

The author says: Orchestrator skill. Downstream focused references may require NVIDIA GPUs, ovrtx, ovstream, ovui, OpenUSD, Python, Node/React, Tauri, Electron, C++, or cloud GPU deployment access depending on the selected viewer path.

Security

What our scanner noticed· Medium risk

  • Large base64-encoded blobs
  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
NVIDIA Omniverse
Publisher
OpenAI (Official)
Distributed by
OpenAI
Source
openai/plugins · plugins/nvidia/skills/omniverse-realtime-viewer · commit d420d13
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (written by AutoGineer)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by NVIDIA Omniverse or OpenAI.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download omniverse-realtime-viewer.zip