Repository files navigation

usdtweak is a free and open source editor for Pixar'sUSD format. usdtweak can already be used for small and simple tasks like cleaning assets, creating and editing layers, inspecting and fixing usd stages. It works on windows, macos and linux.

This project is written in C++ and is powered byImGUI for the UI andGLFW for the windowing system.

usdtweak is a side project and the development is slow and unpredictable as I can only work on it a few hours during the week-end. The original idea behind usdtweak was to improve usdview by adding edition capabilities, for artists, technical directors and users who don't know the USD ascii syntax and are not familiar with python. The current goal driving the developments is to provide at least the same functionalities as usdview with the ability to edit stages and layers.

As of today usdtweak allows

• to browse and edit multiple stages and layers at the same time, copying and pasting specs between layers,
• to edit stages properties in an edit target context
• to create and edit variants at the layer level
• to edit layer hierarchy: adding, deleting, reparenting, and renaming specs
• to edit stage layer stack: adding, deleting new sublayers
• to create and delete compositions like references and payloads, inherits, ...
• to change property values in layers and stages
• to add and delete keys on properties
• to assign material on a prim
• a minimal viewport interaction: translating, rotating, scaling objects.
• text editing (for small files)
• and more ...

If you want to try usdtweak without the burden of compiling it, you can download the latest installer herehttps://github.com/cpichard/usdtweak/releases. Feel free toreach out if you have any issue with it (or success).

If you're on windows, you can usewindows-build.ps1 powershell script to build usdtweak. It will download the USD pre-build binaries fromNVIDIA and compile usdtweak for you, granted you have the required tools installed (Cmake, Visual Studio 2022 build tools).Keep in mind nvidia USD binaries are underNVIDIA OMNIVERSE LICENSING, make sure you're aware of the terms and conditions before using them.

After running the build script, you can runwindows-start.bat to start usdtweak.

If you prefer to compile usdtweak manually, you can follow the instructions in theBuilding.md file:

• Building requirements
• Building on windows
• Building on macos
• Building on linux

The documentation now lives in the growingwiki, it mainly contains informations on how to use usdtweak.

This project welcomes any contributions: features ideas, bug fixes, documentation, tutorials, etc. If you want to contribute justreach out by mail.

For code contribution you can make a pull request from your fork. If you don't know how to fork and create pull requests, thisvideo explains the process.

• When enabling the scene materials in Storm, the texture don't always load correctly. This can be solved by setting the USDIMAGINGGL_ENGINE_ENABLE_SCENE_INDEX environment variable to 1.

If you want to know more, or have any issues, questions, drop me an email:cpichard.github@gmail.com or fill agithub issue.

Big thanks all the humans who contributed to this project, making it better months after months. Special thanks to @oumad for the discussions, design ideas, docs, videos, and much more and @ChubbyQuark for the big push on the wiki which has become really helpful.