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://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/stage-queries/README.md

Stage Queries

Triggers

Use this skill for query_prims, stage query, find prims, prim type filter, has attribute, AttributeFilterMode, FilterKind, or prim_list_handle.

Use this when an Omniverse Realtime Viewer needs to discover prim paths, build a stage tree, find prims by type, find prims with specific attributes, or inspect attribute schemas before reading or writing.

Core API

from ovrtx import AttributeFilterMode, FilterKind

result = renderer.query_prims(
    attribute_filter_mode=AttributeFilterMode.NONE,
)
paths = sorted(result.keys())

Renderer.query_prims() is the synchronous convenience path. Renderer.query_prims_async() enqueues the same query and returns an operation:

op = renderer.query_prims_async(
    require_any=[(FilterKind.PRIM_TYPE, "Mesh"), (FilterKind.PRIM_TYPE, "Camera")],
    attribute_filter_mode=AttributeFilterMode.SPECIFIC,
    attribute_names=["omni:xform", "visibility"],
)
pending = op.wait(timeout_ns=5_000_000_000)
if pending is not None:
    result = pending.fetch(timeout_ns=100_000_000)

The Python result is dict[str, dict[str, AttributeInfo]]: each key is a prim path, and each value is the reported attribute descriptors for that prim.

Filter Construction

Each filter is a (kind, name) tuple:

KindMeaningExample
FilterKind.PRIM_TYPEMatch USD type name"Mesh", "Xform", "Camera", "SphereLight"
FilterKind.HAS_ATTRIBUTEMatch attribute presence"points", "omni:xform", "visibility", "inputs:Fader"

Filter lists combine as:

  • require_all: AND. The prim must match every filter in this list.

  • require_any: OR. The prim must match at least one filter in this list.

  • exclude: NOT. The prim must match none of these filters.

meshes_or_lights_with_visibility = renderer.query_prims(
    require_all=[
        (FilterKind.HAS_ATTRIBUTE, "visibility"),
    ],
    require_any=[
        (FilterKind.PRIM_TYPE, "Mesh"),
        (FilterKind.PRIM_TYPE, "SphereLight"),
        (FilterKind.PRIM_TYPE, "DistantLight"),
    ],
    exclude=[
        (FilterKind.PRIM_TYPE, "Scope"),
        (FilterKind.HAS_ATTRIBUTE, "omni:hidden"),
    ],
    attribute_filter_mode=AttributeFilterMode.SPECIFIC,
    attribute_names=["visibility", "purpose", "omni:xform"],
)

Omitted lists impose no constraint. An empty query matches every prim.

Attribute Reporting

AttributeFilterMode controls descriptor payload size:

ModeUse
AttributeFilterMode.NONEFast path discovery and prim counts. Per-prim descriptor dicts are empty.
AttributeFilterMode.SPECIFICInspector allowlists and read/write planning. Only attribute_names are reported.
AttributeFilterMode.ALLDebugging and rich schema browsing. Avoid for routine data-channel payloads.

AttributeInfo exposes:

  • name

  • dtype

  • is_array

  • semantic

Use descriptors to choose read_attribute() for scalar values or read_array_attribute() for variable-length arrays.

query = renderer.query_prims(
    require_all=[(FilterKind.PRIM_TYPE, "Mesh")],
    attribute_filter_mode=AttributeFilterMode.SPECIFIC,
    attribute_names=["points", "faceVertexCounts", "omni:xform"],
)

for path, attrs in query.items():
    if "points" in attrs and attrs["points"].is_array:
        points = renderer.read_array_attribute("points", [path])[path]

Tree Construction

query_prims() returns flat paths. Build hierarchy by splitting paths:

def parent_path(path: str) -> str:
    if path == "/" or path.count("/") <= 1:
        return "/"
    return path.rsplit("/", 1)[0]

def child_index(paths: list[str]) -> dict[str, list[str]]:
    index: dict[str, list[str]] = {}
    for path in paths:
        if path != "/":
            index.setdefault(parent_path(path), []).append(path)
    for children in index.values():
        children.sort()
    return index

Use lazy UI expansion: query once after stage load, cache a parent-to-children index, and only send children for expanded rows.

prim_list_handle

The lower-level C query result groups matching prims by attribute schema. Each ovrtx_query_prim_group_t includes a prim_list_handle that can be plugged into binding/read/write descriptors, such as ovrtx_binding_desc_t::prims_list_handle, to avoid string path round-trips for bulk operations.

Python resolves query groups into a path-keyed dict today, so Python apps should pass list(result.keys()) or grouped path lists into read_attribute(), write_attribute(), or map_attribute(). C/C++ integrations should preserve prim_list_handle while enqueueing follow-up operations, and copy any names needed after ovrtx_release_query_results().

Gotchas

  • Query filters match type names and attribute names, not path substrings.

  • AttributeFilterMode.SPECIFIC with no attribute_names reports no descriptors.

  • Query result attribute descriptors describe schema; they do not read values. Use stage-attribute-reads for values.

  • Relationship-like values may surface as path IDs or token IDs; use pxr fallback for readable relationship target inspection until native relationship traversal is complete.

  • Keep stage load/reset and query integration serialized through the render owner.

See also: stage-attribute-reads, stage-hierarchy, prim-info-display, prim-pick-effects, ovrtx-rendering.

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