Skip to content

Latest commit

 

History

History
207 lines (157 loc) · 5.99 KB

kit_app_template_tooling_guide.md

File metadata and controls

207 lines (157 loc) · 5.99 KB
Raw

Kit App Template Tooling Guide

This document provides an overview of the practical aspects of using the tooling provided in the kit-app-template. Intended for users with a basic familiarity with command-line operations, this guide offers typical usage patterns and recommendations for effective tool use. For a complete list of options for a given tool, use the help command: ./repo.sh [tool] -h or .\repo.bat [tool] -h.

Overview of Tools

The kit-app-template repository includes several tools designed to streamline the development of applications and extensions within the Omniverse Kit SDK.

Available Tools

  • template
  • build
  • launch
  • test
  • package

Each tool plays a specific role in the development workflow:

Template Tool

Command: ./repo.sh template or .\repo.bat template

Purpose

The template tool facilitates the initiation of new projects by generating scaffolds for applications or extensions based on predefined templates located in /templates/templates.toml.

Usage

The template tool has two main commands: list and new.

list

Lists available templates without initiating the configuration wizard.

Linux:

./repo.sh template list

Windows:

.\repo.bat template list

new

Creates new applications or extensions from templates with interactive prompts guiding you through various configuration choices.

Linux:

./repo.sh template new

Windows:

.\repo.bat template new

Build Tool

Command: ./repo.sh build or .\repo.bat build

Purpose

The build tool compiles all necessary files in your project, ensuring they are ready for execution, testing, or packaging. It includes all resources located in the source/ directory.

Usage

Run the build command before testing or packaging your application to ensure all components are up to date:

Linux:

./repo.sh build

Windows:

.\repo.bat build

Other common build options:

  • -c or --clean: Cleans the build directory before building.
  • x or --rebuild: Rebuilds the project from scratch.

Launch Tool

Command: ./repo.sh launch or .\repo.bat launch

Purpose

The launch tool is used to start your application after it has been successfully built, allowing you to test it live.

Usage

Select and run a built .kit file from the source/apps directory:

Linux:

./repo.sh launch

Windows:

.\repo.bat launch

Additional package options:

  • -d or --dev-bundle: Launches with a suite of developer tools enabled in UI-based applications.

  • -p or --package: Launches a packaged application from a specified path.

    Linux:

    ./repo.sh launch -p </path/to/package.zip>

    Windows:

    .\repo.bat launch -p <C:\path\to\package.zip>

  • --container: Launches a containerized application (Linux only).

    Linux:

    ./repo.sh launch --container

    Windows:

    .\repo.bat launch --container

  • Passing args to launched Kit executable: You can pass through arguments to your targeted Kit executable by appending -- to your launch command. Any flags added after -- will be passed through to Kit directly. The following examples will pass the --clear-cache flag to Kit.

    Linux:

    ./repo.sh launch -- --clear-cache

    Windows:

    .\repo.bat launch -- --clear-cache

Test Tool

Command: ./repo.sh test or .\repo.bat test

Purpose

The test tooling facilitates the execution of automated tests on your applications and extensions to help ensure their functionality and stability. Applications configurations (.kit files) are tested to ensure they can startup and shutdown without issue. However, the tests written within the extensions will dictate a majority of application functionality testing. Extension templates provided by the Kit App Template repository include sample tests which can be expanded upon to increase test coverage as needed.

Usage

Always run a build before testing:

Linux:

./repo.sh test

Windows:

.\repo.bat test

Package Tool

Command: ./repo.sh package or .\repo.bat package

Purpose

This tool prepares your application for distribution or deployment by packaging it into a distributable format.

Usage

Always run a build before packaging to ensure the application is up-to-date:

Linux:

./repo.sh package

Windows:

.\repo.bat package

Additional launch options:

  • -n or --name: Specifies the package (or container image) name.

    Linux:

    ./repo.sh package -n <package_name>

    Windows:

    .\repo.bat package -n <package_name>

  • --thin: Creates a thin package that includes only custom extensions and configurations for required registry extensions.

    Linux:

    ./repo.sh package --thin

    Windows:

    .\repo.bat package --thin

  • --container: Packages the application as a container image (Linux only). When using the --container flag, the user will be asked to select a .kit file to use within the entry point script for the container. This can also be specified without user interaction by passing it appropriate .kit file name via the --target-app flag.

    Linux:

    ./repo.sh package --container

    Windows:

    .\repo.bat package --container

⚠️ Important Note for Packaging: Because the packaging operation will package everything within the source/ directory the package version will need to be set independently of a given kit file. The version is set within the tools/VERSION.md file.

Additional Resources