@@ Line 3: / Line 3: @@
 |description=This page is a hub for everything related to Modding Baldur's Gate 3. Check out the following guides to learn how to mod BG3.
 |image=Modding_resources.webp
-}}{{Modding sidebar}}
+}}{{Modding box}}{{Modding sidebar}}
-Welcome to the file setup portion of making a hair mod. For the mesh creation portion, see [[Modding:Creating Hair Mods]].
+Welcome to the file setup portion of making a hair mod. For an overview of all the steps, see [[Modding:Creating Hair Mods]].
 == Tools You'll Need ==
 * [https://github.com/ShinyHobo/BG3-Modders-Multitool BG3 Modders Multitool] (required)
-* [https://www.nexusmods.com/baldursgate3/mods/502 BG3 Mini Tool] (optional but helpful)
+* [https://bg3.wiki/wiki/Modding:BG3_Mini_Tool BG3 Mini Tool] (optional but helpful)
 * [https://www.nexusmods.com/baldursgate3/mods/437 Padme's Hair Template] (required unless you have a template from somewhere else)
 * [https://code.visualstudio.com/ VSCode] or [https://notepad-plus-plus.org/ Notepad++] (required)
@@ Line 27: / Line 27: @@
 === What are autosnapping and non autosnapping hairs? ===
-Autosnapping hairs are basically when you have an asset you want to work for more than one race/bodyshape/bodytype, but don't want to make a mesh for every single variation. So when setup to be autosnapping, you can apply one mesh to be used by multiple races/bodyshapes/bodytypes. And the game "autosnaps" them into place using a series of "sockets" that the hair is weighted to.
+{{CollapsibleOnDesktop|Autosnapping hairs are basically when you have an asset you want to work for more than one race/bodyshape/bodytype, but don't want to make a mesh for every single variation. So when setup to be autosnapping, you can apply one mesh to be used by multiple races/bodyshapes/bodytypes. And the game "autosnaps" them into place using a series of "sockets" that the hair is weighted to.
 Sometimes you may still need three autosnapping meshes, one for the shorter races, one for the default bodytype and one for the strong bodytype. However we will go through when this is needed further into the tutorial.
-Non autosnapping is when the game doesn't snap the hair into place at all. So, you have to create your hair mesh for each race/bodyshape/bodytype that you want it to be usable for. Obviously, this takes more work, but it can often give better/less crunchy results than autosnapping, and it is much easier to manually weight a non-autosnapping hair than an autosnapping hair. For instance, for personal use hairs, you might decide you only want it for one character. Then non autosnapping might be the way to go.
+Non autosnapping is when the game doesn't snap the hair into place at all. So, you have to create your hair mesh for each race/bodyshape/bodytype that you want it to be usable for. Obviously, this takes more work, but it can often give better/less crunchy results than autosnapping, and it is much easier to manually weight a non-autosnapping hair than an autosnapping hair. For instance, for personal use hairs, you might decide you only want it for one character. Then non autosnapping might be the way to go.|collapsed=Autosnapping hairs are basically when you have an asset you want to work for more than one race/bodyshape/bodytype, but don't want to make a mesh for every single variation. So when setup to be autosnapping, you can apply one mesh to be used by multiple races/bodyshapes/bodytypes. And the game "autosnaps" them into place using a series of "sockets" that the hair is weighted to.
+Sometimes you may still need three autosnapping meshes, one for the shorter races, one for the default bodytype and one for the strong bodytype. However we will go through when this is needed further into the tutorial.
+Non autosnapping is when the game doesn't snap the hair into place at all. So, you have to create your hair mesh for each race/bodyshape/bodytype that you want it to be usable for. Obviously, this takes more work, but it can often give better/less crunchy results than autosnapping, and it is much easier to manually weight a non-autosnapping hair than an autosnapping hair. For instance, for personal use hairs, you might decide you only want it for one character. Then non autosnapping might be the way to go.}}
 == Following the Template ==
@@ Line 42: / Line 46: @@
 *If using the CharacterCreationSharedVisuals method, technically five files including Races.lsx. More on that later!
+Alternatively you can follow [https://youtu.be/dNLP6Lt_zFo?si=fmRVTUYBpF00s-Uc this video] by Bububull for the file setup if you want to use the CharacterCreationAppearanceVisuals method.
 == Mods/meta.lsx ==
@@ Line 52: / Line 58: @@
 Why is it named .loca.xml? This is because if you package the Main folder (also known as your workspace folder) with multitool, it will auto convert the .loca.xml to .loca. This way, you don't have to manually do the conversions yourself. However, if you prefer to do manual conversions, change the extension to .xml only.
+You can find the _merged file at: Localization/English/custom_name_here.loca.xml.
 Change custom_name_here to a custom name. It's best to add a personalized prefix beforehand so there is no chance of your mod name clashing with another mod. For example, Padme4000 uses her username, but shortened to P4. So for Padme's viking braid hair, her .loca.xml would be called p4_viking_braid.loca.xml
@@ Line 69: / Line 77: @@
 Once you have multitool open, make sure to check the box next to Handle. Then you can click Generate for the tool to generate a new handle. Clicking on the box that has the handle inside will copy it to your clipboard so you can go to your file and paste it in.
-=== (Optional) Using mini tool to create/edit the .loca ===
+=== [https://bg3.wiki/wiki/Modding:BG3_Mini_Tool#Using_mini_tool_to_create%2Fedit_the_.loca (Optional) Using mini tool to create/edit the .loca] ===
-If you don't want to edit the .loca manually, you can use Padme's mini tool to do it for you! So currently you have to open the localization editor via the CharacterCreationAppearanceVisuals buttons, and find the open localization button in there. For the next update it will be on the main page due to many types of mods needing it.
-This is what it looks like once open:
-[[File:Locaeditor.webp|700px]]
-So first we see a Folder Path setup, if you haven't already create the folders for the .loca file. Though while we are editing it the extension is .xml
-If you want to use the tool to create your folders create a folder called Mods in the same folder as the tools exe. And put your mod folder in here. Now for the first box in the editor fill in the exact name your workspace folder has, then you can check mod folders to see if it can see them and if you don't have them click Create folders. it will create the missing folders.
-For Name Handle you want to first click Generate Unique Handle and once it has one click the Update button. Remember always click the update button. And always check your files once done just in case the tool didn't work for whatever reason or you forgot to press update. As you don't want clashing uuids/handles.
-For Display Name you want to write what you want the user to read when your asset is active. It's display name in game. For example in character creation it is the name your asset has when hovering over it. Once you have done that click the Update button.
-If you don't yet have a localization file use the Save as button
-If you already have one setup first use the Locate your localization.xml, the box above will fill in with that path. Then click Add to your mod file to add the new handle to your mod.
-Congrats you have finished setting up/using the mini tool to edit/create your localization file.
-Just remember before packing to convert the xml to .loca with lslib or if using multitool to pack your mod name the file .loca.xml for multitool to auto convert for you.
 == Hair _merged.lsf ==
@@ Line 256: / Line 242: @@
 For autosnapping hairs, we can use either CharacterCreationSharedVisuals.lsx or CharacterCreationAppearanceVisuals.lsx. For non autosnapping, use only CharacterCreationAppearanceVisuals.lsx.
-You can use Padme's mini tool to help create the CharacterCreationAppearanceVisuals.lsx file, as well as its slots. Or, alternatively, use the file in this template to do it manually.
+You can use [https://bg3.wiki/wiki/Modding:BG3_Mini_Tool Padme's mini tool] to help create the CharacterCreationAppearanceVisuals.lsx file, as well as its slots. Or, alternatively, use the file in this template to do it manually.
 Why would we want to use CharacterCreationAppearanceVisuals (CCAV) vs CharacterCreationSharedVisuals (CCSV)? Well, CCSV is a lot easier to set up, file-wise. However, it is incompatible with other mods that edit the same files. Unless you plan on using Compatibility Framework, we recommend sticking with CCAV for both types of hair.
@@ Line 262: / Line 248: @@
 '''Important note: CharacterCreationAppearanceVisuals and CharacterCreationSharedVisuals should be .lsx format, not .lsf or .lsf.lsx format. If you use .lsf.lsx format, the multitool will convert to .lsf and then the game will not know how to read them.'''
-== CharacterCreationAppearanceVisuals ==
+=== CharacterCreationAppearanceVisuals ===
          <node id="CharacterCreationAppearanceVisual">
            <attribute id="BodyShape" type="uint8" value="0" />
@@ Line 274: / Line 259: @@
          </node>
-okay let's break this down into sections:
+Okay, let's break this down into sections:
            <attribute id="BodyShape" type="uint8" value="0" />
+This line defines which body shape the hair is for.
 * 0 = Standard
 * 1 = Tall Muscular
-* for Half-Orcs even though they use Tall Muscular bodyshape this value needs to be 0
+* For Half-Orcs, even though they use Tall Muscular bodyshape, this value needs to be 0
            <attribute id="BodyType" type="uint8" value="1" />
@@ Line 287: / Line 273: @@
            <attribute id="RaceUUID" type="guid" value="0eb594cb-8820-4be6-a58d-8be7a1a98fba" />
-The template is currently set up for the race uuid being Human. You will find the other Race UUID's at the bottom of this file on my template or alternatively you can check them [[https://bg3.wiki/wiki/Modding:Race UUID|here]]
+The template is currently set up for the race uuid being Human. You will find the other Race UUID's at the bottom of this file on Padme's template or alternatively you can check them [[https://bg3.wiki/wiki/Modding:Race UUID|here]].
            <attribute id="SlotName" type="FixedString" value="Hair" />
-This tells the game you are adding the asset to a hair slot in character creation.
+This tells the game you are adding the asset to a hair slot in character creation. This is where you would change the designation if you were making a beard for example.
            <attribute id="UUID" type="guid" value="d6663db9-f572-4f81-b9a2-fcac96149abe" />
-This must be a unique uuid
+This must be a unique uuid.
            <attribute id="VisualResource" type="guid" value="d1f51daa-5fc0-446e-92d0-318c187d2ece" />
-Match the ID line in the Hairs merged file that we created
+This must match the ID line in the Hairs _merged file that we created.
-=== Using Minitool to create your CharacterCreationAppearanceVisuals ===
-If you use my mini tool you can auto create these slots with it. By opening up the tool and going to CharacterCreationAppearanceVisuals button.
-Once open it will look like this:
-[[File:Bg3 mini tool ccav.webp|700px]]
-SO first what you want to do is if you haven't already create your folders. If you haven't this tool does allow you to create the folders which it will then create in the tools directory into a folder called Mods.
-If you get stuck wondering anything at any time feel free to click the ? buttons for more information. But once ready with your folders you can choose the Bodyshape your asset is being made for.
-* Default = the default shape the race uses. In this instance Dragonborn and Half Orcs use default not other.
-* Other = the other shape they use such as the strong bodyshape
-Bodytype whether you want the asset for the Masc or Feminine body type.
-Next up is the Handle. click Generate Unique Handle or copy in the handle you made in your localisation file. Alternatively if you haven't already setup your localisation file you can use the open Localisation editor. Once ready click the button that says Update.
-Always press update once you are finished with a section.
-RaceUUID - this is the id that defines the race that asset is used for. Click on the drop down menu to get options like below:
-[[File:Ccavracedropdown.webp]]
-This list by default is only the vanilla races. The last option is the stand in example for adding custom race uuids to the list so you can use it from this part of the tool. If you add any by following the nect header section it will update when you click the list again. Sometimes may need a double click.
-Choose the race you want to use from the dropdown and then click update.
-Our next drop down menu is for the Slotname:
-[[File:Ccavslotnamedropdown.webp]]
-You might need to click twice for the whole list to show. For ours we want to choose Hair. Then click update. But the rest of that list is what else can get added via CCAV. Feel free to add custom ones to the list as well if you have managed to add any custom ones, or any I may have forgotten from the list.
-Next up is Unique UUID, for this we first want to click Generate Unique UUID and then click update.
-VisualResource if you haven't already you can generate an id for use in your merged file here. but if you have already setup your merged file copy over the uuid we used for the ID line here and then click update.
-We have now setup the file, so next if we don't have an already existing CharacterCreationAppearanceVisuals file we use Save as button. Navigate to the ModName/Public/YourShared/CharacterCreation folder and save your file.
-If you already have a file use the locate your CharacterCreationAppearanceVisuals.lsx button and navitagte to your file. Once setup the bottom box will change to your path. Now you can click Add to your mod file if you want to add new slots to an already existing file.
-Congrats you have made your CharacterCreationAppearanceVisuals with the mini tool.
-=== Adding modded races to the Minitool CCAV option ===
-If wanting to use the one slot creation of the mini tool you can add custom races to the Races.txt found in the LSX Files folder that comes with the tool. It uses the files in this folder for the tool. So you might want to backup this folder before editing just in case of any mistakes.
-When you open the Races.txt you will be met with this:
- RaceUUID so you can quickly replace the above with your desired race
- 	Drow: 4f5d1434-5175-4fa9-b7dc-ab24fba37929
- 	Dwarf: 0ab2874d-cfdc-405e-8a97-d37bfbb23c52
- 	Elf: 6c038dcb-7eb5-431d-84f8-cecfaf1c0c5a
- 	Githyanki: bdf9b779-002c-4077-b377-8ea7c1faa795
- 	Gnome: f1b3f884-4029-4f0f-b158-1f9fe0ae5a0d
- 	HalfElf/Drow: 45f4ac10-3c89-4fb2-b37d-f973bb9110c0
- 	Halfling: 78cd3bcc-1c43-4a2a-aa80-c34322c16a04
- 	Human: 0eb594cb-8820-4be6-a58d-8be7a1a98fba
- 	Tiefling: b6dccbed-30f3-424b-a181-c4540cf38197
- 	Dragonborn: 9c61a74a-20df-4119-89c5-d996956b6c66
- 	Half-Orc: 5c39a726-71c8-4748-ba8d-f768b3c11a91
- Modded Races
- 	Race Name: 00000000-0000-0000-0000-000000000000
- To add a new race to the list add them like above. Name of the race and then colon and the RaceUUID
-The top lines you might recognise as the uuids from the bottom of the CharacterCreationAppearanceVisuals in my template. This is because the way I set it up is it reads first the name and anything that follows after the : should be the race uuid.
-So to add custom races you can add them under Modded Races, you can add them to the top list as well as I just separated them for ease of use.
-So you would follow the same format and type the name you want to show up in the dropdown menu and followed straight by a : and then space and then the UUID for your/that custom race.
-=== Minitool 32 CCAV Entries all at Once option ===
-So if making a hair for all races and you would prefer using the CCAV file you can use the 32 CCAV Entries all at Once option to add them all at once to the 32 entries needed to add them to vanilla races that use hairs. So all minus Dragonborn.
-When that is open it looks like this:
-[[File:Ccav32entries.webp|500px]]
-SO first what you want to do is click Generate Unique Handle or copy in the handle you made in your localisation file and once in click the button that says Update.
-Always press update once you are finished with a section.
-You will notice this is missing a few things from the CharacterCreationAppearanceVisuals part of the tool. That is because it is already setup for all the races. So we don't need that dropdown menu here.
-In the Name section add the name for your asset, this will add a comment to your file so you can better find it when needing to. Press update when your name for your asset is filled in.
-Slotname works just like the other file.
-[[File:Ccavslotnamedropdown.webp]]
-You might need to click twice for the whole list to show. For ours we want to choose Hair. Then click update. But the rest of that list is what else can get added via CCAV. Feel free to add custom ones to the list as well if you have managed to add any custom ones, or any I may have forgotten from the list.
-VisualResource in your assets merged copy over the uuid we used for the ID line here and then click update.
-Next click Generate Unique UUIDs this will change every instance of the UniqueUUID line to a unique uuid for each slot. No repeats.
-We have now setup the file, so next if we don't have an already existing CharacterCreationAppearanceVisuals file we use Save as button. Navigate to the ModName/Public/YourShared/CharacterCreation folder and save your file.
-If you already have a file use the locate your CharacterCreationAppearanceVisuals.lsx button and navitagte to your file. Once setup the bottom box will change to your path. Now you can click Add to your mod file if you want to add new slots to an already existing file.
-Congrats you have made your CharacterCreationAppearanceVisuals with the mini tool for all 32 vanilla slots.
-=== Adding modded races to the Minitool 32 CCAV Entries all at Once option ===
-If you want to add custom/modded races to the 32 slot option, it is possible all you need to do is go to the LSX Files folder included with the tool (make sure to make a backup folder just in case) and edit CharacterCreationAppearanceVisuals_ForAll.lsx
-In here you will find comments such as <!-- Masc_Strong "" --> and then race specific comments. I do this for organistation of the file. it does nothing in the game.
-Copy any of the entries so for example:
-        <!-- Tiefling -->
-        <node id="CharacterCreationAppearanceVisual">
-          <attribute id="BodyShape" type="uint8" value="0" />
-          <attribute id="BodyType" type="uint8" value="0" />
-          <attribute id="DisplayName" type="TranslatedString" handle="h70718c5dg76b9g402cgbe76ge5b2d9abaa1f" version="1" />
-          <attribute id="RaceUUID" type="guid" value="b6dccbed-30f3-424b-a181-c4540cf38197" />
-          <attribute id="SlotName" type="FixedString" value="Hair" />
-          <attribute id="UUID" type="guid" value="259cf9c6-c6f1-4265-b4b8-dd45f2a3772f" />
-          <attribute id="VisualResource" type="guid" value="00000000-0000-0000-0000-000000000000" />
-        </node>
-Once copied we want to change the RaceUUID line to the UUID of the custom/modded race.
-          <attribute id="BodyType" type="uint8" value="1" />
-Copy again the whole piece and then for the fem form if the race has one as this is currently set up for masc, change the Bodytype from 0 to 1 for fem.
-          <attribute id="BodyShape" type="uint8" value="1" />
-copy again if the race has a strong bodyshape and change bodyshape value from 0 to 1. If the default shape is the strong shape then leave it at 0.
-And that is all that needs changing. Nothing in my code needs changing so you don't need to worry abuot that, copy these sections as much as you need. And then use the tool as normal and it will edit the 32 vanilla entries plus all the modded entries you added.
-== CharacterCreationSharedVisuals ==
+==== [https://bg3.wiki/wiki/Modding:BG3_Mini_Tool#Using_Minitool_to_create_your_CharacterCreationAppearanceVisuals (Optional) Using Minitool to create your CharacterCreationAppearanceVisuals] ====
+=== CharacterCreationSharedVisuals ===
 Remember that you need your hair to be autosnapping to work properly in this section.
@@ Line 508: / Line 357: @@
 This one from the our sharedvisuals file. When you've finished adding the entries you want to add the races.lsx is ready to go.
-You can use the Compatibility Framework to avoid issues with your mod clashing with other mods: [[Modding:Compatibility Framework]]
+If you wish to use [[Modding:Compatibility Framework]] see that guide on how to use it as an alternative to Races.lsx. However we suggest you use both in order to not rule out your Mac users from using your mods.
+== When to use three or more meshes for autosnapping hairs ==
+Do you notice your autosnapping hair looks good on default bodies, but doesn't work quite right for the shorter or taller bodyshapes?
+This is where you would make several autosnapping hairs. Each variation needs its own VisualBank entry in your merged.lsf file.
+So if your hair has issues on different bodyshapes, you can do what Larian did and make several.
+*One made around a dwarven head.
+** this would be for Gnomes, Halflings and Dwarves
+*One made around the default Elf height.
+** this would be for Elves, Drow, Humans, Half Elves/Drow, Githyanki and Tieflings
+*One for Taller bodyshapes.
+** this would be for Strong Elves, Drow, Humans, Half Elves/Drow, Tieflings and Half Orcs
+If you still get issues on Tiefling heads then you might want to use Tiefling masc heads as a base for your default and tall height. You can make as many autosnapping variants as you need, but usually three will be enough.
+Once you have these set up and have made the visualbank entries, you can then make the additional edits to your CharacterCreationAppearanceVisuals or CharacterCreationSharedVisuals.
+=== CharacterCreationAppearanceVisuals ===
+If using CharacterCreationAppearanceVisuals, change the VisualResourceID to the new ones in the correct slots you made previously for testing the mod, as you should have all the vanilla race and bodyshapes available from your first creation of the file.
+=== CharacterCreationSharedVisuals ===
+If using CharacterCreationSharedVisuals, you want to make new entries with these options. And in races.lsx instead of using Humanoid/Fey/Fiend/Celestial you want to use the race sections of the races the hairs will work on.
+* For the Dwarven height, add to Gnomes, Halflings and Dwarves
+* For the default height, add to Elves, Drow, Humans, Half Elves/Drow, Githyanki and Tieflings
+* For the taller height, add to Strong Elves, Drow, Humans, Half Elves/Drow, Tieflings and Half Orcs
+== Troubleshooting ==
+Here are some common hair issues and how to troubleshoot them.
+'''My hair doesn’t show up at all, there’s not even a slot in Character Creation!'''
+Check your CharacterCreationAppearanceVisuals or CharacterCreationSharedVisuals, as that is where the CC slots are defined.
+'''My hair shows up as a slot, but when I select it, the hair is invisible!'''
+Check your hair _merged file, especially the file paths to your SourceFile and Template. Any inconsistency between this and the actual folders will result in the game not finding your mesh, and thus not loading it. Also note that folders must be separated by /, not \. E.g. Mod/Generated/Mod/Hair.GR2
 {{Modding navbox}}
 [[Category:Modding guides]] [[Category:Hair modding]]

Guide:Hair Mod File Setup (edit)

Revision as of 23:27, 12 April 2024