User Guide#

This document describes the components and workflow of the Omniverse Launcher. Making it easy for users to manage their Omniverse Apps, Connectors, and provides Nucleus Collaboration Services; the Omniverse Launcher acts as your personal launchpad for the Omniverse.

The Omniverse Launcher is available for download from the Omniverse Getting Started page or from NVIDIA’s licensing and software portal for Enterprise customers.

News Tab#

The Omniverse news Tab allows users to review and learn about things related to Omniverse.

Exchange Tab#

The Omniverse Exchange is the place where Omniverse Apps, Connectors, File Tools and more can be found and installed.

Simply navigate through the list of available apps and connectors, select the version, and install. Once installed, this area can also be used to launch apps.

Library Tab#

The Omniverse Library makes it easy to see, launch, update, and/or learn about Omniverse Apps installed on your computer.

Note

If this list is empty this is because you currently have no applications installed. This can easily be remedied by clicking over to the Exchange and installing the apps/connectors of your choice.

Library Panel#

The Omniverse Library Panel is located on the left side of the screen and lists all installed Apps, Connectors and more. Selecting one of the items on the list will reveal useful data in the main window about the tool as well as provides functionality based on the item type selected.

Note

The Omniverse Library Panel will be unpopulated until apps are installed. If your list is empty, please navigate to the Exchange Tab to install apps, connectors, and other Omniverse tools.

Apps#

On the top of the Library panel, apps are listed. Upon selecting an App, a series of options will be provided for managing the App in the main display.

Option	Description
Launch Button	The launch button allows users to easily launch a selected App.
Install Settings	Found in the Hamburger Menu to the right of the Launch Button, The Settings Pane allows you to review the install path, update, or uninstall the Selected App
Release Notes	Launches the Documentation Portal for the selected App and takes you to the Latest Release Notes.
Documentation	Launches the Documentation Portal for the Selected App.
Tutorials	Launches the Video Learning content for the selected App.
Forums	Launches the Forum Pages for in-depth discussion on the selected App.

Development Tools#

Upon installing Kit, a development tools Tab will appear below Apps. Development tools are typically handled and managed in the same way as Apps and offers similar tools for managing these tools.

Option	Description
Launch Button	The launch button allows users to easily launch a selected App.
Install Settings	Found in the triple Bars to the right of the Launch Button, The Settings Pane allows you to review the install path, update, or uninstall the Selected App
Release Notes	Launches the Documentation Portal for the selected App and Takes you to the Latest Release Notes.
Documentation	Launches the Documentation Portal for the Selected App.
Tutorials	Launches the Video Learning content for the selected App.
Forums	Launches the Forum Pages for in depth discussion on the selected App.

File Management#

File management tools provide utilities for managing file operations on the Omniverse. These tools by their nature are less cohesive in their tooling and have variation on their UI controls. Please see the documentation of the tool in question should you need explanation of how to manage.

Connectors#

All connectors appear under the connectors icon and are displayed in a list allowing management.

For each connector installed, an entry will appear in the list with the ability to add additional connectors easily should you need them.

Option	Description
Add	Allows adding additional connectors and brings you to the Connectors Exchange.
Update	If a connector is out of date, a green Update Button will be displayed allowing you to update to the most current release of that connector.
Up To Date	When a connector on the list is up to date, a greyed out “up to date” notification will be presented.

Updating an App#

Any app previously installed that has an update available will display with the following green highlight.

_images/launcher_update_notification.png

Selecting (left-click) the highlight will allow you to locate the update (green).

Upon selecting, the launcher update status will show the progress. Once the update is complete

The Launch Button will auto-select the updated version.

An Alert confirming the success or failure + reason will be generated.

The highlight will be removed.

Note

In the Library Tab, only the latest version of an application is listed for quick install. Versions released after the installed version and before the latest version are available for installation in the Exchange Tab.

Exchange Tab#

The Omniverse Exchange is the place where Omniverse Apps, Connectors, File Tools and more can be found and installed.

Simply navigate through the list of available apps and connectors, select the version, and install. Once installed, this area can also be used to launch apps.

Updating a Connector#

Connectors have a unified interface. Simply select Connectors under the Exchange Tab and any installed connectors will have an green notification bell shown.

Option	Description
Filters	Allows refinement of list based on selection
Search	Contextual Search allows locating a specific App or Connector easily.
Apps List	Shows all available Apps or Connectors based on Filters and Search.

Product Overview#

When selected, details about the app/connector/tool are presented including overall description, version information, supported platforms, and system requirements. This information can be useful to decide if the app/connector/tool is right for you before downloading and installing.

Install Apps#

Apps are installed and launched by selecting items in the Exchange Tab:

Available releases are categorized by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on its maturity and stability. If an Alpha or Beta release is selected, a banner will appear on the main image to emphasize the relative stability and completeness of that release. Alpha or Beta releases may not be feature complete or fully stable. Versions classified as Release (also known as GA or General Availability) are feature complete and stable. Release versions that are supported for Enterprise customers appear in the Enterprise list. After selecting the desired version, clicking the Install Button will initialize installation.

Nucleus Tab#

The Omniverse Launcher Nucleus Tab offers the experience of the Omniverse Nucleus Navigator app directly in the Launcher, enabling users to quickly and easily navigate and manage content in their Omniverse Nucleus servers.

For more information on Navigator features and functionality, please review Omniverse Nucleus Navigator.

Important

If you are looking to host a large, company wide installation of Nucleus and expect large amounts of traffic, other more robust Nucleus packages are available and should be used in lieu or addition to local Server(s).

Note

A network can have multiple Nucleus Installations and there is no harm in having both Linux Docker Installations and Local Servers on the same network. They will exist independently of each other and do not conflict.

Create your administration Account#

As this process installs a set of services and effectively turns your workstation into a server, an administration account will be needed. This account allows full and complete control over your Nucleus and is unrelated to any other NVIDIA Accounts. This is your servers primary account and specifically allows you access to the server you are currently installing.

_images/launcher_collaboration_create-admin-account.png

Press the Create to finalize the user admin account and log in.

Connecting to Collaboration#

Once the above steps have been followed, Users can now connect to your Omniverse Nucleus collaboration service. This is also true for Local Applications.

In order to connect to the collaboration service connect with the network address of the host that is also accessible to the user you wish to share with. For details on connecting, please see the documentation for the omniverse app, connector or utility you are using.

Connecting Locally#

If the collaboration service resides on your workstation, you can also use localhost to connect with local apps and connectors.

Additional Collaboration Information#

For more information on the Nucleus Collaboration Services, please review Nucleus Documentation

Alerts#

The alert icon in the top right of the notifies your of important Omniverse Messages.

User Settings#

The User Settings panel allows users to choose the default install path for the Omniverse Library Apps & Connectors.

Settings#

Option	Description
Library Path	This location specifies where apps, connectors and tools are installed when installed from Launcher.
Data Path	Displays and allows selection of the Data Path. The data path is where all content on the local Nucleus is stored.

About#

Gives version information about Launcher.

Log out#

Logs out of the Launcher.

Accessibility#

Omniverse Launcher Text and Layout accommodates text/image scale adjustment to help users with readability and/or high resolution monitors.

Key Command	Action
`Ctrl` + `-`	Scale Text/Images Smaller
`Ctrl` + `Shift` + `+`	Scale Text/Images Larger
`Ctrl` + `0`	Reset Scale to Default