SDKK

日本語版

A Set Driven Key tool for Maya. Pose on the timeline or in the viewport, key it with one button, and manage, mirror, export, and import driven keys without opening the Graph Editor.

Description

SDKK builds and manages driven keys (SDK) from a single window.

• Setup: pick a driver, add the driven nodes, and key the current pose at the current driver value. A pose strip shows every keyed driver value, so you can scrub, move, and delete keys directly.
• I/O: export the driven keys of selected nodes (or the whole scene) to a JSON file, and import them back, even onto a character with different names.
• Mirror: copy driven keys to the opposite side by a name rule (for example _L to _R), with per-key control over inverting the driver axis and the value.
• Advanced: convert animation keyed on the timeline into driven keys.

Every operation is a single undo step, and every GUI action prints the equivalent Python command to the Script Editor.

Requirements

Item	Notes
Maya	2023 or later (Python 3.9+).
Qt.py	Bundled in vendor/ (2.0.7). Nothing to install.

Installation

In the scripts directory (easy)

1. Copy this repository into a folder named sdkk in your Maya scripts directory.

   • Windows: %USERPROFILE%\Documents\maya\scripts\sdkk
   • macOS: ~/Library/Preferences/Autodesk/maya/scripts/sdkk
   • Linux: ~/maya/scripts/sdkk

2. Restart Maya.

If you keep the folder somewhere else, add its parent directory to the Python path instead.

import sys
sys.path.insert(0, r"/path/to/parent_of_sdkk")

With the module file

1. Download sdkk-vX.Y.Z.zip from the Releases page.

2. Unzip it into your Maya modules directory, so that sdkk.mod and the sdkk folder sit side by side.

   • Windows: %USERPROFILE%\Documents\maya\modules
   • macOS: ~/Library/Preferences/Autodesk/maya/modules
   • Linux: ~/maya/modules

To keep it somewhere else, unzip it there and add that folder to MAYA_MODULE_PATH in Maya.env (Documents\maya\<version>\Maya.env on Windows). Separate several paths with ; on Windows, and with : on macOS and Linux.

MAYA_MODULE_PATH=D:\tools\sdkk_module

To use a clone of this repository instead, name the folder sdkk and add the folder itself to MAYA_MODULE_PATH. The sdkk.mod inside it puts its parent directory on the Python path.

Usage

Open the window from the Script Editor (Python tab).

import sdkk
sdkk.show()

Opening the window again closes the previous one and opens a new one.

Setup

The Setup tab creates driven keys.

1. Set the driver. Select the driver node in Maya and press + Set Selected, then choose the driver attribute: one of the nine transform attributes (TX to SZ).
2. Add the driven nodes. Select the nodes in Maya and press + Add.
3. Choose the driven attributes. Toggle the transform cells (TX to SZ) of the selected node, or use Other for any other attribute.
4. Move the driver and pose the driven nodes. Drag on the pose strip, or use the preset buttons.
5. Press the key button. It keys every enabled driven attribute of the selected rows (or the displayed node if no row is selected) at the current driver value.

Driven Edit keeps the driven nodes in their current pose while you move the driver with the strip or the presets.

The driver

The screenshots show the Japanese UI.

Transform chooses one of the nine transform attributes (TX to SZ).

Other chooses any other attribute of the node from a list that you can search.

• Control: the attribute that moves the driver when the driver cannot be moved directly, for example when a controller drives it through an input connection. Select the controller's attribute in the Channel Box and press + Set Selected next to Control (or right-click the row and choose Set from Channel Box). The pose strip and the presets then move the control by the same amount, and the keys are set at the driver value that results. Clear in the right-click menu removes the control. Choosing another driver attribute also clears it.

The driven nodes

• Click a row to edit that node's attributes below the table. Select several rows to key them together.
• Click the node name under the table to select the node in Maya.
• Transform: click a cell to enable that attribute.
• Other: pick from a list that you can search to add an attribute that is not a transform attribute.

Right-click a row for these menus. The menu on a transform cell or on an entry of the Other list has only the items that apply to that attribute.

• Reload: reads the scene again and redraws the window.
• Set Driver from Driven Keys: lists the attributes that already drive the selected nodes. Pick one to set it as the driver.
• Select Anim Curve: selects the animCurve (and blendWeighted) nodes in Maya.
• Edit Anim Curve: opens the Graph Editor with the animCurve selected and framed, ready to edit its keys.
• Remove Item: removes the node or attribute from the setup (it does not touch the scene). Available on node rows and on entries of the Other list.
• Delete Current Driver Key: deletes the keys of the current driver on that attribute.
• Delete All Keys on Attribute: deletes every driven key on that attribute, from every driver. A confirmation dialog appears first.

The pose strip

Action	Result
Left-drag	Scrubs the driver. The value snaps to a nearby key; hold Shift for steps of 0.1.
Middle-drag a key	Moves that key between its neighbours. The first and last keys can be dragged outward. Hold Shift for steps of 0.1.
Right-click a key	Delete Key removes the keys at that driver value.

A filled diamond is a key on every attribute, a hollow diamond with a dot is a key on some attributes, and the triangle is the current driver value.

History

The History menu lists the driver and driven sets you have worked with, newest first. Pick one to restore it on the Setup tab. Nodes that no longer exist are reported in the status bar.

I/O

The I/O tab exports and imports driven keys as JSON. Tools > Export Driven Key... and Tools > Import Driven Key... open the same two sections as separate windows.

Export

1. Choose Driver or Driven to say what the nodes you load are.
2. Press Load from Selection (selected nodes that have driven keys) or Load from Scene (every node that has driven keys).
3. Check the nodes to export and press Export.... The driven keys that those nodes drive (or are driven by) are written to the file.

Import

1. Press Open File... and choose a JSON file. Its driven keys are listed, and the ones that can be applied are checked.
2. Set If it exists: Replace rebuilds a driven key that already exists in the scene; Skip leaves it alone.
3. Turn on Unlock locked driven to apply to locked attributes (they are unlocked while applying and locked again afterwards).
4. Press Import.

The Status column and its tooltip explain why an item cannot be applied (for example, the node is missing, the attribute is locked, or the attribute already has another input). The scene units are switched to the file's units while importing, then restored.

Mirror

The Mirror tab copies driven keys to the opposite side by a name rule.

1. Set the rule under RULE.
   • Search and Replace: the text in node names to replace, and what to replace it with. Only driven keys whose names contain the Search text are listed. The arrow button swaps the two fields.
   • Regex: use Search as a regular expression and Replace as its replacement.
   • Invert Value: the driven attributes whose values are negated by default (for example TX).
   • Invert Driver: the driver attributes whose input axis is negated by default.
2. Under TARGETS, choose Driver or Driven, then press Load from Selection or Load from Scene.
3. Review the table. Inv Driver and Inv Value can be changed per row, and a changed flag stays with that driven key.
4. Check the rows to mirror and press Mirror. Rows that are not_mirrored or different are checked automatically.

Status	Meaning
ok	The mirrored side already matches.
not_mirrored	The mirrored node exists but has no driven key.
different	The mirrored driven key differs from the mirrored result. The tooltip shows the first differences.
missing	The mirrored driver or driven node does not exist.
blocked	The mirrored side cannot be checked (ambiguous name, type mismatch, an unreadable curve).
unmirrorable	The rule cannot be applied (for example, inverting the driver axis of a curve with step tangents).

Advanced

The Advanced tab converts animation keyed on the timeline into driven keys.

1. In Setup, set the driver and add the driven nodes.
2. Animate the driven nodes on the timeline while the driver moves through the values you want.
3. On Advanced, press Load Animation. The animated attributes of the driven nodes are listed with their key counts and driver range.
4. Check the attributes and press Convert to Driven Key. The timeline animation of the converted attributes is deleted.

The driver has to keep increasing or decreasing across the keys. A motion that returns to the same driver value cannot become a driven key, and that row is reported as an error.

Options

Option	Description
Select Node on Row Click	Clicking a row in a table selects its node in Maya.
Unlock Locked Driven on Apply	Locked driven attributes are unlocked while keys are applied, then locked again.
Language	English or 日本語. The choice is remembered.

The window size, the options, the presets, the mirror rule, and the history are saved between sessions.

Help

Help > Open Web Document Page... opens the document page in the browser. The URL is the document_url of the bundled config/document.json.

{
  "document_url": "https://example.com/sdkk"
}

To use another JSON file, set the environment variable SDKK_DOCUMENT_CONFIG to its path. A file that is named but cannot be read is not replaced by the bundled one; a warning is shown in the status bar instead. Only http and https URLs are opened.

Script

Everything the GUI does is available from Python through import sdkk.

import sdkk

# Key a driver/driven pair
sdkk.set_driven_key(
    "jaw_ctl.rotateX",
    "lip_L_jnt.translateY",
    [0.0, 15.0, 30.0],
    [0.0, -0.5, -1.5],
)

# Key the current values of several driven attributes at the driver's current value
sdkk.set_driven_keys("jaw_ctl.rotateX", ["lip_L_jnt.translateY", "lip_L_jnt.translateZ"])

# Mirror driven keys by a name rule
sdkk.mirror_driven_keys(
    ["lip_L_jnt"],
    role=1,                      # 1: the nodes are driven nodes (0: driver nodes)
    search="_L",
    replace="_R",
    invert_driven=["translateX"],
)

# Export and import
sdkk.export_driven_keys("path/to/face_sdk.json", ["jaw_ctl"])
sdkk.import_driven_keys("path/to/face_sdk.json")

# Convert timeline animation into driven keys
sdkk.convert_animation_to_driven_keys("arm_jnt.rotateZ", ["deltoid_jnt"])

# Delete driven keys, and clean up broken ones (dry run by default)
sdkk.delete_driven_keys("lip_L_jnt")
sdkk.cleanup_driven_keys()

License

MIT License

sdkk bundles Qt.py (MIT License, Copyright (c) 2016 Marcus Ottosson) in vendor/. Its license is in vendor/Qt.py.LICENSE.