Set Up Your Development Environment#

Step 6.1: Launch Code#

From the Omniverse Launcher, click Library, then Code, then Launch:

Step 6.2: Establish a Project Folder#

Choose a folder on your file system where you’ll store all of your repositories. For example, C:/Users/YOUR_USER_NAME/Repos if you’re on Windows. The rest of this tutorial refers to this as your project folder.

Step 6.3: Create an Extension Template#

1. In Omniverse Code, open the Extensions panel

2. Click the ➕ icon

3. Click New Extension Template Project

4. Select your project folder

5. Click Select

Step 6.4: Name your Extension#

1. Name the root folder for your Extension repository

2. Name your Extension

For the Extension name, use the following convention:

<namespace>.<extension_descriptor_1>.<extension_descriptor_2>

In this convention, <namespace> is a unique name for your personal Extension space. Following your namespace is a series of one or two <extension_descriptor> elements. The first word should be general, and the second word, if you have one, should be specific. For example, an Excel reading sample Extension might have the name “UniqueNamespace.Sample.Excel”.

When you submit your Extension, Visual Studio Code will be opened to your new Extension’s repository.

Step 6.5: Create Your Extension#

Follow our tutorial on Creating your First Extension.

Join Us: Join us on Discord where you can chat with community members and NVIDIA developers and participate in frequent Omniverse hangouts and hackathons.

Step 7.1: Create Your Repository#

Navigate to the Source Control tab in Visual Studio Code:

Step 7.2: Publish the Repository to GitHub#

Click Publish to GitHub:

If this is your first time connecting to GitHub from Visual Studio Code, click Allow and log in to GitHub.

Step 7.3: Choose a Public or Private Repository#

Click Publish to GitHub private repository.

You can always change to a public repository when you are ready to share your Extension with the world.

Step 7.4: Open the Repository on GitHub#

While learning Git requires its own tutorial, get started with your first commit:

1. Write your code.

2. Go back to the Source Control tab.

3. Write a message in the Commit Message box.

4. Click the check mark to commit your code.

5. Click the Sync button to sync your code with the GitHub server.

8.1: Add the omniverse-kit-extension Topic#

Click on the gear in the About section of your repository.

In the popup that appears, add omniverse-kit-extension to the topics text field:

Click Save changes.

8.2: Create a Release#

Under Releases, click Create a new release:

Once you’re on the release page:

1. Click Choose a tag

2. Enter a name such as “v1.0” for your tag

3. Click + Create a new tag

4. Click Publish release

8.3: Make the Repository Public#

When your Extension is complete, and you’re ready for it to appear in the Extension catalog within Omniverse, go to your repository settings, scroll down to the Danger Zone and make your repository public.