Merge pull request #3168 from quadproduction/103-add-a-scripts-menu-definition-to-openpeype-nuke-settings

Add the scripts menu definition to nuke

openpype/hosts/nuke/startup/menu.py

@@ -1,4 +1,5 @@
 import nuke
+import os
 
 from openpype.api import Logger
 from openpype.pipeline import install_host
@@ -9,6 +10,7 @@ from openpype.hosts.nuke.api.lib import (
     WorkfileSettings,
     dirmap_file_name_filter
 )
+from openpype.settings import get_project_settings
 
 log = Logger.get_logger(__name__)
 
@@ -28,3 +30,32 @@ nuke.addOnScriptLoad(WorkfileSettings().set_context_settings)
 nuke.addFilenameFilter(dirmap_file_name_filter)
 
 log.info('Automatic syncing of write file knob to script version')
+
+
+def add_scripts_menu():
+    try:
+        from scriptsmenu import launchfornuke
+    except ImportError:
+        log.warning(
+            "Skipping studio.menu install, because "
+            "'scriptsmenu' module seems unavailable."
+        )
+        return
+
+    # load configuration of custom menu
+    project_settings = get_project_settings(os.getenv("AVALON_PROJECT"))
+    config = project_settings["nuke"]["scriptsmenu"]["definition"]
+    _menu = project_settings["nuke"]["scriptsmenu"]["name"]
+
+    if not config:
+        log.warning("Skipping studio menu, no definition found.")
+        return
+
+    # run the launcher for Maya menu
+    studio_menu = launchfornuke.main(title=_menu.title())
+
+    # apply configuration
+    studio_menu.build_from_configuration(studio_menu, config)
+
+
+add_scripts_menu()

openpype/settings/defaults/project_settings/nuke.json

@@ -15,6 +15,18 @@
             "destination-path": []
         }
     },
+    "scriptsmenu": {
+        "name": "OpenPype Tools",
+        "definition": [
+            {
+                "type": "action",
+                "sourcetype": "python",
+                "title": "OpenPype Docs",
+                "command": "import webbrowser;webbrowser.open(url='https://openpype.io/docs/artist_hosts_nuke_tut')",
+                "tooltip": "Open the OpenPype Nuke user doc page"
+            }
+        ]
+    },
     "create": {
         "CreateWriteRender": {
             "fpath_template": "{work}/renders/nuke/{subset}/{subset}.{frame}.{ext}",

openpype/settings/entities/schemas/projects_schema/schema_project_maya.json

@@ -49,7 +49,7 @@
         },
         {
             "type": "schema",
-            "name": "schema_maya_scriptsmenu"
+            "name": "schema_scriptsmenu"
         },
         {
             "type": "schema",

openpype/settings/entities/schemas/projects_schema/schema_project_nuke.json

@@ -79,6 +79,10 @@
                 }
             ]
         },
+        {
+            "type": "schema",
+            "name": "schema_scriptsmenu"
+        },
         {
             "type": "dict",
             "collapsible": true,

website/docs/admin_hosts_nuke.md

@@ -0,0 +1,14 @@
+---
+id: admin_hosts_nuke
+title: Nuke
+sidebar_label: Nuke
+---
+
+## Custom Menu
+You can add your custom tools menu into Nuke by extending definitions in **Nuke -> Scripts Menu Definition**.
+![Custom menu definition](assets/nuke-admin_scriptsmenu.png)
+
+:::note Work in progress
+This is still work in progress. Menu definition will be handled more friendly with widgets and not
+raw json.
+:::

website/sidebars.js

@@ -88,6 +88,7 @@ module.exports = {
             items: [
                 "admin_hosts_blender",
                 "admin_hosts_maya",
+                "admin_hosts_nuke",
                 "admin_hosts_resolve",
                 "admin_hosts_harmony",
                 "admin_hosts_aftereffects",