Legacy Installation and Configuration
You are following a tutorial for a legacy version of MustardUI (version 0.11 and below). If you are interested in the new version, go to Installation and Configuration.
Updated to version: 0.10.4
These are the steps to be followed in order to correctly install the UI in your model.
- Download the latest version of the UI (the mustard_ui_model_name.py file)
- Replace filename with the lowered name of the model (e.g. honoka or tifa)
- Open your model in Blender, and append the file
If this is the first time you are installing the UI, i.e. you are not updating it, follow the configuration guide, otherwise the UI will not work.
Open a text editor window in Blender, and open the mustard_ui_model_name.py (click on the book icon in the center of the upper part of the interface). Find the first lines and enter your model informations. You might also want to disable the options you wouldn't like to see in the UI or are not available in your model.
The options are
- Model version: if you use a versioning system for your model, you can put it here. If you don't, leave it blank and it won't be showed in the Information tab
- List of the outfits: in this list you can insert the list of the outfits of your model. The UI will check if they are available, and if not they won't be listed. The list of the outfit parts will be automatically generated. The "Nude" option will be automatically added. Note: when you add new outfits, remember to add them in this list!
- List of the hair styles: the same for the outfits.Note: if only one hair syle is available, the hair style selection interface won't be shown.
- List of the options: with these, you can choose which options to show in the UI. Note: enable only the options which are available on your model.
- List of the tools: with these, you can choose to enable and show the tools. Be sure to use only the ones which are compatible with your model, otherwise the UI might not run correctly.
- List of links: if you have social network accounts, you can put their link here. This wil be shown in the Link tab.
Before running the script, you must rename the objects of your model in the following way.
- The rig should be in the format "model_name + "_rig". For instance, if the model name is "Kara", the name should be "Kara_rig" (upper first letter)
- The body mesh name should be in the format "model_name + ' ' + Body". For instance, if the model name is "Honoka"
- If you want to enable the Subsurface Scattering slider, be sure that the create a Value node and connect it to the Principled BSDF node which you want to. Rename this node to be Subsurface. Note that it's NOT needed to add this value node to all Body materials, and only the ones with it will be influenced by the slider.
- If you want to enable the translucency effect slider, use the node structure in the screenshot below. Remember to rename the Value node to Translucency.
- For the Smooth correction/Subdivision Surface modifiers, there's no need to rename anything, as the UI will find all the modifiers automatically. The same goes for the Smooth Correction/Shrinkwrap modifiers of the outifits.
- The single outfit should be in a collection named as "model_name + ' ' + outfit_name", where the outfit name should be the same you put in the outfit list you wrote in the previous configuration step. The parts of the outfit should be put inside the collection and named as the collection with the addition of " ' - ' + outfit_part_name". The same name structure can be used for Armatures. For instance, if the model name is Honoka and the outfit name id School, the structure should be like
- The outfits materials should be renamed as "model_name + ' ' + outfit_name + ' ' + something_else". Remember that the outfit name should be the same you put in the outfit list you wrote in the previous configuration step.
- Similarly for the hair. Be careful about the Armature name which should not contain a '-'.
- To enable the color slider for different textures of the outfits part, use the node available on Open3DLab. Implement it as in the screenshot and rename it with "Texture Selector" inside the name. You should do this for very material of the outfit, and for every outfit which should have the slider. For instance
- To enable the tan and tan lines mechanics, add some values nodes to control your tan implementation and rename them as "Tan" and "Tan Lines". The same procedure can be applied for the "Makeup", "Runny Makeup", "Blush", "Wet", "Dirt", "Scratches".
- To enable additional options for the single outfits, just rename your shape key or the Value node in any of that part of outfit material as "MustardUI Float - " + name of the property you want to show in the UI, if the property is float, or "MustardUI Bool - " + name of the property you want to show in the UI, if the property has a Boolean value.
To start the UI, go back in the text editor (mustard_ui.py). If you want the UI to always open when you load the model, check Register. From Blender 2.83, the option to Register is in the upper Text menu. Then press on the Start button, the button with the "play" shape near the script name.
If the UI is not working, check if you made some of the most common mistakes:
- the nodes has been renamed, but in the Label field instead of the Name field. Check the correct way to name a node as in the screenshot.
- if you still have problems setting up the UI, you can contact me on Twitter or Discord.