Procedural modules

Module Manager

Build, configure and maintain procedural modules from the recipe bank.

ModulesBuildRebuild

Module Manager brings together the module bank and scene instances. Use it to prepare their configuration, build them and edit them from the same interface.

Open the tool

In the weSkel shelf, click the Module Manager icon.

From Python

from weSkel.src.ui import modules

modules.show_dockable(floating=True)  # Floating on first opening; Maya may restore a saved dock.
# modules.show()                      # Alternative: standalone floating window.

Overview

weSkel | Module Manager · Poseidon theme. Open the original capture ↗

Guide	Function
1 · Scene	Scene Modules lists existing Maya instances.
2 · Editor	The center follows your selection: Create Module from the bank, or the settings of the selected scene instance.
3 · Bank	Module Bank groups the modules available to create an instance.

Scene Modules

Choose an instance to display its settings in the center panel.

Scene Modules · Poseidon theme.

Guide	Function
1 · Refresh	Rescans the modules in the scene.
2 · Filters	Search by Base Name or definition; filter by Revision and Side.
3 · Instances	Shows each instance’s name, definition, revision and sides. Click a row to open its Module Instance panel.
4 · Selection	Select in Maya selects the instance root. Choosing a row in the Manager does not change the Maya selection.

Module Bank

Choose a definition to prepare a new instance.

Module Bank · Poseidon theme.

Guide	Function
1 · Filters	Search by definition and filter by Revision / Compatibility.
2 · Domain	Domain filters the list by family: Body, Facial, Extra, Cloth or Props. All includes every family.
3 · Modules	Expand a category and select a module. The center panel switches to Create Module.
4 · Description	Summarizes the selected module.

Create an instance

In Create Module mode, enter a Base Name and adjust the settings. Configuration and preview update without creating Maya nodes.

Build Module, or Build Mirrored Pair with Mirror, builds the valid plan. An invalid plan disables the button and displays the cause. The new instance appears in Scene Modules.

Instance

Module Instance mode displays an existing module. Available options depend on its definition and revision.

Module Instance · Poseidon theme.

Guide	Function
1 · Identity	Base Name, definition, Rig Profile and Instance UUID identify the instance. The badge reports Rebuild availability.
2 · Configuration	Module options and controller design. Side chooses the source side; Mirror prepares the L/R pair when supported.
3 · Preview	Module Preview represents the plan: controllers, placers and outputs, depending on the module and enabled sides.
4 · Interface	Resolved Interface, expanded here, shows the plan’s inputs and outputs: Side, Direction, Port, Channels. Read-only.
5 · Actions	Rebuild, Duplicate and Delete act on the selected instance; their effects are detailed below.

Design and display

Available settings vary by module. Colors use the Chroma picker.

Setting	Purpose
Shape / Color	Chooses the shape and color of the affected controllers.
Palette	Applies the module’s palette when one is available.
Output Color	Sets output joint colors when supported.
Controller Scale / Line Width / Hide on Playback	Adjusts controller display: size, line thickness and visibility during playback, according to supported options.

Before Build, these settings belong to the plan. On an existing instance, some apply immediately, as described below.

Edit an instance

Choose the instance in Scene Modules. The center displays its Base Name, definition, Rig Profile and settings.

Change	Application
Structural configuration	Prepares a new plan. CHANGES PENDING marks changes awaiting Rebuild.
Shape, Color, palette, Output Color	Applies immediately on a compatible instance, without an implicit Rebuild. Edits are stored in the scene.
Advanced display	Applies immediately when supported by the module; otherwise on the next Rebuild.
Base Name	Enter a new name and press Enter to rename the instance. Typing alone does not rename it.

Read the status

Status	Meaning
VALID / INVALID	The plan can be built, or needs correction. A previous preview still on screen does not validate the new plan.
SUPPORTED / LIMITED	Indicates Rebuild availability for this instance. Unavailable actions retain a diagnostic.
CHANGES PENDING	The prepared configuration differs from the built configuration.
REBUILDING… / REBUILT / REBUILD FAILED	Progress and result of the latest Rebuild for the displayed instance. On failure, read the diagnostic and its details.

Rebuild, duplicate and delete

Action	Effect
Rebuild	Reconstructs the instance from the current plan after validation. Remains available without configuration changes to rebuild with current code. Removal of affected sides, ports or configuration elements requires confirmation.
Duplicate	Requests a new Base Name, then builds an independent instance. External connections and the existing skin are not cloned.
Delete	Deletes the instance after confirmation and dependency checks. Its detached skin skeleton remains; connections between modules may block deletion.

Build, Rename, Rebuild, Duplicate and Delete clear Maya’s entire Undo history before and after execution, including on failure. Save the scene before these actions. Refresh and Select in Maya do not clear this history.