Documentation

Introduction

This is the main documentation of Mustard models. If you are using these models for the first time, I highly suggest to quickly go through the main points (expecially Requirements and Performance), and use the other sections as a reference when you need more information about a specific feature.

Note: Each model has a so-called Generation, which is the general set of features of the model. In general, the bigger the Generation number, the better and more updated should be the model.
If you are unsure which Generation is your model, you can check if it is available in the model list or in the old model list. If you got the model from different sources, it is likely the model is Generation 2.

Requirements

A rough estimation of the PC requirements is the following.

  • Ryzen or Intel 7000 CPU, with at least 4 cores.
  • AMD or Nvidia GPU with at least 8Gb of VRAM. If you have less VRAM and you encounter crashes on renderings, consider to downgrade the quality of the textures to 2K (see FAQs, Renderings stop with Out of Memory errors). Integrated GPUs might not even allow you to load the model in Viewport.
  • 16 Gb of RAM.
  • Free space on disk to make the swap memory do its work! Thus I advise you to work an SSD.

Software Requirements

Blender Add-ons Requirements

  • MustardUI (compulsory for models released with Blender 4.0 comaptibility or above)
    • Documentation for MustardUI is below.
    • Download
  • MHX panel (compulsory for Generation 3 models if you want to use rig features like IK/FK for limbs, etc..)
Model GenerationDiffeomorphicMHXBlender Version Required
Generation 2Compulsory 1.5.1cNot needed3.0 or above
Generation 3Optional 1.7.0 or above*Compulsory**3.5 or above
*: the installation is advised if you want to use some additional features of Diffeomorphic.
**: the IK/FK panel is only available in the MHX panel, and not in the MustardUI.

Note: remember to enable the add-ons after installing them!

If you don’t know how to install an addon, check the related Blender documentation page (or simply find a quick video googling it).

Preliminary Steps

Before using the models, be sure to check the requirements. Moreover:

  • put the textures and the model .blend file in the same folder. If for any reason the models has some pink textures, check that the textures are available in the same folder as the .blend file in a “textures” folder. You can also force Blender to search the missing textures with the operator Find Missing Files.

MustardUI and Tools

The models are using the MustardUI as main UI to change most of the model properties. Press N in the Viewport to show the panels on the right, as in the image.

Some guidance notes.

  • Properties/tools that can affect performance if activated/deactivated, are colored in red, to be more easy to spot in the text.
  • If (Advanced) is in front of a property, it will be available only if Advanced settings is enabled (see Settings panel in MustardUI).
  • If you put the mouse over any property in the MustardUI and you wait some instants, an explanation of what that propery is doing will appear.
  • If you have more MustardUI enabled models on the scene, and Viewport Model Selection is deactivated (see Settings section of the documentation), there will be an additional first panel where you can choose whose the model considered by MustardUI.

Body Properties

Morphs (if available)

Outfits

Hair

Armature

Simplify

Tools

Settings

Armature and Poses

In this section you can find some informations about the Armature and the various features of the models.

MHX Panel and FK/IK Switch

Poses

Shader

The shader available in the models is heavily optimized for Eevee, but it should work well also on Cycles. Moreover, although I tried to test the shader in different light settings, depending on the scene, the shader might need some tweaks. Some guidance notes.

  • Check the sub-surface scattering (Eevee and Cycles), as in some scenes it might be too low (the skin seems plastic) or too high (red zones on the skin). Especially in scenes with strong lights, you might need to tweak this option.
  • Tweak Normal Strength/Bump Strength/Micro Normals, especially if you are planning to render close-ups of the skin on Eevee.

Note: in some models you might need to activate Advanced options (see MustardUI – Settings section of this documentation) to see this shader properties in the Body panel.

Performance

Due to the high amount of morphs (and therefore Blender drivers) in the model, the model might be slow with default settings, especially if you plan to make an animation. The hints below will help you get decent performance during production!

  • Enable MustardUI Simplify (see Simplify in the MustardUI section).
    Alternatively, if Simplify is not available or you want to optimize the model manually, check these videos to help you tweak the performance of the model during production.
  • You can also enable, in the Render settings tab, Blender Simplify. Set Max Subdivisions to 0 (only for viewport). It is always better to disable Simplify before the final rendering.
  • Some add-ons are known to slow down the viewport when active, even if not actively used in the scene. Some of them are Wiggle bones and Spring bones. In general, it is always advised to disable all unused add-ons to reduce the probability of dealing with these issues.
  • A lot of outfits in the scene, even if disabled, can decrease viewport performance. Therefore, I advise you to delete the outfits you do not want to use in the current scene. If you want to preserve just one outfit, check the Clean Model function (check the Clean tool in the MustardUI – Settings section of this documentation).
  • If you don’t plan to use the available morphs or the face rig, you can always Clean the model (check the Clean tool in the MustardUI – Settings section of this documentation).
    Note: during clean-up, emotions and Face controls will be removed, but the standard face bones (based on weights, and colored green in viewport) will be preserved.
  • If the model crashes when rendering (Out-of-Memory errors), you can try to downgrade the textures.

Additional Useful Resources

Support and contacts

  • Check the FAQs page, maybe the problem is one of the usual ones.
  • If you think it’s a bug, report it on the #bug-report channel on Discord.

Obviously, you can also contact me if something is not a bug and the documentation is unclear.
Or just to say “hello”! 🙂