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

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/dependencies/quick-setup.md

Dependency Quick Setup

Quick Setup

Before choosing install commands for NVIDIA runtimes, read nvidia-runtime.md. It is the source of truth for ovrtx, ovui, ovstream, the ov-web-rtc browser client, and the current package guidance and supplemental documentation for dependency-owned skills, samples, renderer examples, widgets, and release notes. For ovstream, use the supplemental GitHub repository in nvidia-runtime.md when the task needs library-owned skills, samples, or transport-specific examples.

Start every Python app from a clean environment:

python3 -m venv .venv
. .venv/bin/activate
python3 -m pip install --upgrade pip setuptools wheel

Inside a generated app, install server dependencies through the checked-in project manifests and the current NVIDIA runtime guidance:

python3 -m pip install -r server/requirements.txt

Use nvidia-runtime.md for current NVIDIA runtime locations instead of copying release URLs or registry paths into app-specific setup notes.

For a generated frontend:

cd frontend
npm install

Use Node.js 20+ and npm 10+ for frontend installs. The WebRTC client package declares those engine requirements. Use nvidia-runtime.md for the current @nvidia/ov-web-rtc package and standalone ovstream Direct guidance.

Shared viewer UI is generated as local frontend code when needed. Do not add a package dependency for it; use viewer-backend-interface to create frontend/src/viewer-ui/.

Use one Python virtual environment per Omniverse Realtime Viewer app. Avoid mixing native wheels or shared libraries from multiple Omniverse Realtime Viewer experiments in a single environment.

Local Cache Configuration

Set project-local cache paths before installing dependencies or running generated viewers when the default home cache may not be writable:

mkdir -p .cache/cuda .cache/gl .cache/warp .cache/npm
export XDG_CACHE_HOME="$PWD/.cache"
export CUDA_CACHE_PATH="$PWD/.cache/cuda"
export __GL_SHADER_DISK_CACHE_PATH="$PWD/.cache/gl"
export npm_config_cache="$PWD/.cache/npm"

For npm, either keep npm_config_cache in the environment or pass the cache path explicitly:

npm --cache ./.cache/npm install

For Warp, set the kernel cache directory before wp.init() or before launching kernels:

import warp as wp

wp.config.kernel_cache_dir = "./.cache/warp"
wp.init()

Why: containers, CI runners, shared workspaces, and restricted service users may not be able to write the default ~/.cache. A project-local .cache/ keeps CUDA, GL shader, Warp kernel, and npm cache writes under the app directory and makes cache permissions explicit.

When scaffolding a generated viewer, create an app-root .gitignore so the project-local .cache/, virtual environment, npm install output, build output, logs, and Python bytecode stay untracked. Include at least .venv/, .cache/, node_modules/, dist/, __pycache__/, *.log, and logs/.

Dependency Matrix

DependencyAcquisition pathNeeded by
ovrtxSee nvidia-runtime.md for the current package guidance and supplemental documentation.Streaming and local Omniverse Realtime Viewers
ovstreamSee nvidia-runtime.md for the current PyPI package and supplemental documentation.Streaming server only
usd-coreserver/requirements.txt, pinned exactly to usd-core==24.11USD query subprocesses
warp-langserver/requirements.txt, or pip install warp-langCUDA frame conversion and GPU utilities
numpyserver/requirements.txt, or pip install numpyCamera math, matrices, CPU arrays
ov-web-rtc client / @nvidia/ov-web-rtcSee nvidia-runtime.md; use standalone ovstream Direct guidance.Browser streaming client
Local viewer UI moduleGenerated from viewer-backend-interface under frontend/src/viewer-ui/ when neededShared frontend controls and UI contracts
ovuiSee nvidia-runtime.md for the current PyPI package and supplemental documentation.Local desktop Omniverse Realtime Viewers, not streaming

Do not install alternate browser streaming package names, hard-code browser client versions in skill docs, or use ad hoc frontend archives. Use nvidia-runtime.md for ovui and streaming native runtime setup.

Global Requirements

  • Use Linux x86_64 for the common supported streaming sample path.

  • Use an NVIDIA GPU with RTX cores for ovrtx.

  • Use an NVIDIA GPU and driver with NVENC support for ovstream.

  • Use an NVIDIA driver that supports the installed GPU and CUDA driver API.

  • CUDA compute capability 7.0 or newer is recommended.

  • Use one Python environment per app to avoid mixing native libraries.

  • Set OVRTX_SKIP_USD_CHECK=1 before any ovrtx work.

  • Keep pxr work out of the process that owns ovrtx.Renderer; use a subprocess.

  • Put ovrtx's bundled plugin libraries first in the dynamic library path when plugin or MDL resolution fails.

  • Use a real display for local desktop UI apps; streaming Omniverse Realtime Viewers do not need an ovui window.

Verify the GPU before installing renderer or streaming packages:

nvidia-smi --query-gpu=name,driver_version,compute_cap --format=csv

Verify Python architecture and version:

python3 -c "import platform, sys; print(platform.platform()); print(sys.version)"

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