Custom Keymap Support

SpectralVectors · SpectralVectors · commit 62b1bef967a1 · 2026-01-31T13:19:59.000-05:00
diff --git a/__init__.py b/__init__.py
@@ -7,13 +7,85 @@
 from .preferences import RightMouseNavigationPreferences
 
 addon_keymaps = []
+menumodes = [
+    "Object Mode",
+    "Mesh",
+    "Curve",
+    "Armature",
+    "Metaball",
+    "Lattice",
+    "Font",
+    "Pose",
+]
+panelmodes = [
+    "Vertex Paint",
+    "Weight Paint",
+    "Image Paint",
+    "Sculpt",
+]
 classes = [
     RightMouseNavigationPreferences,
     RMN_OT_right_mouse_navigation,
     RMN_OT_toggle_cam_navigation,
 ]
 
 
+def register_keymaps(menumodes, panelmodes, keyconfig):
+    # These Modes all call standard menus
+    # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
+    # "Font", "Pose"
+    for i in menumodes:
+        for key in keyconfig.keymaps[i].keymap_items:
+            if (
+                # key.idname == "wm.call_menu"
+                key.type == "RIGHTMOUSE"
+                and key.active
+            ):
+                key.active = False
+
+    # These Modes call panels instead of menus
+    # "Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"
+    for i in panelmodes:
+        for key in keyconfig.keymaps[i].keymap_items:
+            if key.idname == "wm.call_panel" and key.type == "RIGHTMOUSE" and key.active:
+                key.active = False
+
+    # Changing the Walk Modal Map
+    for key in keyconfig.keymaps["View3D Walk Modal"].keymap_items:
+        if key.propvalue == "CANCEL" and key.type == "RIGHTMOUSE" and key.active:
+            key.active = False
+    for key in keyconfig.keymaps["View3D Walk Modal"].keymap_items:
+        if key.propvalue == "CONFIRM" and key.type == "LEFTMOUSE" and key.active:
+            key.type = "RIGHTMOUSE"
+            key.value = "RELEASE"
+
+
+def unregister_keymaps(menumodes, panelmodes, keyconfig):
+    # Reactivating menus
+    # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
+    # "Font", "Pose"
+    for i in menumodes:
+        for key in keyconfig.keymaps[i].keymap_items:
+            if key.idname == "wm.call_menu" and key.type == "RIGHTMOUSE":
+                key.active = True
+
+    # Reactivating panels
+    # "Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"
+    for i in panelmodes:
+        for key in keyconfig.keymaps[i].keymap_items:
+            if key.idname == "wm.call_panel" and key.type == "RIGHTMOUSE":
+                key.active = True
+
+    # Changing the Walk Modal Map back
+    for key in keyconfig.keymaps["View3D Walk Modal"].keymap_items:
+        if key.propvalue == "CANCEL" and key.type == "RIGHTMOUSE":
+            key.active = True
+    for key in keyconfig.keymaps["View3D Walk Modal"].keymap_items:
+        if key.propvalue == "CONFIRM" and key.type == "RIGHTMOUSE":
+            key.type = "LEFTMOUSE"
+            key.value = "PRESS"
+
+
 def register():
     if not bpy.app.background:
         for cls in classes:
@@ -47,56 +119,28 @@ def register():
         addon_keymaps.append((km, kmi))
         addon_keymaps.append((km2, kmi2))
 
-        active_kc = wm.keyconfigs.active
-
-        menumodes = [
-            "Object Mode",
-            "Mesh",
-            "Curve",
-            "Armature",
-            "Metaball",
-            "Lattice",
-            "Font",
-            "Pose",
-        ]
-        panelmodes = [
-            "Vertex Paint",
-            "Weight Paint",
-            "Image Paint",
-            "Sculpt",
-        ]
-
-        # These Modes all call standard menus
-        # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
-        # "Font", "Pose"
-        for i in menumodes:
-            for key in active_kc.keymaps[i].keymap_items:
-                if (
-                    # key.idname == "wm.call_menu"
-                    key.type == "RIGHTMOUSE"
-                    and key.active
-                ):
-                    key.active = False
-
-        # These Modes call panels instead of menus
-        # "Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"
-        for i in panelmodes:
-            for key in active_kc.keymaps[i].keymap_items:
-                if (
-                    key.idname == "wm.call_panel"
-                    and key.type == "RIGHTMOUSE"
-                    and key.active
-                ):
-                    key.active = False
-
-        # Changing the Walk Modal Map
-        for key in active_kc.keymaps["View3D Walk Modal"].keymap_items:
-            if key.propvalue == "CANCEL" and key.type == "RIGHTMOUSE" and key.active:
-                key.active = False
-        for key in active_kc.keymaps["View3D Walk Modal"].keymap_items:
-            if key.propvalue == "CONFIRM" and key.type == "LEFTMOUSE" and key.active:
-                key.type = "RIGHTMOUSE"
-                key.value = "RELEASE"
+        active_keyconfig = wm.keyconfigs.active
+        blender_keyconfig = wm.keyconfigs["Blender"]
+        user_keyconfig = wm.keyconfigs["Blender user"]
+
+        try:
+            register_keymaps(
+                menumodes=menumodes,
+                panelmodes=panelmodes,
+                keyconfig=active_keyconfig,
+            )
+        except:
+            register_keymaps(
+                menumodes=menumodes,
+                panelmodes=panelmodes,
+                keyconfig=blender_keyconfig,
+            )
+        finally:
+            register_keymaps(
+                menumodes=menumodes,
+                panelmodes=panelmodes,
+                keyconfig=user_keyconfig,
+            )
 
 
 def unregister():
@@ -105,51 +149,31 @@ def unregister():
             bpy.utils.unregister_class(cls)
 
         wm = bpy.context.window_manager
-        active_kc = wm.keyconfigs.active
-        addon_kc = wm.keyconfigs.addon
 
-        menumodes = [
-            "Object Mode",
-            "Mesh",
-            "Curve",
-            "Armature",
-            "Metaball",
-            "Lattice",
-            "Font",
-            "Pose",
-            "Node Editor",
-        ]
-        panelmodes = [
-            "Vertex Paint",
-            "Weight Paint",
-            "Image Paint",
-            "Sculpt",
-        ]
-
-        # Reactivating menus
-        # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
-        # "Font", "Pose"
-        for i in menumodes:
-            for key in active_kc.keymaps[i].keymap_items:
-                if key.idname == "wm.call_menu" and key.type == "RIGHTMOUSE":
-                    key.active = True
-
-        # Reactivating panels
-        # "Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"
-        for i in panelmodes:
-            for key in active_kc.keymaps[i].keymap_items:
-                if key.idname == "wm.call_panel" and key.type == "RIGHTMOUSE":
-                    key.active = True
-
-        # Changing the Walk Modal Map back
-        for key in active_kc.keymaps["View3D Walk Modal"].keymap_items:
-            if key.propvalue == "CANCEL" and key.type == "RIGHTMOUSE":
-                key.active = True
-        for key in active_kc.keymaps["View3D Walk Modal"].keymap_items:
-            if key.propvalue == "CONFIRM" and key.type == "RIGHTMOUSE":
-                key.type = "LEFTMOUSE"
-                key.value = "PRESS"
+        active_keyconfig = wm.keyconfigs.active
+        blender_keyconfig = wm.keyconfigs["Blender"]
+        user_keyconfig = wm.keyconfigs["Blender user"]
+
+        try:
+            unregister_keymaps(
+                menumodes=menumodes,
+                panelmodes=panelmodes,
+                keyconfig=active_keyconfig,
+            )
+        except:
+            unregister_keymaps(
+                menumodes=menumodes,
+                panelmodes=panelmodes,
+                keyconfig=blender_keyconfig,
+            )
+        finally:
+            unregister_keymaps(
+                menumodes=menumodes,
+                panelmodes=panelmodes,
+                keyconfig=user_keyconfig,
+            )
 
+        addon_kc = wm.keyconfigs.addon
         # Remove only the keymap items that this addon registered
         for km, kmi_orig in addon_keymaps:
             try:
diff --git a/blender_manifest.toml b/blender_manifest.toml
@@ -1,7 +1,7 @@
 schema_version = "1.0.0"
 
 id = "right_mouse_navigation"
-version = "2.6.0"
+version = "2.7.0"
 name = "Right Mouse Navigation"
 tagline = "Game Engine Movement and Menus"
 maintainer = "Spectral Vectors and Contributors"
diff --git a/operators.py b/operators.py
@@ -95,22 +95,20 @@ def reset_cursor():
             return {"PASS_THROUGH"}
 
     def callMenu(self, context):
-        select_mouse = context.window_manager.keyconfigs.active.preferences.select_mouse
+        wm = context.window_manager
+        blender_keyconfig = wm.keyconfigs["Blender"]
+
+        select_mouse = blender_keyconfig.preferences.select_mouse
         space_type = context.space_data.type
 
         if select_mouse == "LEFT":
             if space_type == "NODE_EDITOR":
                 node_tree = context.space_data.node_tree
                 if node_tree:
-                    if (
-                        node_tree.nodes.active is not None
-                        and node_tree.nodes.active.select
-                    ):
+                    if node_tree.nodes.active is not None and node_tree.nodes.active.select:
                         bpy.ops.wm.call_menu(name="NODE_MT_context_menu")
                     else:
-                        bpy.ops.wm.search_single_menu(
-                            "INVOKE_DEFAULT", menu_idname="NODE_MT_add"
-                        )
+                        bpy.ops.wm.search_single_menu("INVOKE_DEFAULT", menu_idname="NODE_MT_add")
             else:
                 try:
                     bpy.ops.wm.call_menu(name=self.menu_by_mode[context.mode])
@@ -157,6 +155,7 @@ def execute(self, context):
                 return {"CANCELLED"}
 
         elif space_type == "NODE_EDITOR" and enable_nodes:
+            print("In the Nodes")
             bpy.ops.view2d.pan("INVOKE_DEFAULT")
             wm = context.window_manager
             # Adding the timer and starting the loop
@@ -181,9 +180,7 @@ class RMN_OT_toggle_cam_navigation(Operator):
     bl_options = {"REGISTER", "UNDO"}
 
     def execute(self, context):
-        context.preferences.addons[
-            __package__
-        ].preferences.disable_camera_navigation = not context.preferences.addons[
-            __package__
-        ].preferences.disable_camera_navigation
+        context.preferences.addons[__package__].preferences.disable_camera_navigation = (
+            not context.preferences.addons[__package__].preferences.disable_camera_navigation
+        )
         return {"FINISHED"}
diff --git a/preferences.py b/preferences.py
@@ -36,17 +36,32 @@ def cam_lock_update(self, context):
         bpy.types.VIEW3D_HT_tool_header.remove(draw_cam_lock)
 
 
-def update_node_keymap(self, context):
-    wm = context.window_manager
-    active_kc = wm.keyconfigs.active
-    for key in active_kc.keymaps["Node Editor"].keymap_items:
+def node_keymap(keyconfig):
+    for key in keyconfig.keymaps["Node Editor"].keymap_items:
         if key.idname == "wm.call_menu" and key.type == "RIGHTMOUSE":
             key.active = not key.active
 
-    addon_kc = wm.keyconfigs.addon
-    for key in addon_kc.keymaps["Node Editor"].keymap_items:
+
+def update_node_keymap(self, context):
+    wm = context.window_manager
+    active_keyconfig = wm.keyconfigs.active
+    blender_keyconfig = wm.keyconfigs["Blender"]
+    user_keyconfig = wm.keyconfigs["Blender user"]
+
+    try:
+        node_keymap(active_keyconfig)
+    except:
+        node_keymap(blender_keyconfig)
+    finally:
+        node_keymap(user_keyconfig)
+
+    preferences = context.preferences
+    addon_prefs = preferences.addons[__package__].preferences
+    # addon_kc = wm.keyconfigs.addon
+
+    for key in user_keyconfig.keymaps["Node Editor"].keymap_items:
         if key.idname == "rmn.right_mouse_navigation" and key.type == "RIGHTMOUSE":
-            key.active = not key.active
+            key.active = addon_prefs.enable_for_node_editors
 
 
 class RightMouseNavigationPreferences(AddonPreferences):
@@ -110,7 +125,7 @@ def draw(self, context):
         row = layout.row()
         box = row.box()
         box.label(text="Navigation", icon="ORIENTATION_GIMBAL")
-        box.prop(self, "navigation_mode")
+        box.prop(self, "navigation_mode", text="Mode")
         box = row.box()
         box.label(text="Menu / Movement", icon="DRIVER_DISTANCE")
         box.prop(self, "time")
@@ -131,8 +146,9 @@ def draw(self, context):
         row = layout.row()
         box = row.box()
         box.label(text="Camera", icon="CAMERA_DATA")
-        box.prop(self, "disable_camera_navigation")
-        box.prop(self, "show_cam_lock_ui")
+        row = box.row()
+        row.prop(self, "disable_camera_navigation")
+        row.prop(self, "show_cam_lock_ui")
 
         # Keymap Customization
         import rna_keymap_ui
@@ -157,14 +173,24 @@ def draw(self, context):
         ]
 
         wm = bpy.context.window_manager
-        active_kc = wm.keyconfigs.active
+        active_keyconfig = wm.keyconfigs.active
+        blender_keyconfig = wm.keyconfigs["Blender"]
+        user_keyconfig = wm.keyconfigs["Blender user"]
 
         addon_keymaps = []
 
-        walk_km = active_kc.keymaps["View3D Walk Modal"]
+        def walk_keymaps(keyconfig):
+            walk_km = keyconfig.keymaps["View3D Walk Modal"]
+
+            for key in walk_km.keymap_items:
+                addon_keymaps.append((walk_km, key))
 
-        for key in walk_km.keymap_items:
-            addon_keymaps.append((walk_km, key))
+        try:
+            walk_keymaps(active_keyconfig)
+        except:
+            walk_keymaps(blender_keyconfig)
+        finally:
+            walk_keymaps(user_keyconfig)
 
         header, panel = layout.panel(idname="keymap", default_closed=True)
         header.label(text="Navigation Keymap")
