Improve Nuke build instructions

Author: LucaScheller

CMakeLists.txt

@@ -311,11 +311,12 @@ elseif("$ENV{AR_DCC_NAME}" STREQUAL "NUKE")
     # Nuke
     set(AR_NUKE_ROOT $ENV{NUKE_ROOT} CACHE PATH "Nuke install directory")
     # Python
+    set(AR_PYTHON_ROOT $ENV{PYTHON_ROOT} CACHE PATH "Python install directory (only needed on Windows)")
     if (WIN32)
         if(EXISTS "${AR_NUKE_ROOT}/python311.dll")
             set(AR_PYTHON_LIB python311)
             set(AR_PYTHON_LIB_NUMBER python311)
-        elseif(EXISTS "${AR_MAYA_USD_SDK_LIB_DIR}/python310.dll")
+        elseif(EXISTS "${AR_NUKE_ROOT}/python310.dll")
             set(AR_PYTHON_LIB python310)
             set(AR_PYTHON_LIB_NUMBER python310)
         else()
@@ -334,7 +335,7 @@ elseif("$ENV{AR_DCC_NAME}" STREQUAL "NUKE")
     endif()
     if (WIN32)
         set(AR_PYTHON_LIB_DIR ${AR_NUKE_ROOT})
-        set(AR_PYTHON_INCLUDE_DIR ${AR_NUKE_ROOT}/include)
+        set(AR_PYTHON_INCLUDE_DIR ${AR_PYTHON_ROOT}/include)
     else()
         set(AR_PYTHON_LIB_DIR ${AR_NUKE_ROOT})
         set(AR_PYTHON_INCLUDE_DIR ${AR_NUKE_ROOT}/include/${AR_PYTHON_LIB})
@@ -345,18 +346,12 @@ elseif("$ENV{AR_DCC_NAME}" STREQUAL "NUKE")
     set(AR_TBB_LIB_DIR ${AR_NUKE_ROOT}/lib)
     set(AR_TBB_INCLUDE_DIR ${AR_TBB_ROOT}/include)
     # Usd
-    if (WIN32)
-        set(AR_PXR_LIB_DIR ${AR_NUKE_ROOT}/FnUSD/lib)
-    else()
-        set(AR_PXR_LIB_DIR ${AR_NUKE_ROOT}/FnUSD/lib)
-    endif()
+    set(AR_PXR_LIB_DIR ${AR_NUKE_ROOT}/FnUSD/lib)
     set(AR_PXR_LIB_PREFIX "usd_")
     set(AR_PXR_INCLUDE_DIR ${AR_NUKE_ROOT}/FnUSD/include)
     set(AR_PXR_PYTHON_LIB_SITEPACKAGES ${AR_NUKE_ROOT}/FnUSD/lib/python)
     # Boost
     # See our building.md Nuke section for more info on why we use foundryboost here.
-    add_compile_definitions(boost=foundryboost)
-    set(AR_BOOST_ROOT $ENV{BOOST_ROOT})
     if(EXISTS "${AR_PXR_INCLUDE_DIR}/pxr/external/boost")
         set(AR_BOOST_PXR_EXTERNAL_EXISTS 1)
         set(AR_BOOST_NAMESPACE pxr_boost)
@@ -367,6 +362,8 @@ elseif("$ENV{AR_DCC_NAME}" STREQUAL "NUKE")
         set(AR_BOOST_LIB_DIR ${AR_PXR_LIB_DIR})
         set(AR_BOOST_INCLUDE_DIR ${AR_PXR_INCLUDE_DIR})
     else()
+        add_compile_definitions(boost=foundryboost)
+        set(AR_BOOST_ROOT $ENV{BOOST_ROOT})
         set(AR_BOOST_PXR_EXTERNAL_EXISTS 0)
         set(AR_BOOST_NAMESPACE foundryboost)
         set(AR_BOOST_FOLDER_NAMESPACE foundryboost)

docs/src/installation/building.md

@@ -41,6 +41,7 @@ export AR_DCC_NAME=nuke
 export NUKE_ROOT="/path/to/nuke/root"
 export BOOST_ROOT="/path/to/boost/root" # The .../include/boost folder must be renamed to .../include/foundryboost
 export TBB_ROOT="/path/to/tbb/root"
+export PYTHON_ROOT="/path/to/python/root" # Windows only
 ## Resolver
 export AR_RESOLVER_NAME=fileResolver
 
@@ -61,6 +62,7 @@ set AR_DCC_NAME=nuke
 set NUKE_ROOT="/path/to/nuke/root"
 set BOOST_ROOT="/path/to/boost/root" # The .../include/boost folder must be renamed to .../include/foundryboost
 set TBB_ROOT="/path/to/tbb/root"
+set PYTHON_ROOT="/path/to/python/root" # Windows only
 ## Resolver
 set AR_RESOLVER_NAME=fileResolver
 ```
@@ -120,10 +122,10 @@ On Linux, we either compile it ourselves or use our system package manager to in
 
 ### Nuke
 
-Nuke has two additional requirements:
-
-- TBB: Nuke itself does not ship with the necessary TBB headers, instead only with the libs. We either have to self compile these or alternatively we can link to an existing compatible TBB header folder. We then have to specify the root folder by setting the `TBB_ROOT` env var.
-- Boost: Nuke itself does not ship with the necessary boost headers, instead only with the libs. These are namespaced (file and symbol-wise) to `foundryboost`. To successfully compile, we'll have to self-compile boost and then copy/symlink the `<root>/include/boost` folder to `<root>/include/foundryboost`. Alternatively we can copy an existing compatible boost header folder to a new location and also copy/symlink it `<root>/include/foundryboost`. This way we have identical headers for both symbols. We then have to specify the root folder by setting the `BOOST_ROOT` env var.
+Nuke has the following additional requirements:
+- Python (Windows Only): Nuke itself does not ship with the necessary python headers on Windows, instead only with the libs. We either have to self compile or alternatively link to an existing compatible python header folder. Our build script expects the root folder to by specified by the `PYTHON_ROOT` env var.
+- TBB: Nuke itself does not ship with the necessary TBB headers, instead only with the libs. We either have to self compile or alternatively link to an existing compatible TBB header folder. Our build script expects the root folder to by specified by the `TBB_ROOT` env var.
+- Boost: Nuke itself does not ship with the necessary boost headers, instead only with the libs. These are namespaced (file and symbol-wise) to `foundryboost`. To successfully compile, we'll have to self-compile boost and then copy/symlink the `<root>/include/boost` folder to `<root>/include/foundryboost`. Alternatively we can copy an existing compatible boost header folder to a new location and also copy/symlink it `<root>/include/foundryboost`. This way we have identical headers for both symbols. Our build script expects the root folder to by specified by the `BOOST_ROOT` env var.
 
 Here is the boost situation explain in more detail:
 - Nuke does not ship with boost headers