/kit-extension-sample-apiconnect

Primary LanguagePowerShellApache License 2.0Apache-2.0

API Connect Sample Omniverse Extension

preview.png

About

This Sample Omniverse Extension demonstrates how connect to an API.

In this sample, we create a palette of colors using the HueMint.com. API.

README

See the README for this extension to learn more about it including how to use it.

Tutorial

Follow a step-by-step tutorial that walks you through how to build this extension using asyncio and aiohttp.

Adding This Extension

To add a this extension to your Omniverse app:

  1. Go into: Extension Manager -> Hamburger Icon -> Settings -> Extension Search Path
  2. Add this as a search path: git://github.com/NVIDIA-Omniverse/kit-extension-sample-apiconnect.git?branch=main&dir=exts

Alternatively:

  1. Download or Clone the extension, unzip the file if downloaded
  2. Copy the exts folder path within the extension folder
    • i.e. home/.../kit-extension-sample-apiconnect/exts (Linux) or C:/.../kit-extension-sample-apiconnect/exts (Windows)
  3. Go into: Extension Manager -> Hamburger Icon -> Settings -> Extension Search Path
  4. Add the exts folder path as a search path

Linking with an Omniverse app

For a better developer experience, it is recommended to create a folder link named app to the Omniverse Kit app installed from Omniverse Launcher. A convenience script to use is included.

Run:

# Windows
> link_app.bat
# Linux
~$ ./link_app.sh

If successful you should see app folder link in the root of this repo.

If multiple Omniverse apps are installed the script will select the recommended one. Or you can explicitly pass an app:

# Windows
> link_app.bat --app code
# Linux
~$ ./link_app.sh --app code

You can also pass a path that leads to the Omniverse package folder to create the link:

# Windows
> link_app.bat --path "C:/Users/bob/AppData/Local/ov/pkg/create-2022.1.3"
# Linux
~$ ./link_app.sh --path "home/bob/.local/share/ov/pkg/create-2022.1.3"

Attribution & Acknowledgements

This extension uses the Huemint.com API. Huemint uses machine learning to create unique color schemes.

Special thanks to Jack Qiao for allowing us to use the Huemint API for this demonstration.

Check out Huemint.com

Contributing

The source code for this repository is provided as-is and we are not accepting outside contributions.