Skip to content
Merged
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
47 changes: 23 additions & 24 deletions doc/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ Before building the project, consult the following table to ensure you use the r
| Required | ![](images/windows.png) | ![](images/mac.png) | ![](images/linux.png) |
|:---------------------:|:-------------------------:|:------------------------------------------------------------:|:---------------------------:|
| Operating System | Windows 10/11 | High Sierra (10.13)<br>Mojave (10.14)<br>Catalina (10.15)<br>Big Sur (11.2.x)<br>Monterey (12.6) | CentOS 7/8<br>RHEL 8.6<br>Rocky 8.6 |
| Compiler Requirement| Maya 2022 (VS 2017/2019)<br>Maya 2023 (VS 2019)<br>Maya 2024 (VS 2022)<br>Maya 2025 (VS 2022)<br>Maya 2026 (VS 2022) | Maya 2022 (Xcode 10.2.1)<br>Maya 2023 (Xcode 10.2.1)<br>Maya 2024 (Xcode 13.4)<br>Maya 2025 (Xcode 14.3)<br>Maya 2026 (Xcode 14.3) | Maya 2022 (gcc 6.3.1/9.3.1)<br>Maya 2023 (gcc 9.3.1)<br>Maya 2024 (gcc 11.2.1)<br>Maya 2025 (gcc 11.2.1)<br>Maya 2026 (gcc 11.2.1) |
| Compiler Requirement| Maya 2022 (VS 2017/2019)<br>Maya 2023 (VS 2019)<br>Maya 2024 (VS 2022)<br>Maya 2025 (VS 2022)<br>Maya 2026 (VS 2022)<br>Maya 2027 (VS2022) | Maya 2022 (Xcode 10.2.1)<br>Maya 2023 (Xcode 10.2.1)<br>Maya 2024 (Xcode 13.4)<br>Maya 2025 (Xcode 14.3)<br>Maya 2026 (Xcode 14.3)<br>Maya 2027 (Xcode 14.3) | Maya 2022 (gcc 6.3.1/9.3.1)<br>Maya 2023 (gcc 9.3.1)<br>Maya 2024 (gcc 11.2.1)<br>Maya 2025 (gcc 11.2.1)<br>Maya 2026 (gcc 11.2.1)<br>Maya 2027 (gcc 11.2.1) |
| CMake Version (min/max) | 3.13 - 3.17 | 3.13 - 3.17 | 3.13 - 3.17 |
| Python | 2.7.15/3.7.7/3.9.7/3.10/3.11 | 2.7.15/3.7.7/3.9.7/3.10/3.11 | 2.7.15/3.7.7/3.9.7/3.10/3.11 |
| Python | 2.7.15/3.7.7/3.9.7/3.10/3.11/3.13 | 2.7.15/3.7.7/3.9.7/3.10/3.11/3.13 | 2.7.15/3.7.7/3.9.7/3.10/3.11/3.13 |
| Python Packages | PyYAML, PySide, PyOpenGL, Jinja2 | PyYAML, PySide2, PyOpenGL, Jinja2 | PyYAML, PySide, PyOpenGL, Jinja2 |
| Build generator | Visual Studio, Ninja (Recommended) | XCode, Ninja (Recommended) | Ninja (Recommended) |
| Command processor | Visual Studio X64 {2017/2019/2022} command prompt | bash | bash |
| Supported Maya Version| 2023, 2024, 2025, 2026<br>2022: builds no longer provided | 2023, 2024, 2025, 2026<br>2022: builds no longer provided | 2023, 2024, 2025, 2026<br>2022: builds no longer provided |
| Supported Maya Version| 2023, 2024, 2025, 2026, 2027<br>2022: builds no longer provided | 2023, 2024, 2025, 2026, 2027<br>2022: builds no longer provided | 2023, 2024, 2025, 2026, 2027<br>2022: builds no longer provided |

| Optional | ![](images/windows.png) | ![](images/mac.png) | ![](images/linux.png) |
|:---------------------:|:-------------------------:|:------------------------------------------------------------:|:---------------------------:|
| Qt | Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2<br>Maya 2025 = 6.5.3<br>Maya 2026 = 6.5.3 | Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2<br>Maya 2025 = 6.5.3<br>Maya 2026 = 6.5.3 | Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2<br>Maya 2025 = 6.5.3<br>Maya 2026 = 6.5.3 |
| Qt | Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2<br>Maya 2025 = 6.5.3<br>Maya 2026 = 6.5.3<br>Maya 2027 = 6.8.3 | Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2<br>Maya 2025 = 6.5.3<br>Maya 2026 = 6.5.3, Maya 2027 = 6.8.3 | Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2<br>Maya 2025 = 6.5.3<br>Maya 2026 = 6.5.3, Maya 2027 = 6.8.3 |

***NOTE:*** Visit the online Maya developer help document under ***Setting up your build environment*** for additional compiler requirements on different platforms.

Expand All @@ -31,7 +31,7 @@ See Pixar's official github page for instructions on how to build USD: https://g

| | ![](images/pxr.png) | USD version used in Maya | USD source for MayaUsd |
|:------------: |:---------------: |:------------------------:|:-------------------------:|
| CommitID/Tags | <pre>Officially supported:<br>[v21.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v21.11), [v22.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v22.11), [v23.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v23.11), [v24.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.11), [v25.05](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.05.01), [v25.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v25.11)<br><br>Other versions used:<br>[v22.05b](https://github.com/PixarAnimationStudios/USD/releases/tag/v22.05b), [v22.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v22.08)<br>[v23.02](https://github.com/PixarAnimationStudios/USD/releases/tag/v23.02), [v23.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v23.08)<br>[v24.05](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.05), [v24.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.08)<br>[v25.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v25.08) </pre> | <pre>Maya 2022 = v21.11<br>Maya 2023 = v21.11<br>Maya 2024 = v22.11<br>Maya 2025 = v23.11<br>Maya 2026 = v24.11<br> + v25.05<br><br><br></pre> | <pre>[v21.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v21.11-MayaUsd-Public)<br><br>[v22.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v22.11-MayaUsd-Public)<br>[v23.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v23.11-MayaUsd-Public)<br>[v24.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v24.11-MayaUsd-Public)<br>[v25.05-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v25.05-MayaUsd-Public)<br><br>[v25.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v25.11-MayaUsd-Public)</pre> |
| CommitID/Tags | <pre>Officially supported:<br>[v21.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v21.11), [v22.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v22.11), [v23.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v23.11), [v24.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.11), [v25.05](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.05.01), [v25.11](https://github.com/PixarAnimationStudios/USD/releases/tag/v25.11)<br><br>Other versions used:<br>[v22.05b](https://github.com/PixarAnimationStudios/USD/releases/tag/v22.05b), [v22.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v22.08), [v23.02](https://github.com/PixarAnimationStudios/USD/releases/tag/v23.02), [v23.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v23.08), [v24.05](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.05), [v24.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v24.08), [v25.08](https://github.com/PixarAnimationStudios/USD/releases/tag/v25.08) </pre> | <pre>Maya 2022 = v21.11<br>Maya 2023 = v21.11<br>Maya 2024 = v22.11<br>Maya 2025 = v23.11<br>Maya 2026 = v24.11<br> + v25.05<br>Maya 2027 = v25.11<br><br></pre> | <pre>[v21.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v21.11-MayaUsd-Public)<br><br>[v22.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v22.11-MayaUsd-Public)<br>[v23.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v23.11-MayaUsd-Public)<br>[v24.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v24.11-MayaUsd-Public)<br>[v25.05-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v25.05-MayaUsd-Public)<br>[v25.11-MayaUsd-Public](https://github.com/autodesk-forks/USD/tree/v25.11-MayaUsd-Public)<br><br></pre> |

For additional information on building Pixar USD, see the ***Additional Build Instruction*** section below.

Expand All @@ -43,14 +43,19 @@ The Universal Front End (UFE) is a DCC-agnostic component that allows Maya to br

| Ufe Version | Maya Version | Ufe Docs (external) |
|----------------------------|--------------------------------------------------------|:-------------------:|
| v1.0.0 | Maya 2019.x | |
| v1.0.0 | Maya 2020.x | |
| v2.0.0<br>v2.0.3<br>v2.1.0 | Maya 2022 <br>Maya 2022.1/2022.2/2022.3<br>Maya 2022.4 | https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=Maya_SDK_ufe_ref_index_html |
| v3.0.0<br>v3.2.0<br>v3.3.0 | Maya 2023/2023.1<br>Maya 2023.2<br>Maya 2023.3 | https://help.autodesk.com/view/MAYAUL/2023/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| v4.0.0<br>v4.1.0<br>v4.2.0 | Maya 2024<br>Maya 2024.1<br>Maya 2024.2 | https://help.autodesk.com/view/MAYAUL/2024/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| v5.0.0<br>v5.1.0<br>v5.3.0<br>v5.5.0 | Maya 2025<br>Maya 2025.1<br>Maya 2025.2<br>Maya 2025.3 | https://help.autodesk.com/view/MAYADEV/2025/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| v6.0.0<br> | Maya 2026 | https://help.autodesk.com/view/MAYADEV/2026/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| v0.7.x | Maya BETA | |
| 1.0.0 | Maya 2019.x | |
| 1.0.0 | Maya 2020.x | |
| 2.0.0<br>2.0.3<br>2.1.0 | Maya 2022 <br>Maya 2022.{1/2/3}<br>Maya 2022.4 | https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=Maya_SDK_ufe_ref_index_html |
| 3.0.0<br>3.2.0<br>3.3.0 | Maya 2023/2023.1<br>Maya 2023.2<br>Maya 2023.3 | https://help.autodesk.com/view/MAYAUL/2023/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| 4.0.0<br>4.1.0<br>4.2.0 | Maya 2024<br>Maya 2024.1<br>Maya 2024.2 | https://help.autodesk.com/view/MAYAUL/2024/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| 5.0.0<br>5.1.0<br>5.3.0<br>5.5.0 | Maya 2025<br>Maya 2025.1<br>Maya 2025.2<br>Maya 2025.3 | https://help.autodesk.com/view/MAYADEV/2025/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| 6.0.0<br>6.2.0<br>6.3.0<br>6.5.0 | Maya 2026<br>Maya 2026.1<br>Maya 2026.2<br>Maya 2026.3 | https://help.autodesk.com/view/MAYADEV/2026/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| 7.0.0 | Maya 2027 | https://help.autodesk.com/view/MAYADEV/2027/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |

| LookdevXUfe Version | Maya Version |
|----------------------------|------------------|
| 1.0.3 | Maya 2026.3 |
| 2.0.0 | Maya 2027 |

To build the project with UFE support, you will need to use the headers and libraries included in the ***Maya Devkit***:

Expand Down Expand Up @@ -139,7 +144,7 @@ CMAKE_WANT_MATERIALX_BUILD | enable building with MaterialX (experimental).

| Flag | Description |
|-------------------- |--------------------------------------------------------------------------------------------------- |
| --stages | comma-separated list of stages can also be passed to the build system. By default "clean, configure, build, install" stages are executed if this argument is not set. |
| --stages | Comma-separated list of stages can also be passed to the build system.<br>By default "clean, configure, build, install" stages are executed if this argument is not set. |

| Options | Description |
|----------- |--------------------------------------------------- |
Expand Down Expand Up @@ -212,7 +217,7 @@ Test project /Users/sabrih/Desktop/workspace/build/Debug/plugin/al

It is important to use the Python version shipped with Maya and not the system version when building USD on MacOS. Note that this is primarily an issue on MacOS, where Maya's version of Python is likely to conflict with the version provided by the system.

To build USD and the Maya plug-ins on MacOS for Maya (2022, 2023, 2024, 2025, 2026), run:
To build USD and the Maya plug-ins on MacOS for Maya (2022, 2023, 2024, 2025, 2026, 2027), run:
```
/Applications/Autodesk/maya2025/Maya.app/Contents/bin/mayapy build_usd.py ~/Desktop/BUILD
```
Expand All @@ -231,17 +236,11 @@ Use `pip list` to see the list of installed packages with your python's package
e.g
```
➜ pip list
DEPRECATION: Python 2.7 will reach the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 won't be maintained after that date. A future version of pip will drop support for Python 2.7.
Package Version
---------- -------
Jinja2 2.10
MarkupSafe 1.1.0
pip 19.1.1
PyOpenGL 3.1.0
PySide2 5.12.1
PyYAML 3.13
setuptools 39.0.1
shiboken2 5.12.1
pip 26.0.1
PyYAML 6.0.2
setuptools 80.9.0
Comment thread
santosg87 marked this conversation as resolved.
```

##### Dependencies on Linux DSOs when running tests
Expand Down