Naming Applications and Extensions

Before we dive into creating new Applications and Extensions, let’s discuss how to name things.

Seasoned developers are no strangers to namespaces. When using Kit SDK you’ll need to use namespaces wisely to avoid conflicts with other modules created on the platform - created by your team and other companies. In this tutorial we use tokens such as my_company and my_app for naming Applications and Extensions, the purpose is to outline the recommended way to use your company / name id and name.

A few rules about naming

  • Don’t use generic names like bob or cloud.

  • Don’t use omni as this is reserved for NVIDIA Applications or Extensions.

  • Be consistent. Select one and stick to it.

App name

  • When building Applications, it is recommended to namespace the Extensions within the app name they belong to; for example, name an Extension omni.code.setup when it is created for an app named omni.code.

Shared Extensions

  • Aside from the Extension you build specifically for your App there might be some that you want to make more generic and reuse across Applications. This is how Omniverse shared Extensions are built. We have them in namespaces like omni.kit.widget or omni.kit.window.

For the purpose of this tutorial feel free to use the generic names in the instructions; however, for future production development please use this naming guide to create unique namespaces.