MustardUI

Changelog

Important
If the panel order is wrong in your Configuration mode (e.g. the End Configuration button is in the middle instead at the bottom), it might be that a clean reinstallation of MustardUI is necessary to fix the issue. To do so: remove the addon, restart Blender, and then reinstall it.

What's New

The most notable new feature is the Quick Setup. In a few clicks you can setup the UI on any model, without the need to go through the whole Configuration process. At the moment, Outfits, Hair and Armature (with the new automatic IK/FK snapper for models that do not have external panels such as MHX, Rigify and ARP) settings are supported, with more to come.

A new optimization which automatically excludes Collections from the scene when not used leads to a noticeable increase in performance when the models has a lot of Outfits.

Moreover, a lot of new tools to optimize the model has been added for creators, as well as general improvements on how to quickly add physics support to the outfits.

Finally, the documentation has been updated. In particular, a page with a list of all the automatic and user-triggered optimizations is available in the Wiki: https://github.com/Mustard2/MustardUI/wiki/Automatic-Optimizations

Changelog

• Feature: A new tool is available to quickly generate a MustardUI configuration without going through the whole Configuration process. This is useful to generate quick UIs on any model for the basic functions (outfits, hair, extras, armature and IK/FK functions).
• Feature: Tool to optimize Shaders (remove Image and Groups duplicates).
• Feature: Tool to select the correct Image nodes for the Texture Solid Mode in Viewport.
• Feature: Tool to optimize Shape Keys (adding a driver on the mute button based on the shape key value).
• Feature: Shape Key Morphs can now be added with a driver on their mute button.
• Feature: Outfits can now be selected directly in Configuration mode. This should make easier and more convenient to add Custom Properties or to tweak settings without having to go back and forth between user and configuration modes.
• Feature: Physics can be added to single Outfits in the Ouftits panel if the Physics UI is enabled. This is the same feature available in the Physics panel, but it add the physics to just one outfit instead of all.
• Feature: Generic IK/FK Snapper for models that are not directly supported by the UI (MHX, APR or Rigify).
• Enhancement: Armature Smart Check auto-detects "unknown" Armature type (not standard MHX, ARP or Rigify) and tries to build the Armature panel with common patterns.
• Enhancement: The Transfer Animation tool now works also on posed model (without assigned actions or NLA strips).
• Optimization: Collections are excluded from the View Layer when not used, leading to a noticeable increase in performance when Outfits/Hair/Physics are disabled.
• Optimization: Setting up the Physics for Outfits is now up to 4x faster.
• Fix: Mirror for Armature bone layers was not supporting R_/L_ or _R/_L patterns.
• Fix: Fixed missing custom property setting in Smart Check.
• Fix #361: Original hair can reappear when toggling multiple hair switchers in one outfit (by @Ckang3D).
• Fix: The order of the Menus in User and Development mode might be wrong.
• Fix: Rebind all cages might not work for Outfits whose physics has been added with the UI.
• Fix: Error when switching outfits if one physics item object is deleted from the scene.
• Fix: Update UI button might appear also in scenes where no MustardUI compatible model was available.
• Fix: Error might appear when right clicking on Collections when MustardUI was not configured.
• Fix: The Outfit optimization options were not working correctly.
• Fix: Override Physics check was not considered in the Physics Outfits Setup operator.
• Fix: Global Mask was not updated correctly.
• Fix: Extras Physics settings were not updated correctly.
• Fix (#377): Face Controller cleanup could be slow or remove the wrong driver expression in some cases.
• Fix: Many other bugs fixed.

Deprecation Notice

The addon follows the LTS support of Blender. This means that when Blender 5.2 will be released, the support for 4.2 will be dropped. We will continue to try to support older versions, but the support won't be a guaranteed as for LTS versions.

Changelog

• Feature: Tool to optimize Smooth Corrective and Mask modifiers with Vertex Mix Modifiers.
• Feature: SmartCheck option to auto-create the Vertex Weight Mix + Mask stack on the body mesh from vertex group names; or convert current Mask modifiers in Vertex Weight Mix modifiers (by @Ckang3D).
• Fix (#357): VERTEX_WEIGHT_MIX modifiers are ignored by the global mask toggle (by @Ckang3D).
• Fix: Pointer are overridden to "None" type when fixing paths.
• Fix: Presets error when a Default preset has been set.

Changelog

• Fix: Presets saved on 2026.4 could not be called in 2026.5.
• Fix (#347): Smart Check for Custom Properties not working properly with Shape Keys.
• Fix (#350): Hair Curves not shown in the Hair panel (by @Ckang3D).
• Fix (#352): Collection visibility cascade hides nested hair sub-collections on outfit switch (by @Ckang3D).

Changelog

• Fix (#345): Error when Switching outfits.

Changelog

This update brings several QoL improvements. The most notable ones are the following.

• Model selection, especially when using Viewport Model Selection. Instead of having to select the Armature each time, now any object linked to the armature will show the respective UI;
• Preset system: it has been updated with several new features and bug fixes;
• Custom properties: since the beginning, the whole CP system was very fragile especially against changes in naming of data which the CPs were pointing. In the new version, a new mechanism prevents most of the issues, making the CP more robust, especially when rebuilding them.

Breaking Changes

• Presets have been updated, as well as their data format. Thus Presets saved inside the UI or to file from previous versions are not compatible with the new version.

Changelog

• Feature: Models can be safely deleted also from the Model Selection panel.
• Feature: Assign Hair to an Outfit to automatically switch to that Hair when selecting the corresponding Outfit.
• Feature: A Preset in Morphs can be flagged as default. When using the Restore Default Values button in the Morphs panel, the value will be reset to the default morphs instead of the default morph value.
• Feature (#342): Presets can be transferred between models in the same scene with a button in the preset menu.
• Feature: Added button to revert the Body custom properties to the default value.
• Feature: Tool to rename the internal data of Objects.
• Feature: Tool to rename Images (also on disk).
• Feature: Tool to convert up to 4 gray images to a unique RGBA image to cut the VRAM allocation by 4 times for these images.
• Feature: Added button to select the Armature for the MHX panel instead of just showing a selection error.
• Enhancement: Custom Properties has been improved to keep more information about their source, to avoid many issues while Rebuilding them. This change applies only to newly added custom properties.
• Enhancement: Viewport Model Selection activates MustardUI also with meshes if they are parented to an Armature (via simple parenting, Armature modifier or ChildOf constraint). This should make the Viewport Model Selection a much more viable option to use when several models with MustardUI are available in the scene.
• UI: Revisited the Presets UI, with several improvements such as the possibility to rename the Presets or search presets in the list.
• Fix: Rebuilding Custom Properties was not deleting the invalid properties properly. Now there is an option to delete the invalid CPs which actually works.
• Fix: Rebuild Custom Property might rebuild float properties as integers instead.
• Fix: The Model Selection panel was showing the wrong selected model when Viewport Model Selection was active. Now the name of the model is shown in the name of the panel as well for convenience.
• Fix (#323): Update UI resets the Hair index to 0.
• Fix (#333): Particle Hair in Extras does not work if the name of the Modifier is different from the Particle System.
• Fix (#341): Presets can be called from the wrong category (i.e. Morphs Presets from Physics Presets files and vice-versa).
• Fix (#335): Deleting a single outfit does not delete the associated physics items.
• Fix: Reset layer visibility operator results in outfit layer out of sync with the actual bone collections.
• Fix: UpdateUI operator misses the case where the hair and its collection have the same name (MODEL_NAME Hair).
• Fix: Weird behavior of the bone collections in Extras if an item switches bones in the armature when on and off, and that item is the only one enabled.
• Fix: The name of the presets file automatically generated was always containing the first preset name instead of the selected morph.
• Fix: Hair Extras are not toggled on/off correctly.
• Fix: Some operators might be available to be called even if data were not available, leading to errors.
• Fix: Selecting an Armature in non-Viewport Selection Mode might activate the MHX panel of another model depending on which armature is selected.
• Fix: Tons of other small bug fixed.

Internal

• CI: The CI tests more LTS versions, helping catching issues with build and installation in previous versions.
• Internal: The Model Selection panel operator now supports both Viewport Model Selection and standard selection.
• Internal: Complete refactor of Presets to avoid duplicate code and simplify the addition of new ones in the future.
• Internal: Poll functions has been replaced by a single routine to avoid proliferating of different versions of the same mechanism.

Changelog

• Fix: In some rare cases, switching outfit might fail with an issue.
• Fix: The Clean Model operator might fail with a "MESH_DEFORM" does not have target error.
• Fix: In the Shrinkwrap tool, for MHX models, the rotation of the bones was not ideal. An option to correct the rotation has been added.
• Fix: The Shrinkwrap tool was not working with newer MHX models.

Changelog

Human readable version: https://www.patreon.com/posts/mustardui-2026-4-154543968

• Feature: Added the MHX panel for Diffeomorphic based models, if enabled in the Armature settings. This eliminates the necessity for the model users to install the MHX panel.
• Feature: Hair Extras can be added to the Hair panel. They work similarly to the Outfit Extras.
• Feature: Curves hair are visible in the hair list when added to the main Hair Collection.
• Feature: Added a button to enable/disable only the Smooth Corrective modifiers for Physics Items.
• Feature: Added a button to delete a Physics Item (delete the Object and all associated modifiers in the scene). Previously the physics item could only be removed from the UI.
• Feature: Reimplemented the Lips Shrinkwrap tool.
• Feature: Simplify is now modular, and Outfits and Hair can be quickly disabled with buttons near their respective tabs.
• Feature: Presets for Physics Items.
• Feature (#249): Physics can be rebound on single Outfits or single Physics Items. Advanced option should be on.
• UI: The User Interface has been updated with more modern Blender layout. This should increase usability but also make the menus more responsive (e.g. when collapsing some lists like the Outfit Extras). Please let me know if you have any feedback.
• Enhancement: Better error reporting is implemented for custom properties to debug errors with paths. See https://github.com/Mustard2/MustardUI/wiki/Troubleshooting#custom-properties-error.
• Enhancement: Hair Physics Items status can be changed also directly in the Hair panel.
• Fix (#285, #298): Clean tool deletes Outfit custom properties even if the option is off. An option has been added to control if the custom properties should be removed or not (thanks to @cl3m3c7).
• Fix (#311): Dangling modifiers might remain on the scene when cleaning Physics Items with the Clean Model tool.
• Fix: Hair Switcher Collection does not work if more than one object is in the collection.
• Fix: Armatures are not considered when using the Hair Switcher Collection.
• Fix: Simplify is not disabling the Particle Hair global settings.
• Fix: Simplify might fail if the Hair Collection is not assigned in Configuration mode.
• Fix: Enabling/disabling Physics was not preserving the Physics Items visibility status.
• Fix: Rebinding Physics Items was not rebinding collision cages.
• Fix: Tons of other small bugs fixed.
• Naming Convention: The Hair now use the same MustardUI naming convention as the Outfits to avoid confusion. The Update UI button takes care of updating the names so older models does not break.
• Deprecation: Deprecated the Auto Smooth buttons, as they were broken and useless in recent Blender versions.
• Deprecation: Curves support as an additional panel has been dropped. Now the Curves items can be added either as main Hair (in the Hair Collection) or Hair Extras (if in the Hair Extras Collection). The Update UI button takes care of updating the behavior for models already using this option.
• Deprecation: Removed the (experimental) pie menu, as it was causing issues in the addon installation and launch for some people. Possibly this will be revisited in the future, if there is interest.

Superseeds and includes #298.

Breaking Changes

• Naming Convention for Hair: Hair should now be named as "<Hair/Hair Extras Collection Name> - <Hair Name>". This is to make it exactly as Outfits and avoid confusion with the new Hair Extras implementation. A button will appear if you open models with old versions to perform an update of the names (Update UI). If skipped, it is possible tor retrigger the update once the Creator mode has been activated in the addon settings (Blender main Preferences -> Add-ons -> MustardUI), in the Developement tab.
• Curves Hair are not treated as additional Hair anymore, but as proper single Hair objects. If you want to keep the old behaviour, set up a Hair Extras collection and move the Curves objects there. A button will appear if you open models with old versions and curves in the Hair collection, to perform this operation automatically.

Changelog

• Fix: The Simplify tool was not working correctly with several armature in the scene.
• Fix: The Simplify tool might fail in some cases.

Changelog

• Fix: The Update UI button now also checks the presence of old Simplify settings, and adds the new recently introduced rewritten panel if it was already enabled in previous versions.

Changelog

• Fix: Fix error when using the Custom Properties settings with Color properties.

Changelog

• Enhancement: The Simplify tool has been completely rewritten to support new features and solve some longstanding issues.
• Feature: Float subtype and step can now be set in the custom property settings.
• Enhancement: The Version Date can now be overridden and customized with different date formats (thanks to @Ckang3D).
• Fix: An error with morph presets when using boolean values might occur.
• Fix: Fixed an issue on the outfit Mask modifiers that might be enabled/disabled erroneously if outfits with names that are substrings of others are used (thanks to @Ckang3D).

Breaking Change

The Mask modifiers are now enabled/disabled when they have the exact name of the Outfits as the modifier name. This was not what was happening previously, as if an outfit was called as a substring of another outfit's name, both would be used to determine the Mask modifier status, leading to an incorrect behaviour.

Moreover, previously you could add several outfit names to the modifier name, and the mask modifier would activate/deactivate for all those outfits. Now there is a new delimiter "|" that needs to be used in the modifier name to separate different outfit names that would share the same Mask modifier.

Changelog

• UI: Improved the Physics items list in Configuration mode. To avoid confusion, the Cloth icon now means that an Outfit has been assigned to the item.
• Fix: The Outfit Deletion operator was not working correctly. It deleted the Outfit selected in Configuration mode, and not the one in the outfit list.
• Fix: When deleting an Outfit, Mask status and Shape Key values were not reverted. Now all the masks of the deleted outfit are disabled, and the custom property values set to the default value before deletion.
• Fix: Fixed a warning when starting Blender.
• Fix: Boolean Custom Properties were rebuilt with the Rebuild Custom Properties tool as integers instead of booleans.

Changelog

• Feature: Added Creator Tool to link shape keys to active object. This can be useful when you have a main Object (e.g. the body) and you want to link other objects (e.g. outfits) shape keys that have the same name of the main one.

• Feature: Added Creator Tool to transfer single Vertex Groups from the active to the other selected Objects.

• Feature: The Morphs can now be Frozen to increase performance. This means that their shape keys and drivers will be disabled unless their values is different from 0. When Morphs are frozen, it is not possible to change their values. This option should be activated in Configuration mode before being available to the users.

• Feature: The Outfit removal tool is also available for users if Advanced Options is enabled.

• Feature: Support for single Armature Bone Collection selection (star is_solo operator). This should prevent confusion when these operators are active outside of the UI. The Reset Layer Visibility operator now also revert these star operators.

• Feature: Added a tool to transfer animation data from one armature to another.
• UI: Configuration Morph panel UI has been changed to be more intuitive in the process of adding Morphs.
• Documentation: The documentation has been improved for better readability. It has also been updated in several outdated parts.
• Fix (#272): Cleanup tool also remove dangling physics items.
• Fix (#291): Fixed an error that might occur when enabling the addon if some keymaps were not found.

Changelog

• Feature: New Morph preset panel. Presets can be used to save the values of Morphs, to be shared with others or to simplify the transfer to other models. The function takes care of checking if the Morphs are available: this means you can use presets on different models than the one where the preset was created, and only the Morphs available will be loaded neglecting the others.

• Enhancement: The Hair Physics button now is colored blue if any Hair physics is activated. This makes easier to understand if physics is enabled on any particle system without opening the whole menu.

• Enhancement: It is now possible to disable the Shape Keys and their drivers on the Outfits when they are not used. This option is disabled by default, can be switched on in the Outfit panel of Configuration mode. In some tests I got +100% performance just enabling this new option.
• UI: The optimization settings of Outfits and Hair are not hidden by default anymore under the Advanced options. They now have a dedicated section.

• Fix: Fixed the Morph default operator, which might fail in certain conditions. Also, the effects of the defaulted values is immediate, and does not require to move the camera or do another action on the software.

Changelog

• Reintroduced support for Blender 4.2, 4.3, 4.4 and 4.5