Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating docs with Maya 2024. #2998

Merged
merged 3 commits into from
Apr 3, 2023
Merged

Updating docs with Maya 2024. #2998

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe387b2
Updating docs with Maya 2024.
seando-adsk Mar 31, 2023
781ee18
Update doc/build.md
santosg87 Mar 31, 2023
886964b
Updated Ufe and Usd build info.
seando-adsk Mar 31, 2023
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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ If applicable, add screenshots, sample files, etc to help explain your problem.

**Specs (if applicable):**
- OS & version [e.g. Windows 10]
- Compiler & version [e.g. gcc 6.3.1]
- Maya version [e.g. Maya 2020]
- Compiler & version [e.g. gcc 11.2.1]
- Maya version [e.g. Maya 2024]
- Maya USD commit SHA [e.g. dev at caa921c1]
- Pixar USD commit SHA [e.g. dev at b85ddac2]

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/build-issue-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Please attach a build_log.txt

**Specs:**
- OS & version [e.g. Windows 10]
- Compiler & version [e.g. gcc 6.3.1]
- Maya version [e.g. Maya 2020]
- Compiler & version [e.g. gcc 11.2.1]
- Maya version [e.g. Maya 2024]
- Maya USD commit SHA [e.g. dev at caa921c1]
- Pixar USD commit SHA [e.g. dev at b85ddac2]

Expand Down
3 changes: 2 additions & 1 deletion README_DOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Plugin Documentation
+ [Getting Started with USD in Maya 2022](https://help.autodesk.com/view/MAYAUL/2022/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B)

+ [Getting Started with USD in Maya 2023](https://help.autodesk.com/view/MAYAUL/2023/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B)
+ [Getting Started with USD in Maya 2024](https://help.autodesk.com/view/MAYAUL/2024/ENU/?guid=GUID-36CFE2C3-766F-4B00-8464-E94F95E7AF4B)

## Core Modules
+ [Common Plug-in Base Commands](lib/mayaUsd/commands/Readme.md)
Expand Down
15 changes: 8 additions & 7 deletions doc/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ 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 | High Sierra (10.13)<br>Mojave (10.14)<br>Catalina (10.15)<br>Big Sur (11.2.x) | CentOS 7/8 |
| Compiler Requirement| Maya 2019 (VS 2017)<br>Maya 2020 (VS 2017)<br>Maya 2022 (VS 2017/2019)<br>Maya 2023 (VS 2019) | Maya 2019 (Xcode 7.3.1)<br>Maya 2020 (Xcode 10.2.1)<br>Maya 2022 (Xcode 10.2.1)<br>Maya 2023 (Xcode 10.2.1) | Maya 2019 (gcc 6.3.1)<br>Maya 2020 (gcc 6.3.1)<br>Maya 2022 (gcc 6.3.1/9.3.1)<br>Maya 2023 (gcc 9.3.1) |
| Operating System | Windows 10 | 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 |
| Compiler Requirement| Maya 2019 (VS 2017)<br>Maya 2020 (VS 2017)<br>Maya 2022 (VS 2017/2019)<br>Maya 2023 (VS 2019)<br>Maya 2024 (VS 2022) | Maya 2019 (Xcode 7.3.1)<br>Maya 2020 (Xcode 10.2.1)<br>Maya 2022 (Xcode 10.2.1)<br>Maya 2023 (Xcode 10.2.1)<br>Maya 2024 (Xcode 13.4) | Maya 2019 (gcc 6.3.1)<br>Maya 2020 (gcc 6.3.1)<br>Maya 2022 (gcc 6.3.1/9.3.1)<br>Maya 2023 (gcc 9.3.1)<br>Maya 2024 (gcc 11.2.1) |
| CMake Version (min/max) | 3.13 - 3.17 | 3.13 - 3.17 | 3.13 - 3.17 |
| Python | 2.7.15 or 3.7.7 or 3.9.7 | 2.7.15 or 3.7.7 or 3.9.7 | 2.7.15 or 3.7.7 or 3.9.7 |
| 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 or 2019 command prompt | bash | bash |
| Supported Maya Version| 2019, 2020, 2022, 2023 | 2019, 2020, 2022, 2023 | 2019, 2020, 2022, 2023 |
| Supported Maya Version| 2019, 2020, 2022, 2023, 2024 | 2019, 2020, 2022, 2023, 2024 | 2019, 2020, 2022, 2023, 2024 |

| Optional | ![](images/windows.png) | ![](images/mac.png) | ![](images/linux.png) |
|:---------------------:|:-------------------------:|:------------------------------------------------------------:|:---------------------------:|
| Qt | Maya 2019 = 5.6.1<br>Maya 2020 = 5.12.5<br>Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2 | Maya 2019 = 5.6.1<br>Maya 2020 = 5.12.5<br>Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2 | Maya 2019 = 5.6.1<br>Maya 2020 = 5.12.5<br>Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2 |
| Qt | Maya 2019 = 5.6.1<br>Maya 2020 = 5.12.5<br>Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2 | Maya 2019 = 5.6.1<br>Maya 2020 = 5.12.5<br>Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2 | Maya 2019 = 5.6.1<br>Maya 2020 = 5.12.5<br>Maya 2022 = 5.15.2<br>Maya 2023 = 5.15.2<br>Maya 2024 = 5.15.2 |

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

Expand All @@ -46,8 +46,9 @@ The Universal Front End (UFE) is a DCC-agnostic component that allows Maya to br
| 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 | Maya 2023/2023.1<br>Maya 2023.2 | https://help.autodesk.com/view/MAYAUL/2023/ENU/?guid=Maya_SDK_ufe_ref_index_html |
| v0.4.x | Maya PR | |
| v3.0.0<br>v3.2.0 | Maya 2023/2023.1<br>Maya 2023.2/2023.3 | https://help.autodesk.com/view/MAYAUL/2023/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| v4.0.0 | Maya 2024 | https://help.autodesk.com/view/MAYAUL/2024/ENU/?guid=MAYA_API_REF_ufe_ref_index_html |
| v0.5.x | Maya PR | |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maya PR uses v0.5.x? or is it supposed to be v5.0.x? Just checking because Maya 2024 is v4.0.0


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 @@ -206,7 +207,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 (2019, 2020, 2022, 2023), run:
To build USD and the Maya plug-ins on MacOS for Maya (2019, 2020, 2022, 2023, 2024), run:
```
/Applications/Autodesk/maya2019/Maya.app/Contents/bin/mayapy build_usd.py ~/Desktop/BUILD
```
Expand Down