feat: more bl_info fields, option for menu location

Author: BrendanParmer

ntp_operator.py

@@ -67,9 +67,6 @@ def __init__(self):
         # File (TextIO) or string (StringIO) the add-on/script is generated into
         self._file: TextIO = None
 
-        # Path to the current directory
-        self._dir: str = None
-
         # Path to the directory of the zip file
         self._zip_dir: str = None
 
@@ -117,14 +114,27 @@ def _write(self, string: str, indent: str = None):
         self._file.write(f"{indent}{string}\n")
 
     def _setup_options(self, options: NTPOptions) -> None:
+        # General
         self._mode = options.mode
-        self._include_imports = options.include_imports
         self._include_group_socket_values = options.include_group_socket_values
         self._should_set_dimensions = options.set_dimensions
         if bpy.app.version >= (3, 4, 0):
             self._set_unavailable_defaults = options.set_unavailable_defaults
-        self._author_name = options.author_name
-        self._version = options.version
+
+        #Script
+        if options.mode == 'SCRIPT':
+            self._include_imports = options.include_imports
+        #Addon
+        elif options.mode == 'ADDON':
+            self._dir_path = bpy.path.abspath(options.dir_path)
+            self._name_override = options.name_override
+            self._description = options.description
+            self._author_name = options.author_name
+            self._version = options.version
+            self._location = options.location
+            self._category = options.category
+            self._custom_category = options.custom_category
+            self._menu_id = options.menu_id
 
     def _setup_addon_directories(self, context: Context, nt_var: str) -> bool:
         """
@@ -137,15 +147,13 @@ def _setup_addon_directories(self, context: Context, nt_var: str) -> bool:
         Returns:
         (bool): success of addon directory setup
         """
-        # find base directory to save new addon
-        self._dir = bpy.path.abspath(context.scene.ntp_options.dir_path)
-        if not self._dir or self._dir == "":
+        if not self._dir_path or self._dir_path == "":
             self.report({'ERROR'},
                         ("NodeToPython: No save location found. Please select "
                          "one in the NodeToPython Options panel"))
             return False
 
-        self._zip_dir = os.path.join(self._dir, nt_var)
+        self._zip_dir = os.path.join(self._dir_path, nt_var)
         self._addon_dir = os.path.join(self._zip_dir, nt_var)
 
         if not os.path.exists(self._addon_dir):
@@ -163,12 +171,19 @@ def _create_header(self, name: str) -> None:
         """
 
         self._write("bl_info = {", "")
+        if self._name_override and self._name_override != "":
+            name = self._name_override
         self._write(f"\t\"name\" : {str_to_py_str(name)},", "")
+        if self._description and self._description != "":
+            self.write(f"\t\"description\" : {str_to_py_str(self._description)}," "")
         self._write(f"\t\"author\" : {str_to_py_str(self._author_name)},", "")
         self._write(f"\t\"version\" : {vec3_to_py_str(self._version)},", "")
         self._write(f"\t\"blender\" : {bpy.app.version},", "")
-        self._write("\t\"location\" : \"Object\",", "")  # TODO
-        self._write("\t\"category\" : \"Node\"", "")
+        self._write(f"\t\"location\" : {str_to_py_str(self._location)},", "")
+        category = self._category
+        if category == "Custom":
+            category = self._custom_category
+        self._write(f"\t\"category\" : {str_to_py_str(category)},", "")
         self._write("}\n", "")
         self._write("import bpy", "")
         self._write("import mathutils", "")
@@ -185,8 +200,8 @@ def _init_operator(self, idname: str, label: str) -> None:
         label (str): appearence inside Blender
         """
         self._write(f"class {self._class_name}(bpy.types.Operator):", "")
-        self._write(f"\tbl_idname = \"object.{idname}\"", "")
-        self._write(f"\tbl_label = \"{label}\"", "")
+        self._write(f"\tbl_idname = \"node.{idname}\"", "")
+        self._write(f"\tbl_label = {str_to_py_str(label)}", "")
         self._write("\tbl_options = {\'REGISTER\', \'UNDO\'}", "")
         self._write("")
 
@@ -1330,7 +1345,7 @@ def _create_register_func(self) -> None:
         """
         self._write("def register():", "")
         self._write(f"bpy.utils.register_class({self._class_name})", "\t")
-        self._write("bpy.types.VIEW3D_MT_object.append(menu_func)", "\t")
+        self._write(f"bpy.types.{self._menu_id}.append(menu_func)", "\t")
         self._write("")
 
     def _create_unregister_func(self) -> None:
@@ -1339,7 +1354,7 @@ def _create_unregister_func(self) -> None:
         """
         self._write("def unregister():", "")
         self._write(f"bpy.utils.unregister_class({self._class_name})", "\t")
-        self._write("bpy.types.VIEW3D_MT_object.remove(menu_func)", "\t")
+        self._write(f"bpy.types.{self._menu_id}.remove(menu_func)", "\t")
         self._write("")
 
     def _create_main_func(self) -> None:
@@ -1375,7 +1390,7 @@ def _report_finished(self, object: str):
         if self._mode == 'SCRIPT':
             location = "clipboard"
         else:
-            location = self._dir
+            location = self._dir_path
         self.report({'INFO'}, f"NodeToPython: Saved {object} to {location}")
 
     # ABSTRACT

options.py

@@ -42,6 +42,16 @@ class NTPOptions(bpy.types.PropertyGroup):
         description="Save location if generating an add-on",
         default = "//"
     )
+    name_override : bpy.props.StringProperty(
+        name = "Name Override",
+        description="Name used for the add-on's, default is node group name",
+        default = ""
+    )
+    description : bpy.props.StringProperty(
+        name = "Description",
+        description="Description used for the add-on",
+        default=""
+    )
     author_name : bpy.props.StringProperty(
         name = "Author",
         description = "Name used for the author/maintainer of the add-on",
@@ -52,7 +62,61 @@ class NTPOptions(bpy.types.PropertyGroup):
         description="Version of the add-on",
         default = (1, 0, 0)
     )
-
+    location: bpy.props.StringProperty(
+        name = "Location",
+        description="Location of the addon",
+        default="Node"
+    )
+    menu_id: bpy.props.StringProperty(
+        name = "Menu ID",
+        description = "Python ID of the menu you'd like to register the add-on "
+                      "to. You can find this by enabling Python tooltips "
+                      "(Preferences > Interface > Python tooltips) and "
+                      "hovering over the desired menu",
+        default="NODE_MT_add"
+    )
+    category: bpy.props.EnumProperty(
+        name = "Category",
+        items = [
+            ('Custom',          "Custom",           "Use an unofficial category"),
+            ('3D View',         "3D View",          ""),
+            ('Add Curve',       "Add Curve",        ""),
+            ('Add Mesh',        "Add Mesh",         ""),
+            ('Animation',       "Animation",        ""),
+            ('Bake',            "Bake",             ""),
+            ('Compositing',     "Compositing",      ""),
+            ('Development',     "Development",      ""),
+            ('Game Engine',     "Game Engine",      ""),
+            ('Geometry Nodes',  "Geometry Nodes",   ""),
+            ("Grease Pencil",   "Grease Pencil",    ""),
+            ('Import-Export',   "Import-Export",    ""),
+            ('Lighting',        "Lighting",         ""),
+            ('Material',        "Material",         ""),
+            ('Mesh',            "Mesh",             ""),
+            ('Modeling',        "Modeling",         ""),
+            ('Node',            "Node",             ""),
+            ('Object',          "Object",           ""),
+            ('Paint',           "Paint",            ""),
+            ('Pipeline',        "Pipeline",         ""),
+            ('Physics',         "Physics",          ""),
+            ('Render',          "Render",           ""),
+            ('Rigging',         "Rigging",          ""),
+            ('Scene',           "Scene",            ""),
+            ('Sculpt',          "Sculpt",           ""),
+            ('Sequencer',       "Sequencer",        ""),
+            ('System',          "System",           ""),
+            ('Text Editor',     "Text Editor",      ""),
+            ('Tracking',        "Tracking",         ""),
+            ('UV',              "UV",               ""),
+            ('User Interface',  "User Interface",   ""),
+        ],
+        default = 'Node'
+    )
+    custom_category: bpy.props.StringProperty(
+        name="Custom Category",
+        description="Custom category",
+        default = ""
+    )
 class NTPOptionsPanel(bpy.types.Panel):
     bl_label = "Options"
     bl_idname = "NODE_PT_ntp_options"
@@ -86,9 +150,14 @@ def draw(self, context):
             addon_options = [
                 "dir_path",
                 "author_name",
-                "version"
+                "version",
+                "location",
+                "menu_id",
+                "category"
             ]
             option_list += addon_options
+            if ntp_options.category == 'CUSTOM':
+                option_list.append("custom_category")
 
         for option in option_list:
             layout.prop(ntp_options, option)