Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions docs_dev/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,26 @@ SDK, Pixar USD, and development workflow.

## Getting Started

The RTX Remix Toolkit utilizes
the [Kit SDK](https://docs.omniverse.nvidia.com/kit/docs/kit-manual/latest/guide/kit_overview.html). Familiarize
yourself with the Kit SDK, which serves as the foundation for extension development.
The RTX Remix Toolkit is built upon the
[Omniverse Kit SDK](https://docs.omniverse.nvidia.com/kit/docs/kit-manual/latest/guide/kit_overview.html). Familiarize
yourself with the Omniverse Kit SDK, which serves as the foundation for extension development. See the following video
for a brief overview on extension development with the Omniverse Kit SDK:

[![Build Your First Omniverse Extension With OpenUSD](https://img.youtube.com/vi/4RkR8YH6AaE/mqdefault.jpg)](https://www.youtube.com/watch?v=4RkR8YH6AaE)

Additionally, acquaint yourself with Pixar USD, a robust tool for creating and modifying digital assets. Resources for
learning USD are available on the following websites:

- [Learn USD](https://learnusd.github.io/index.html)
- [OpenUSD Intro to USD](https://openusd.org/dev/intro.html)
- [VFX UsdSurvivalGuide](https://lucascheller.github.io/VFX-UsdSurvivalGuide/index.html)
- [USDBook by Remedy Entertainment](https://remedy-entertainment.github.io/USDBook/index.html)

## Repository Structure

The RTX Remix Toolkit primarily consists of two repositories within this monorepo:

- **Lightspeed**
- **Flux**
- **Lightspeed (lightspeed.trex.*)**
- **Flux (omni.flux.*)**

Both repositories are located in the [`extensions` directory](../source/extensions). Extensions can be identified by
their naming conventions.
Expand Down Expand Up @@ -50,6 +53,9 @@ To contribute to the RTX Remix Toolkit:
1. Fork this repository.
2. Create a development branch in your fork.
3. Submit a Pull Request to merge your changes from your fork's branch into this repository.
- Before your Pull Request can be accepted, an automated bot will prompt you to sign the
[Contributor License Agreement](https://github.com/NVIDIAGameWorks/toolkit-remix/blob/main/.github/workflows/cla/NVIDIA_CLA_v1.0.1.md),
via your Pull Request's comment page.

## Common Flags

Expand All @@ -68,7 +74,8 @@ use flags to modify the Toolkit's behavior.

## Additional Documentation

- **[Using Pycharm IDE + debug](./PYCHARM_GUIDE.md)**: Learn about developing with Pycharm and debugging.
- **[Using Pycharm IDE](./PYCHARM_GUIDE.md)**: Learn about developing with Pycharm.
- **[Debugging Guide](./DEBUGGING_GUIDE.md)**: Info on how to attach debuggers to the toolkit.
- **[How to profile](./PROFILE_GUIDE.md)**: Introduction to profiling.
- **[Review Checklist](./REVIEW_CHECKLIST.md)**: Guidelines for engineers submitting merge requests.
- **[Automated Testing](./TESTING_GUIDELINES.md)**: Process for writing and deploying tests in lightspeed for kit
Expand Down
5 changes: 3 additions & 2 deletions docs_dev/DEBUGGING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ To enable the `omni.kit.debug.python` extension, you must run the app with a `--
```
The app will boot up as usual and a debugpy server will be listening on port `3000`.

If you prefer, enable the `omni.kit.debug.vscode` extension instead and it will do the same but with a VS Code Link window like this on startup:
If you prefer, enable the `omni.kit.debug.vscode` extension by running the `lightspeed.app.trex_dev.bat` and enabling it
via the Window -> Extensions option in the toolbar. This will do the same but with a VS Code Link window like this on startup:

![VSCode Debug Window](./data/omni_kit_debug_vscode_window.png)

Now just attach your IDE on `127.0.0.1:3000` and happy debugging!

For example for VSCode or Cursor, we already have setup `.vscode/launch.json`, otherwise you can create your own with a`
For example for VSCode or Cursor, we already have setup `.vscode/launch.json`, otherwise you can create your own with a
`Python: Remote Attach` config like this and run it to attach to the server:

```json
Expand Down