Frequently Asked Questions¶
Where can I find the core Kit config file?¶
It is kit-core.json
located close to the Kit executable.
Can I debug python extensions and scripts?¶
Yes! Use VS Code for that.
Run Kit, open Window/Extensions Manager, find and enable
omni.kit.debug.vscode
extension. You can now see the window called VS Code Link which shows you the status of the debugger connection.Run VS Code with Python extension installed. Open the Kit project folder with it.
Kit already has a proper .vscode/launch.json in the project. So select the Debugger tab in VS Code, select Python: Attach and press the Start Debugging button.
The status now should be changed to Connected in the Kit VS Code Link window.
Hit Break button in this window, it shows an example of using
omni.kit.commands.execute("DebugBreak")
command to break. You can debug your python code and add breakpoints.
Note
Unfortunately folder linked scripts are not properly recognized in this setup, so you must add your breakpoints in the real source files, which can be found under the _build
folder.
Note
For non-UI configurations just use omni.kit.debug.python
extension instead. Look into it’s extension.toml
for settings.
Random failures when loading omni.usd ?¶
You can debug how USD loads it’s plugins with the environment variable TF_DEBUG
. If you set TF_DEBUG=PLUG_INFO_SEARCH
, it will print out all the plugInfo.json
files it finds. If you set TF_DEBUG=PLUG_REGISTRATION
, it will print out all the plugins it tries to register. Also setting TF_DEBUG=PLUG_LOAD
can be useful, as it prints the plugins loaded. Kit mutes USD output by default. To unmute it, you need to set "/omni.kit.plugin/usdMuteDiagnosticMessage"
to false
.