How nvidia-omniverse/kit-app-template works
Project Type & Purpose
• Type: An open-source scaffolding toolset, providing CLI wrappers, templates, and tooling for generating, building, testing, launching, and packaging Omniverse Kit applications and extensions.
• Purpose: Accelerate GPU-accelerated 3D application development by exposing a suite of templates (apps & extensions), scripts (repo.sh, repo.bat), and tools (packman, repoman, premake) to automate common workflows.
File Structure & Readme Insights
Top-Level Components
– CLI Entry-Points: repo.sh (Linux), repo.bat (Windows)
– Build Config: premake5.lua
– Templates: /templates/apps/* and /templates/extensions/*
– Tools: /tools (containers, deps, packman, repoman)
– Docs & Assets: /readme-assets, README.md
Key Patterns
– Template-Engine pattern: static folder of “blueprints” used by CLI
– Plugin-style extensibility: each template defines a “.kit” file, extension.toml, code stubs
– Toolchain orchestration: shell+Python wrappers invoking packman/repoman and premake to manage deps and compile
A. Developer Environment
• CLI Scripts (repo.sh, repo.bat)
• Configuration (repo.toml, repo_tools.toml)
• VSCode / IDE settings
B. Template Repository
• Applications templates (kit_base_editor, kit_service, usd_composer, etc.)
• Extension templates (basic_python, basic_cpp, python_ui, etc.)
C. Tooling Engine
• Repoman: orchestrates high-level repo commands (template new, build, test, launch, package)
• Packman: dependency manager for Omniverse Kit SDK and other libs
• Premake5: generates platform-specific build files (Makefiles, MSVC projects)
D. Container & Deployment
• Dockerfile.j2 and entrypoint scripts (tools/containers)
• NVIDIA Container Toolkit integration
E. External Services
• Omniverse Kit SDK (NGC registry)
• Cloud Streaming platforms (OVC, GDN)
Component Relationships & Data Flows
• Developer invokes CLI → CLI parses repo.toml & invokes Repoman
• Repoman → Template Engine reads /templates/*, populates new project under /source/apps or /source/extensions
• Build Step → Repoman calls Packman to resolve dependencies → invokes Premake to generate build files → native compiler toolchain (MSVC or GCC)
• Test Step → Runs unit tests via generated test runners
• Launch Step → Loads compiled .kit application against Omniverse Kit SDK libraries
• Package Step → Uses Packman to bundle app/extension, optionally Dockerizes via containers scripts
• Container Build → Dockerfile.j2 templated by Packman outputs GPU-enabled container
Architectural Patterns & Principles
• Modular / Plugin architecture: templates represent self-contained modules that can be assembled
• Separation of concerns: distinct layers for template generation, dependency management, build orchestration, packaging
• Convention over configuration: standardized file naming (.kit, extension.toml) and directory layout