THIS PAGE IS NOW DEPRECATED. ALL INFO HERE HAS BEEN MOVED TO THE WIKI
Sections:
- Import FFXIV Model
- Language and Translation
- Bones and IK
- Rigid Bodies
- Joints
- Bone Morphs (Facial Expressions)
- Skirt
- Shaders
- Decals / Face Paint
- Miscellaneous Tools
- Export MMD Preparation
- Tex/DDS Converter
Sections:
- Import FFXIV .fbx File
- Load Sample
- Initialize MMD Struture
- TexTools 'Saved' Folder
- Anamnesis .chara File Read
- Anamnesis .chara File Apply To Model
- Color Swatches
-
Imports a FFXIV Model's .fbx file into Blender, using these paramaters:
- primary_bone_axis='X'
- secondary_bone_axis='Y'
- use_manual_orientation=True
- axis_forward='Y'
- axis_up='Z'
-
Rotates the armature 90 degrees from the origin point, and presses 'Apply all transformations' so that Blender will treat this orientation as the 'rest' position. It's Important to apply transforamtions before importing VMD animation files, as it starts using this data for keyframes.
-
Moves all 'Group' objects to an empty object called 'FFXIV Empty Groups'
-
Update all material properties:
- Fixes the alpha blend mode so that all the textures can be viewed properly (blend_method = 'HASHED')
- Turns on backface culling (use_backface_culling = True)
-
Update meshes:
- Adds the"mmd_bone_order_override" armature modifier to the FIRST mesh on n_root (as per the MMD Tools instructions)
- Renames the meshes objects to something that is more human-readable
-
Adds custom object/data properties:
-
Armature object:
- ModelRaceType (used by various functions in this addon for automating settings such as Auto-Applying the MekTools Rig)
- original_root_name (MMD Tools moves the armature to a new object called 'New MMD Model' upon converting it, so it's useful to know the original name sometimes)
-
Edit bone data: <-- This is captured to that if you change an edit bone's position you can reset the edit bone at any time
- the head bone local position
- the tail bone local position
- the matrix local position
-
Mesh data:
- ModelID - Parsed from original object name
- ModelRaceID - Parsed from original object name
- ModelNumberID - Parsed from original object name
- ModelTypeID - Parsed from original object name
- MeshPartNumber - Parsed from original object name
- original_mesh_name - Parsed from original object name
- original_material_name - Parsed from active material name
- MaterialType - Parsed from active material name
- ModelName - Parsed from FFXIV TexTools folder (if folder name found in TexTools 'Saved' Folder)
- material_filepath - Parsed from FFXIV TexTools folder (if folder name found in TexTools 'Saved' Folder)
-
- Import an example .fbx model that is included with the plugin, and applies the same transformations that Import FFXIV .fbx File does:
- AuRa Female
- Elezen Female
- Hrothgar Male
- Hyur Highlander Female
- Hyur Midlander Female
- Lalafell Female
- Miqote Female
- Roegadyn Female
- Viera Female
Useful if you need to quickly compare and diagnose your own .fbx file vs one I created for my testing, or you just need a test out each race really quickly.
Shortcut to the MMD Tools addon's Convert Model feature:
- Convert the model to an MMD Model's format adding all the properties and data needed to convert and use as a MMD Model.
- Moves your FFXIV Character's armature n_root from it's original object (your character's .fbx file name) to a new root object called 'New MMD Model'
Saved' Folder where TexTools exports all textures and models by default. Used for pulling in extra custom properties details upon .FBX Import:
- Mesh data:
- ModelName - Parsed from FFXIV TexTools folder (if folder name found in TexTools 'Saved' Folder)
- material_filepath - Parsed from FFXIV TexTools folder (if folder name found in TexTools 'Saved' Folder)
Reads the .chara file and outputs to the results to Blender's System Console:
-
DIAGNOSIS: If an armature is selected, it compares the selected armature against the .chara file to see if it has all the correct equipment attached from TexTools. Useful if you made any mistakes exporting gear out of TexTools (such as the wrong equipment)
-
Outputs the following data used for TexTools .fbx export:
- Skin Color (hex value) - Colors vary depending on the Race, Tribe and Gender of the what is in the .Chara file
- Hair Color (hex value) - Colors vary depending on the Race, Tribe and Gender of the what is in the .Chara file
- Hair Highlights Color (hex value) - If hair highlights is disabled, will output the hair color
- Iris Color (hex value)
- Lip/Fur Color: (hex value)
- Tattoo/Limbal Color: (hex value)
- Race, Tribe, Gender
- Face Model: modelID (can be copy & pasted directly to TexTools search bar)
- Hair Model: modelID (can be copy & pasted directly to TexTools search bar)
- Tail Model: modelID (can be copy & pasted directly to TexTools search bar)
- Body Gear: equipment ID (cannot parse the model variation if the model is shared in TexTools)
- Legs Gear: equipment ID (cannot parse the model variation if the model is shared in TexTools)
- Head Gear: equipment ID (cannot parse the model variation if the model is shared in TexTools)
- Hand Gear: equipment ID (cannot parse the model variation if the model is shared in TexTools)
- Feet Gear: equipment ID (cannot parse the model variation if the model is shared in TexTools)
- Earring Gear: accessory ID (cannot parse the model variation if the model is shared in TexTools)
- Necklace Gear: accessory ID (cannot parse the model variation if the model is shared in TexTools)
- Wrists Gear: accessory ID (cannot parse the model variation if the model is shared in TexTools)
- Ring Left Gear: accessory ID (cannot parse the model variation if the model is shared in TexTools)
- Ring Right Gear: accessory ID (cannot parse the model variation if the model is shared in TexTools)
Sample Video:
Desktop.2023.10.27.-.00.30.34.12.Dvr-00.00.04.000-00.02.04.199.v2.mp4
In addition to what .chara File Read does, also:
-
Applies the Facial Deformation Shape Keys (shp_brw_a, etc) to the all the meshes attached to the selected armature with a matching shape key name by setting the values to 1.0. Values are mapped in the Chara File Dictionary
-
Adds the FFXIV Race's MMD Facial Expression Bone Morphs (eye blink, smile, etc.) to the model (only works if the model has been converted to MMD Format).
-
Adds .chara file custom properties to the armature object:
- Facial Deformation ID (based on the FFXIV tribe & gender's face part selectors in-game)
- Eyes
- Eyebrows
- Mouth
- Nose
- Jaw
- Body Type IDs
- ObjectKind
- Race
- Tribe
- Gender
- Head
- Hair
- TailEarsType
- Bust
- EnableHighlights (hair)
- Equipment Gear IDs
- HeadGear
- Body
- Hands
- Legs
- Feet
- Ear (earrings)
- Neck (necklace)
- Wrists
- LeftRing
- RightRing
- Colors (hex)
- Skintone
- HairTone
- Highlights
- LimbalEyes
- REyeColor
- LipsToneFurPattern
- FacePaintColor
- Random Stuff
- SkinGloss (rgb)? I dunno.
- BustScale (x,y,z)
- FacialFeatures (Facial Checkbox flags)
- Facial Deformation ID (based on the FFXIV tribe & gender's face part selectors in-game)
Various colors displayed for the colors from the .chara file. Color Swatches are based on the FFXIV Color Hex Reference Guide.
Displays for:
- Skin - Colors vary depending on the Race, Tribe and Gender of the what is in the .Chara file
- Hair - Colors vary depending on the Race, Tribe and Gender of the what is in the .Chara file
- Hair Highlights - If hair highlights is disabled, will output the hair color
- Eyes
- Tattoo / Limbal Ring (colored circle around the Iris for Au Ra characters)
- Lips / Fur (for Hrothgar chracters)
- Facepaint
Sections:
Used to rename bones according to the Bone Dictionary table and Finger Bone Dictionary table . If bone name in 'From' match found on the selected armature, bone will be renamed to the 'To' target bone name.
Will push the Blender Bone name to the MMD Tool's PMX Japanese Bone name (found in the Bone Properties -> MMD Bone Tools panel), assuming the MMD Tools application is installed in Blender.
Swaps the MMD (PMX) Japanese and MMD (PMX) English bone names, shape key names, and material names. Useful if you're in the MMD-only workflow
Sections:
Shortcuts to the standard visibility options found on Armature -> Viewport Display panel:
- Hide/Show bones
- Hide/Show bone names
- Show bones in front of all other objects
- Display bones as:
- Octahedral
- Stick
- Envelope
- B-Bone
- Wire
- Hide/Show armature (shortcut to the MMD Tools hide/show armature button, only displayed if model has been converted to MMD Model format):
Various steps to add/remove certain bones to MMD Format. NOTE: Bones must be renamed from 'FFXIV' to 'MMD English' format for most of these to work.
Shortcut to running steps 1 to 12 in order
Shortcut to flag 'unused' bones and delete 'unused' bones. Removes any bones without any meshes attached. Useful since the standard FFXIV bone struture that is imported includes bones including ones with no meshes attached. Removing them makes the armature cleaner / easier to see in Blender
Adds the MMD 'root' and 'center' bones if they don't already exist on the model, and move the bones to the correct position while at rest pose
Adds the MMD 'groove' bone if they don't already exist on the model, and move the bones to the correct position while at rest pose
Moves the 'waist' bone to the correct position while at rest pose
Adds the special MMD 'waist_cancel_l' and 'waist_cancel_r' bones to the correct position, and sets the legs as their parent bones. These are modifiers that prevent the rest of the armature moving from the waist down. Useful for some certain MMD Models. Sometimes it's needed for VMD files, some times it is not. If there are issues with these bones, refer to the FAQ question to fix
Adds 'view_cnt' bone. Not really needed in Blender, but it's a placeholder bone useful sometimes for animating stuff in Miku Miku Dance, as some properties are keyframed to this bone.
Adjusts the standard FFXIV Bone lengths and positions to be closer to a standard MMD model. THIS IS NOT PERFECT, but it definitely helps. I still haven't figured out the exact position in order to get VMD files to animate the arms 100%. If there are issues upon importing a VMD file, refer to this FAQ question.
Adds the special MMD 'Eyes' controller bone that is used to control 'eye_L' and 'eye_r' at the same time. Applies rotation to both bones
Adds the special MMD 'arm_twist_1','arm_twist_2','arm_twist_3', 'wrist_twist_1', 'wrist_twist_2', 'wrist_twist_3' twist bones, for additional arm fine-tuneing for animations. Needed for some VMD animation files.
Adds the special MMD 'should_C','shoulder_P' bones. Needed for some VMD animation files.
Adds the standard MMD Leg/Foot IK Bones:
- leg IK_root_L
- leg IK_root_R
- leg IK_L
- leg IK_R
- toe IK_L
- toe IK_R
And also adds the special MMD Control bones (used to move the meshes in certain direction after IK is applied, since once IK is applied, you can no longer directly move the pose bone like you would with a non-IK bone):
- leg_L_D
- leg_R_D
- knee_L_D
- knee_R_D
- ankle_L_D
- ankle_R_D
- toe_L_EX
- toe_R_EX
- knee_2_L_D
- knee_2_R_D
Shortcut to the button with the same name in 'Export MMD Preparation' panel
Adds some IK to hands/arms, similar to Leg/IK. Unlike Leg/Arm IK, this one is rarely if ever used in a VMD motion file, and is recommended that you don't use it unless it is actually called for.
Adds a third finger bone (the last bone tip of a finger) to FFXIV models, since they only have 2 finger bones. Script will attempt to automatically weight paint the bones, but it is hit or miss. I'd avoid doing this unless you like weight painting manually. Ensure that the hand mesh is selected first before running this command.
Will add an extra bone tip to the breasts bones (j_mune_l, j_mune_r) to match some other similar looking MMD Models, though it is not needed in Blender. Only useful if you're planning to export to PMX format and continue rigging using PMX Editor.
Since most standard MMD Models don't have these 'double-jointed' knees, this will merge the FFXIV- 'j_asi_c_l' and 'j_asi_b_l'(or Knee_L if you've renamed the bone) bones into one, and attempt merging the weight painting into the newly merged bone. Only useful if you're planning to export to PMX format and continue rigging using PMX Editor, otherwise if you're planning on staying in Blender, stick with the double-jointed knee to avoid extra headache.
In the case of issues with the arms not moving properly or going through the body/face using VMD animation files, this attempts to adjust the should/arm/elbow bone postitions further to align with a stanard MMD Model. Sometimes it works and solves all the related arm motion problems, sometimes it doesn't. I can't seem to find a proper solution that will 100% work 100% of the time :S
Leverages the bone structure for boobs found on Genshin Impact models and applies the same 'style' to FFXIV boobs:
- j_mune_l/r renamed to j_mune_l/r_mid
- mid bone is rotated 90 degrees and pointed downwards towards
- new j_mune_l/r_top (parent bone to j_mune_l/r_mid)
- new j_mune_l/r_bot
- new j_mune_core (parent bone to the _top and _bot bones)
When combined with converting this to an MMD Model and applying Rigid Bodies from FFXIV Template + Joints from FFXIV Template, give the boobs a better looking bounce effect using MMD physics.
2023-11-22.07-29-07.mp4
Will search for any bone of the selected armature (in edit mode or pose mode) containing the search text provided
Combined with the find textbox, will rename any found bones to the new name provided
Will limit the 'replace' to only selected bones
Will add the armature's bones to the Blender's Armature -> Bone Groups panel, according to the metadata bone group dictionary. If bone name is found matched in the 'mmd_english', 'mmd_japanese', 'mmd_japaneseLR', 'blender_rigify', or 'ffxiv' columns, will add the bone to the bone group specified in the 'blender_bone_group' column
Sections:
- Visibility Shortcuts
- Active Rigid Body / Bone
- Rigid Body Search
- Bone Chain Select
- Skirt Select
- Rigid Body Transform
- Rigid Body Create
Shortcut to the hide/show button on MMD Tools
Shortcut to the hide/show button on MMD Tools
Shortcut to the hide/show button on MMD Tools
Shortcut to the enable/disable physics button on MMD Tools
Show the actively selected Rigid body's name, as well as it's connected bone's name. Clicking on the bone name will select the bone in edit mode
Searches for rigid body name(s) based on the parameters provided (starts /w, contains, ends/w)
- 'Find' will deselect all selected objects first before showing the results
- 'Find + Add' is the same as 'Find' but will append the results to the currently selected objects
- 'Trashcan' will clear the 'starts w/', 'contains', and 'ends w/' textboxes
Based on the 'active' rigid body selected's bone, will append the bone's parent's rigid bodies recursively. Useful if you want to apply change in bulk to all the rigid bodies attached to the bones
Same as 'Up', but looks for the bone's children recusively.
It does both 'Up' and 'Down' at the same time
When the skirt module is leveraged to create rigid bodies, will select all vertical skirt rigid bodies from the active selection (based on the rigid body object name 'skirt_x_y', it will select any rigid bodies that match the currently active x)
When the skirt module is leveraged to create rigid bodies, will select all horizontal skirt rigid bodies from the active selection (based on the rigid body object name 'skirt_x_y', it will select any rigid bodies that match the currently active y)
When the skirt module is leveraged to create rigid bodies, will select all rigid bodies (based on the rigid body object name 'skirt_x_y', it will select any rigid bodies that match the the name 'skirt_')
Desktop.2023.03.14.-.21.51.07.10.Dvr-00.00.01.787-00.01.17.034.mp4
Used to apply changes to ALL selected rigid bodies.
By default it will show the values on the ACTIVE rigid body.
Selecting a checkbox will apply that specific parameter to all selected rigid bodies.
Used to apply a 'gradient' change to MMD Tools' rigid bodies.
By default it will show the values on the highest parent rigid body (based on the bone structure) as the START value,with the lowest child bone's rigid body as the END value.
Selecting a checkbox will apply that specific parameter to all selected rigid bodies.
For example if there are 3 selected rigid bodies in a bone chain, with the starting value being 1, and the ending value being 2, the rigid bodies values will be:
- Rigid body 1: 1.0
- Rigid body 2: 1.5
- Rigid body 3: 2.0
Can be used when you need to edit multiple rigid bodies' shape at once, such as a skirt that is uniformly shaped at the top, but gradually gets larger and more angular at the bottom.
Same as above but applies the values to ALL selected rigid body bone chains. Since each rigid body bone chain has it's own unique start and end value, this doesn't use the 'absolute' values, but rather applies a delta value based on the inputs.
Shortcut to the MMD Tools' Rigid Body Create button:
Creates a Rigid Body skeletion based on the FFXIV general bone body structure, with all these presets created. To see the preset values applied to each bone and the values, check out the Rigid Body Dictionary
Sections:
Shortcuts to the MMD Tools show/hide joint, and show/hide joint name respectively.
When a joint is selected, will show the joint name, as well as its two associated rigid bodies. Clicking on the rigid body name will select it.
2023-11-05.12-48-13-00.00.04.938-00.00.42.664.mp4
When there are multiple rigid bodies selected, will scan the armature for all the associated joints that are connecting them and select the joints.
When there are multiple joints selected, will scan for any rigid bodies that are connected in a rigid body bone chain (see explanation) (meaning they are vertically connected) and filter the selection to ONLY these joints.
When there are multiple joints selected, will scan for any rigid bodies that are NOT connected in a rigid body bone chain (see explanation) (meaning they are horizontally connected) and filter the selection to ONLY these joints.
Used to apply bulk changes to multiple selected joints. By default, all of the fields will be populated with the currently active joint.
To apply changes, input a value to one of the properties, select the checkbox next to it and press 'OK'
Will create joints in bulk when there are 2 or more selected rigid bodies selected. **BUG: Currently only creates multiple joints when they are connected in a rigid body bone chain (meaning, it is a vertical joint). ** This is a MMD Tools bug.
Create joints in bulk where there are multiple rigid body bone chains (see explanation selected, with only joints being created between rigid bodies that have a bone parent & child relationship, with the option to create a joint for each bone chain's highest parent to a common rigid body that is shared between tham (such as selecting all the hair rigid bodies and pinning the highest rigid body in each bone chain to the "head" rigid body)
Please be aware that this means that ONLY joints will be created between a rigid body bone's parents and children, meaning that there will be NO joints created between two separate bone chains. To create joints in bulk where there is no bone parent/child relationship refer to the Create Horizontal Joints section below.
Sample video:
2023-11-01.23-57-30.mp4
Create joints in bulk where there are multiple rigid body bone chains selected, however there is no hierarchal parent/child relationship between the bones. To do this, all rigid bodies need to share a 1) a common name AND and two numbers in the same position.
Example rigid body name: skirt_0_1
- common name pattern shared on all rigid bodies: skirt_
- first number: 0
- second number 1
The search criteria (starts w/, contains, ends w/) will specify the scope of rigid bodies that need horizontal joints, will need to use the common name pattern to do so upon pressing 'find'.
Upon pressing 'Find', the search results will:
- Show ALL rigid bodies that contain that common name pattern-- this becomes the scope of rigid bodies that will create horizontal joints for
- Show (at minimum) two numbers that will indicate if eveything that shares that same number is a 'horizontal' rigid body chain. The two numbers provided will be based on a rigid body within the search scope at random
Upon selecting one of the two (or more) numbers, a box will be displayed with a **<--previous ** and next --> button on it:
These two arrows will be used to iterate through all the rigid bodies in the search scope that share that same number's position in the rigid body name. This is for testing if the correct number position is selected (either the first number or second number in this example.
'Connect ending and starting rigid body' checkbox is to determine if the starting rigid body is supposed to have a joint to the ending rigid body. If unchecked, no joint will be created between them. This is useful if the selected rigid bodies are supposed to form a full circle horizontally, or not.
Upon pressing 'OK' the horizontal joints will be created.
Sample video:
2023-11-02.00-37-33.mp4
Bone Morphs defines how much each posebone should move in order to make a facial expression.
In Blender's MMD Tools, these bone morphs are made by manually adjusting a model's pose bone's rotation on the X/Y/Z axis, or offsetting their location on the X/Y/Z axis. For example, how many degrees an eyelid bone should rotate down on the Z axis in order for a model to wink. These location/rotation offsets are then stored in a 'Bone Morph', with the value of 1 meaning that the pose bones are 100% applied, and 0 meaning 0% of it is applied (the bone is at it's original rest position).
Typically these pose bones are grouped together to make a Bone Morph. For example a 'blink' bone morph is a combination of both the left and right eyelid bones together.
The facial expressions that are commonly used by MMD animation files are referenced on this MMD Facial Expression Reference Chart. We cannot reproduce everything on the reference chart since this plugin doesn't add any 'new' data into the FFXIV model (such as adding the 'heart' eyes or the 'star' eyes, as those special shapes doesn't exist on the standard model.
Bone Morph Master List - Defines the overall list of Bone Morph 'Groups' s that are useable by each FFXIV race, as well as the japanese / english names that are used by VMD motion files for animation.
The list below contains each FFXIV Race's own list of preset pose bone offsets (from rest position) to either their location or rotation on the XYZ axis (in XYZ Euler mode):
It's worth noting that these were manually tuned by myself (it's not a conversion from FFXIV animation files, they are completely something new I created added), so there are no guarantees that they are '100% accurate' to any facial expressions that could be made in-game, there is always room for improvement here
Change the rotation mode of the facial pose bones. By default, all pose bones are rotated in quaternion (XYZ+W), which is very difficult to work with. By changing rotation mode to 'XYZ Euler', it becomes much easier to manually adjust the pose bones, in order to make your own bone morphs / facial expressions, or when adjusting the ones that come built into this plugin.
Sections:
- Generate a New Skirt Object
- Move Mesh To New Skirt Object
- Weight Paint Transfer to Mesh
- Delete FFXIV & Unused Skirt Vertex Groups
- Move Skirt Bones and Meshes to Armature
- Generate Skirt Rigid Bodies
- Generate Skirt Joints
- Vertex Group List
This will create a skirt object called 'skirt_obj' with it's own cone-shaped mesh called 'new_skirt_shape', and cone-shaped armature with all the included bones under 'new_skirt_arm'.
- The cone-shaped bones are intended to be your new skirt's bones for using leveraging MMD-style physics with rigid bodies & joints. These skirt bones will be transferred to your model's armature once this whole process is complete.
- The cone-shaped mesh will have weight painted pre-applied to the bones. This cone-shaped mesh needed in order to perform a 'weight paint transfer' to your model's skirt mesh. This cone-shaped mesh will be deleted upon completing this whole process.
2023-11-02.22-39-10.mp4
The paramaters are as follows:
- Bone Chains - Specifies the number of bone chains that will encircle the circumference of your model. For example specifying '4' will have a bone chain starting on your model's left side, back, right side, and front.
- Bone Chain Children - Specifies how many bones will be added for each bone chain from the top of the skirt to the bottom of the skirt.
- Mesh Segments - Specifies how 'round' the circumference of your skirt mesh will be. Specifying a higher number will add more verticies to the circumference your skirt. Lower numbers will make your skirt object look like it was made in Quake
- Mesh Subdivisions - Specifies how many face subdivisions should be on the cone-shaped mesh. The higher the number, more faces will be on your mesh, and the more accurate/detailed the weight painting will be.
- Top Height - Specifies the XYZ's coordinate height of the top of the skirt from 0. Ideally this should be placed where you expect the new skirt's weight painting to be transferred onto your model
- Top Radius - Specifies how large/small the top of your skirt is
- Bottom Height - Specifies the XYZ's coordinate height of the bottom of the skirt from 0.
- Bottom Radius - Specifies how large/small the bottom of your skirt is
Upon pressing 'OK', it will create the skirt_obj and remember the parameters upon the next time you press the 'OK' button. IT IS PERFECTLY FINE TO PRESS 'OK' EVEN IF YOU STILL WANT TO MAKE CHANGES because every single time you press the OK button, it will replace the current skirt_obj with a new skirt object
Will move the currently selected active object to the 'skirt_obj' object. To prevent accidentally breaking things on the armature, all the weight paint transferring occurs only on meshes that exist within the 'skirt_obj' object.
2023-11-02.23-18-44.mp4
Will transfer the weight paint from 'new_skirt_shape' to the currently selected mesh, assuming it exists in the 'skirt_obj' object.
Please note: Weight paint transfer will ONLY work if the selected mesh is as as physically close as possible to the new_skirt_shape mesh. If they are physically too far apart, the weight paint won't transfer properly.
You can see if weight paint transferred properly by scrolling through the vertex group list:
2023-11-02.23-25-05.mp4
Note: After running this, you may want to test if the weight paint was transferred properly by going into 'Pose' mode and applying some simple rotation & location bone testing. If there are any issues with weight paint transfer, you can always start over from 'Generate a New Skirt Object'
Deletes any of the FFXIV vertex groups that start with 'j_sk_', or any vertex groups that start with 'skirt_' where it's corresponding bone can't be found. This is to prevent any weight paint conflicts between the new weight painting that was applied in the previous step and the old FFXIV skirt bones.
Will move the meshes and bones contained within 'skirt_obj' object to the currently selected armature, while 'new_skirt_shape' mesh will be deleted.
The parent for all the skirt bones will be either 'lower body' (MMD English bone name),'下半身' (MMD Japanese bone name) or 'j_kosi' (FFXIV lower body bone).
2023-11-02.23-35-32.1.mp4
If you used all the above steps to create the skirt bones and successfully transferred them to your armature, this will create a rigid bodies with all with gravity/friction/size/collision group settings preapplied. By default, these settings are configured for a somewhat 'heavy' skirt.
2023-11-02.23-52-29.1.mp4
If you used all the above steps to create the skirt bones generated the rigid bodies, this will create joints with all the joint linear & angular parameteres preapplied. By default, these settings are configured for a somewhat 'heavy' skirt.
Searches for a rigid body named 'lower body','下半身' or 'j_kosi' first. If it does not exist this will not work, as the skirt's rigid bodies needs to be physically pinned to this 'lower body'.
2023-11-03.00-14-07.1.mp4
Lists all the vertex groups for the currently selected mesh. Useful when trying to see if weight painting was applied correctly while in weight painting mode.
Sections:
- Active Material
- Apply Colorset
- Glossy Shader
- Eye Catchlight Shader
- MekTools Skin Shader
- MekTools Eye Shader
- Colorsetter Shaders
- Colorsetter Gear Texture Folder
- Background Color
Shortcut to selecting the active material for a mesh.
Applies a 'Glossy BSDF' shader to a material. Once applied, the 'Roughness' skilder will be displayed, along with an 'X' button. The X button removes the shader from the active material
Adjusts the Gossy shader's roughness
Adds a 'floating' eye catchlight to the currently selected mesh that:
- uses ffxiv's built-in "catchlight_1.png" texture
- moves/floats around the eye depending on your camera angle
This works on its own, OR can be used in combination with the Mektools Eye Shader / Colorsetter Eye Shader.
If you have the MekTools Addon installed, this will automatically apply the shader to the currently selected mesh, and add a few controls so that you don't need to go to the Shader Node Editor to adjust these settings. The X button removes the shader from the active material.
Upon applying this shader, a BACKUP of the original material is stored (it is the ORIGINAL name of the material prefixed with 'backup_'. This addon also adds a 'mektools_' prefix to the material as name as well. Pressing the 'X' button deletes the 'mektools_' material and restores the original 'backup_' to the active material for this mesh.
The following controls have been added (there's still more to add, like 'Lip Color' and 'Subsurface Color', but to be honest when I played with these settings, I didn't like the look, so it's not high on my priority list.
Anyway yeah embedded within the MekTools skin shader, the following controls has been exposed into this addon's panel:
- Subsurface Scattering
- Specular
- Wet
- Roughness
If you have the MekTools Addon installed, this will automatically apply the eye shader to the currently selected mesh, and add a few controls so that you don't need to go to the Shader Node Editor to adjust these settings. The X button removes the shader from the active material.
Upon applying this shader, a BACKUP of the original material is stored (it is the ORIGINAL name of the material prefixed with 'backup_'. This addon also adds a 'mektools_' prefix to the material as name as well. Pressing the 'X' button deletes the 'mektools_' material and restores the original 'backup_' to the active material for this mesh.
- Eye Type (need to pick depending on the Character's Race/Tribe.
- Brightness
- Eye Color
Also allows user to select a different image diffuse file & catchlight image file. They're built into the MekTools addon, but you can change it if you want to.
Automatically adds the Colorsetter Shaders to the currently selected mesh, and add a few controls so that you don't need to go to the Shader Node Editor to adjust these settings. The X button removes the shader from the active material.
Upon applying this shader, a BACKUP of the original material is stored (it is the ORIGINAL name of the material prefixed with 'backup_'. This addon also adds a 'colorsetter_' prefix to the material as name as well. Pressing the 'X' button deletes the 'colorsetter_' material and restores the original 'backup_' to the active material for this mesh.
If Apply .chara To Model was used beforehand, it will automatically apply the .chara file's colors upon adding a Colorsetter Shader
Sample Video:
2023-11-23.09-11-37.mp4
Sections:
To be applied to any/all skin materials. You will know if this is the right material if the original material name contains a 'b' in between the race/gender ID 'c1101' and the material type ID '0001' such as 'c1101b0001'
The default skin textures are included in this addon, and will be automatically applied to your FFXIV model.
The skin type is detected depending on your race, tribe and gender. These details are from the Face mesh upon .fbx import and storing the details it in the armature's custom properties data.
Properties:
- Skin Color
- Mix: For Hrothgar Only. Determines how much of the fur pattern is visible.
- Fur Pattern Color: For Hrothgar Only.
- Subsurface Scattering
- Specular Mix
- Diffuse _d texture: Will automatically apply based on race/tribe/gender. NOTE: TexTools often exports the wrong Au Ra dark scales (Xaela I think?), you might need to replace the diffuse texture manually.
- Multi _s texture:
- 'skin_m' for all races except for Au Ra and Hrothgar.
- For Au Ra there are two different _s files, depending on your Gender. 'c1301b0001_s' for Male, 'c1401b0001_s' for Female.
- For Hrothgar there are 5 different _s files, each one depends on the fur pattern. Fur Pattern 'V1' texture is applied by default for Hrothgar, however if .chara file is applied beforehand, the correct fur pattern file will be applied.
- Normal _n texture: Will automatically apply based on race/tribe/gender.
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by either _d, _s, or _n. Not really needed here because this addon auto-applies the default/standard texture files.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
To be applied to the eyes material. You will know if this is the right material if the original material name ends in '_iri_a'
The default iris textures are included in this addon, and will be automatically applied to your FFXIV model.
The iris type is detected depending on your race and tribe. These details are from the Face mesh upon .fbx import and storing the details it in the armature's custom properties data.
Properties:
- Eye Color
- Mix: Determines how much of the odd eye color is applied to the left eye.
- Odd Eye Color
- Specular Decay
- Multi iri_s texture
- Normal iri_n texture
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by either _d, _s, or _n. Not really needed here because this addon auto-applies the default/standard texture files.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
To be applied to the face material. You will know if this is the right material if the original material name ends in '_fac_a'
Properties:
- Skin Color
- Subsurface Scattering
- Specular Mix
- Lip Color
- Diffuse fac_d texture
- Multi fac_s texture
- Normal fac_n texture
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by either _fac_d, _fac_s, or _fac_n.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
To be applied to eyebrows/limbal ring (Au Ra)/tattoo materials. You will know if this is the right material if the original material name ends in '_etc_a'
Properties:
- Hair Color: Eyebrow color
- Mix: ??? I forgot.
- Tattoo Color
- Limbal Ring Color
- Limbal Mix: How much of the limbal ring color is applied??? I forgot.
- Limbal Intensity: How much of an 'emissive' (glow in the dark) amount is applied
- Multi etc_s texture
- Normal etc_n texture
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by either _etc_s, or _etc_n.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
To be applied to hair materials. You will know if this is the right material if the original material name contains a 'h' in between the race/gender ID 'c1101' and the material type ID '0001' such as 'c1101h0001'
Properties:
- Hair Color
- Mix: How much of the hair highlights color is applied
- Hair Highlights Color
- Anisotrophy: ??? I dunno.
- Multi hir_s texture
- Normal hir_n texture
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by either _hir_s, or _hir_n.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
To be applied to Hrothgar / Miqote Tails only... THERE IS NO SHADER FOR AU RA TAILS. You will know if this is the right material if the original material name contains a 't' in between the race/gender ID 'c1101' and the material type ID '0001' such as 'c1101t0001'
Properties:
- Hair Color
- Hair Highlights Color
- Highlights Mix: How much of the hair highlights color is applied
- Multi etc_s texture
- Normal etc_n texture
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by either _etc_s, or _etc_n.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
Location of the FFXIV Gear's textures that you would like to apply the colorset addon's textures to. This should be set to your TexTools' gear's foldername that you have exported. Typically this would be found in the Documents\TexTools\Saved*gear type* \ gear name folder
For example on my Windows 10 PC if I would like to apply the "Diados Jacket of Fending" textures, the folder where the textures are found would be:
- C:\Users\ %userprofile%\OneDrive\Documents\TexTools\Saved\Body\Diadochos Jacket of Fending
or - C:\Users\ %userprofile%\Documents\TexTools\Saved\Body\Diadochos Jacket of Fending\
Upon pressing the button to apply it, it will automatically apply the colorset addon's material to ALL meshes that share this material. The material will be prefixed with 'colorsetter_gear_' from it's original name.
Unlike using the colorsetter addon on its own (that destroys the original material), THIS plugin will store a backup of the old material, it's original name will be prefixed with 'backup_'
In order for this to properly, you need:
- The colorset addon installed in Blender(link)
- ALL the textures files that are available (diffuse, normal, specular, multimap, colorset, etc...) exported to JPG, BMP AND DDS from TexTools. Make sure Alpha textbox (A) is also checked before export as well.
2023-11-03.21-38-30.mp4
Please note: there is BUGS with the colorset addon that may prevent some DDS colorset files to be applied. This plugin (FFXIV MMD) will roll back any changes to prevent losing your original material. To see the actual error message, attempt to use the color setter plugin manually and review the Blender Console Window.
Properties:
- Multi _m/_d/_s: texture
- Normal _n texture
- Normal (Nearest) _n texture
- Diffuse _d texture
- Specular _s texture
- Specular Mask texture: ??? I have no idea what this does.
- Search/Replace Texture:
- If an image has not been added yet , 'Search' will search for any files that match the original material's name followed by one of the suffixes in the above textures.
- If there is already an image attached, 'Replace' will search for any files in the specified folder with the exact same filename as the currently attached image and will replace them. Useful for when looking to replace the default textures with mods/upscaled textures.
Adds a background color that can be seen in renders. This is perfect for green screening/keying, as it is a uniform color and there is no gradient or shadows, and it does NOT bleed any light/color onto your scene. Pressing the 'X' button will remove the shaders.
Adds up to 4 (or possibly more in the furture) facial decals to your FFXIV models.
To use:
- You must know the decal # for the facepaint you want to apply from TexTools!
- Select the face mesh
- Push the 'Add Decal' button3
- Pick the decal .png file from the addon's built in ones, or select a .png from your harddrive
Each Decal is a grouped shader node that is shared amongst ALL models that it is applied to. For example, if you have two FFXIV models, and they both have Decal 1 appled, they will BOTH share the same decal .png file. Although the parameters that are applied (such as Base Color/Subsurface/Mix/etc...) are NOT shared, so it is something to be aware of. If you want to apply two different decals to two difference models, apply Decal 1 to the first model. and Decal 2 to the second model.
The group decal node automatically applies 'UV2' to the materials so you don't need to add it manually.
Pressing the 'X' button will remove the decal from the active material.
Parameters:
- Base Color
- Mix (Subsurface Amount)
- Subsurface Color
- Roughness
- Specular
Sections:
Rotates an object's axis by (you guessed it) 90 degrees, and then does a 'Apply All Transformations' so that this becomes the new XYZ 0,0,0
Attempted to merge two bones into one one, as well as attempts to merge the weight painting from the two bones together, but the weight painting might not be perfect and will probably still need to be fixed for any/all bones that used to leverage it.
Scans the armature for any bones that are not used by any meshes, and adds a prefix of 'unused_' to them. Please note: any bones that are identified as 'is_special' bones on the metadata bone dictionary are excluded from this
Combined the the setting above, it does exactly that.
Scans the armature for any rigid bodies that exist but it cannot find it's associated bone. This will delete these rigid bodies. Used for making sure MMD Tools doesn't crash or act weird when physics is turned on. Sometimes you delete a bone, and this happens.
Scans the armature for any joints that exist but it cannot find either of the two rigid bodies that it is supposed to be attached to. This will delete these joints. Used for making sure MMD Tools doesn't crash or act weird when physics is turned on. Sometimes you delete a rigid body, and this happens. I delete rigid bodies a lot, and this has been extremely useful to me.
Resets the bone's position to the original edit bone position that was captured upon .fbx Import in the local space
Adjusts the boobie size of pose bones 'j_mune_l' and 'j_mune_r', and adds a keyframe to frame 0 so that it (hopefully) stays that size when you import a VMD motion file. I don't know why sometimes it works, and sometimes it doesn't... If anyone wants to do some boobie research and let me know what's up, I'll try to fix it.
The scale slider should match the same settings as the FFXIV game (reference data link).
Here's the boobie math:
- scale_x = 0.92 + (bust_scale_number * 0.16)
- scale_y = 0.816 + (bust_scale_number * 0.368)
- scale_z = 0.8 + (bust_scale_number * 0.4)
Allows you to add a pre-rigged Rigify Meta-Rig to your FFXIV Model. To use, you must have the Rigify Addon installed (it's in the Blender Addon Menu but it's disabled by default. These features currently in 'research' phase, so don't expect everything to work properly.
Shortcut to adding a "Human (Meta-Rig)" from the standard menu
Will adjust the Meta-Rig's bone structure to match that of your MMD Model. Leverages the metadata dictionary to match any MMD English, MMD Japanese, MMD Japanese.LR or FFXIV bone against it's corresponding Rigify Meta-Rig bone name. Only the body has been mapped, the face will take a lot longer to figure out.
Shortcut to pressing the 'Generate Rig' button in Rigify Addon.
Note: To make everything work 'properly', I will probably need to enable/disable a bunch of stuff in the 'Advanced' section of Rigify, but again for now it's on the backburner.
If you have the MekTools Addon installed, will automatically add the MekTools rig to your selected FFXIV Model.
Tool automatically detects your character's race, tribe and gender so all you gotta do is press the button and it will automatically add the rig, as well as apply the 'armatuer deform' modifier to the MekTools rig for ALL your meshes. That's one less step for you and a lot of less rigging work
Selects the source armature from which to find & compare a source bone
Selects the target armature from which to select a target bone
Swaps the source armature & target armature. Upon pressing it, if there is a matching source armature bone from whatever is filled out on the bone textbox, it will auto-fill the 'Bone' field with the source armature's bone. Leverages the metadata dictionary to match any MMD English, MMD Japanese, MMD Japanese.LR, FFXIV, or Rigify Meta-Rig bone.
Sets the currently selected active bone in the viewport as your target bone.
Applies a 'Copy Rotation' modifier from the source bone (if there indeed is a match) to the selected target bone in the textbox.
Applies a 'Copy Rotation' modifier to the following MMD English-equivalent bones on the target armature:
- arm_L/R
- elbow_L/R
- wrist_L/R
- thumb1_L/R
- thumb2_L/R
- fore1_L/R
- fore2_L/R
- fore3_L/R
- middle1_L/R
- middle2_L/R
- middle3_L/R
- third1_L/R
- third2_L/R
- third3_L/R
- little1_L/R
- little2_L/R
- little3_L/R
Used to compare the target bone's scale against the source bone (if there indeed is a match). Useful when importing a VMD animation file and applying it to your FFXIV Model that has been converted to MMD. How to use:
- Using MMD Tools, import a MMD Model that works well with the VMD Animation file with a scale of 1.0:
Upon import, the MMD Model will look like a giant. This is FINE. All we want from the MMD Model is to know the scale difference from one of it's bones to one of the FFXIV model's bones.
- Using this addon, select the source armature (MMD Model), target armature (FFXIV Model), and target armature's bone ('neck' bone is usually a good one to use):
In the above picture, 'Z' scale is 0.042. Now we have a good scale that can be used for VMD animation. You can test it's a good scale if you take the MMD model and apply 0.042 to the X,Y, and Z scale to the MMD Armature.
We're done with the MMD Model, we just needed it for the scale number, you can delete it now if you'd like.
- Using MMD Tools, import a VMD Motion file to your FFXIV Model. Use 0.042 for scale.
All done. When you import the VMD Motion file, you should find that the animation now better closely aligns with your FFXIV Model file.
Sections:
- Auto-Fix MMD Japanese / English Bone Names
- Add Display Panels
- Sort Bone Order / Deform Tiers
- Lock Position & Rotation
- Set Fixed Axis / Local Axis
- Hide Special & Physics Bones
Fixes the MMD Japanes & English PMX Bone names (while not changing the Blender Bone Name) to their MMD Japanese equivalent. Useful so that you can import a VMD animation file using the MMD Japanese (PMX) bone name without needing to read Japanese in Blender :P.
Leverages the metadata bone group dictionary to do the PMX Bone group mapping. If Blender bone name is found matched in the 'mmd_english', 'mmd_japanese', 'mmd_japaneseLR', 'blender_rigify', or 'ffxiv' columns, will add the 'mmd_japanese' and 'mmd_english' bone name MMD Tool's PMX Japanese/English Bone name fields respectively (found in the Bone Properties -> MMD Bone Tools panel). If no match is found, and the PMX field is empty, it puts the Blender bone name verbatim so at least the MMD field is not empty and has a name.
Adds add all the bones, and vertex morphs and bone morphs to the display groups sections that you would find in Miku Miku Dance program upon .pmx export.
-
Auto Generate:
- Leverages the metadata bone group dictionary then sends this data to the populate display panels in MMD Tools.
-
Copy from Blender Bone Groups:
- It will add the Blender Bone Group names to MMD Tools' Display Panels section
Leverages the metadata bone group dictionary to sort the bone order in MMD Tools.
THIS IS VERY IMPORTANT FOR PMX EXPORT TO FOLLOW THESE STEPS IN ORDER (taken from the FAQ guide for exporting to PMX Format):
- On the MMD Tools Plugin -> Bone Order Panel -> Click on that weird square shape on the bottom
- Click on the arrow to expand the menu
- Click on Add Missing Vertex Groups from Bones
- Back in FFXIV MMD Tools Plugin, click on 'Sort Bone Order / Deform Tiers'
Leverages the metadata bone group dictionary to lock position and rotation of bones ( you can see these flags in PMX Editor). This isn't really 'required' for PMX Export, but it doesn't hurt either
Leverages the metadata bone group dictionary to set bones to either 'fixed axis' or 'local axis' ( you can see these flags in PMX Editor). This isn't really 'required' for PMX Export, but it doesn't hurt either
Leverages the metadata bone group dictionary to set bones to be hidden from the Miku Miku Dance viewport so they won't clutter your screen. ( you can see these flags in PMX Editor)
Used to batch convert .tex files to .dds files. Leverages the ffxiv-tex-converter library.
Select the input folder and press either 'tex to dds' or 'dds to tex' and it will output all .dds or .tex files from all subfolders of the input folder.
Unfortunately there are no parameters in that library to select an output folder, so instead, this tool will tell you what the output folder is upon pressing the button. Clicking on the output folder icon will open up a windows explorer window.
Blender will look like it's frozen while the textures are being converted, but the console window will keep on updating, so I suggest opening the Blender Console Window first to watch the progress/results:
Additional controls and tools for the Animation Retargeting addon. 2.1.0 or later must be installed to see these controls
Sections:
Displayed when entering 'Bone Mapping Mode' in the animation retargeting addon.
Sections:
Used for additional control while updating/adding bone mappings from source armature to target armature
Controls:
- Active bone name: Will display the bone name AND if this bone name exists on the metadata dictionary, will display a description of the bone as well in English.
- Set as Target: Set the target bone based on what is the 'active' bone on the viewport
- Target bone name: Click on it to set this bone as the active bone in the viewport (useful if all the bones are in Japanese and it's hard to know visually which bone is actually mapped)
- Find source bone: Click on it to automatically find the source bone (based on what is on the target bone field). Uses the metadata dictionary to find a bone names on the same row
- Source bone name: Click on it to set this bone as the active bone in the viewport (useful if all the bones are in Japanese and it's hard to know visually which bone is actually mapped)
- Clear The Mapping List: Wipes the entire mapping list.
Video:
2023-11-30.16-46-10.mp4
Used to bulk add bone mappings. Leverages the metadata dictionary to find a matching bone between the source armature and target armature.
'All' will look for any matching bone on the metadata dictionary on the same row, but the other groups are based on the 'animation_retargeting_group' column for bone names on the same row in the metadata dictionary.
Video:
2023-11-29.15-27-24.mp4
Sections:
Resets the source or target armature to the original rest pose.
Will look for source bones and target bones of the same name on the metadata dictionary, and if found on the same row, will apply a copy rotation modifier to the target armature's bones, as well as set the bone roll to match the source armature's bone roll. Used for automating the the rest pose position in Animation Retargeting Addon.
Controls:
-
Upper Arms:
- looks for equivalent of 'arm_L/R' bones on source armature.
- Also copies source armature's bone roll from the parent bone to target armature's parent bone to prevent any copy rotation issues.
-
Forearms:
- looks for equivalent of 'elbow_L/R' bones on source armature.
-
Wrists:
- looks for equivalent of 'wrist_L/R' bones on source armature.
-
Hands:
- looks for equivalent of 'thumb1_L/R','thumb2_L/R','fore1_L/R','fore2_L/R','fore3_L/R','middle1_L/R','middle2_L/R','middle3_L/R','third1_L/R','third2_L/R','third3_L/R','little1_L/R','little2_L/R','little3_L/R' bones on source armature.
-
Upper Legs:
- looks for equivalent of 'leg_L/R' bones on source armature.
- Also copies source armature's bone roll from the parent bone to target armature's parent bone to prevent any copy rotation issues.
-
Lower Legs:
- looks for equivalent of 'knee_L/R','knee_2_L/R' on the source armature.
- Special handling for this because most source MMD models do not have a knee_2_L/R, so if that occurs, it will reset target armature's knee_2_L/R back to rest position.
-
Feet:
- looks for equivalent of 'ankle_L/R' bones on source armature.
-
Toe:
- looks for equivalent of 'toe_L/R' bones on source armature.
-
Reset bone on Target Armature if Source Bone not found: If checked, does exactly what it says upon pressing any of the above buttons.
Video: