Tokens

List of widely used tokens from carb.tokens plugin. Most paths in Kit configuration accept tokens.

  • ${kit} - path to Kit folder, where Kit executable is (it is not always the same executable as was used to run currently, one can run say from python.exe).

  • ${omni_data} - system folder to store persitent data (Omniverse Wide).

  • ${omni_logs} - system folder to store logs (Omniverse Wide).

  • ${omni_cache} - system folder to be used for caching, can be cleaned up inbetween runs (Omniverse Wide).

  • ${data} - system folder to store persitent data (Kit Application specific).

  • ${logs} - system folder to store logs (Kit Application specific).

  • ${cache} - system folder to be used for caching, can be cleaned up inbetween runs (Kit Application specific).

  • ${app_documents} - system folder to store user’s data (per app).

  • ${shared_documents} - system folder to store user’s data (shared between all apps).

  • ${app} - path to app, if loaded with --merge-config that will be a folder where this config is.

  • ${temp} - temp folder, will be cleaned up between runs.

  • ${config} - whether debug or release build is running.

  • ${platform} - target platform Kit is running on, e.g. windows-x86_64.

  • ${lib_ext} - .dll on windows, .so on linux.

  • ${lib_prefix} - empty on windows, lib on linux.

  • ${bindings_ext} - .pyd on windows, .so on linux.

  • ${exe_ext} - .exe on windows, empty on linux.

  • ${shell_ext} - .bat on windows, .sh on linux.

Resolving your path

To make your path support tokens you must resolve it before using it, like this:

path = carb::tokens::resolveString(carb::getCachedInterface<carb::tokens::ITokens>(), path);
import carb.tokens
path = carb.tokens.get_tokens_interface().resolve(path)