Guide:Hair Mod File Setup: Difference between revisions

}}{{NavModding}}

 

Welcome to the file setup portion of making a hair mod. For the mesh creation portion, see [[Modding:Creating Hair Mods]].

* [https://www.nexusmods.com/baldursgate3/mods/502 BG3 Mini Tool] (optional but helpful)

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.

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.

=== (Optional) Using mini tool to create/edit the .loca ===

 

 

 

 

 

 

 

 

 

 

 

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.

== CharacterCreationAppearanceVisuals ==

 

okay let's break this down into sections:

* for Half-Orcs even though they use Tall Muscular bodyshape this value needs to be 0

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]]

This tells the game you are adding the asset to a hair slot in character creation.

This must be a unique uuid

Match the ID line in the Hairs merged file that we created

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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.

 

 

First big thank you to NellsRelo and perseidipity

 

To use the [https://www.nexusmods.com/baldursgate3/mods/1933 Compatibility Framework] you need to install it alongside your mod. CF however needs to be at the bottom of the load order.

 

 

 

 

 

 

 

Using part of the code example we are given [https://github.com/BG3-Community-Library-Team/BG3-Compatibility-Framework/wiki/_Races-API here:] but edited.

 

          "Values": ["bdf9b779-002c-4077-b377-8ea7c1faa795", "3e4d5829-7bfd-446a-9e7d-ac8d0948c1e4"],

      ]

 

In this line we want to change it to the race we are adding to in the Races.lsx file. The most commonly used one is Humanoid for hair/beard mods. Which is 899d275e-9893-490a-9cd5-be856794929f. This will apply it to all races including modded races if they use it as the parent. For others see [[Modding:Race_UUID|here in the Races.lsx section]] for example if you want it only added to Humans and Elves your code would look like this.

 

 

 

Visuals pertains to assets such as Hair, Beards, Tails, Horns and such. Pretty much the assets we add to SharedVisuals.

 

So as this line says it is optional, but personally I add it in. The UUID we add in the meta.

 

This uuid has to match the one you gave for the UUID line in your CharacterCreationSharedVisuals. If you have multiple assets add a , after the final " and then make a new " " with your uuid in between for example from the first example given:

 

 

 

Congrats you setup your mod for using the Compatibility Framework via json. Just remember always load Compatibility Framework at the bottom of your load order.

 

 

 

 

In the Script extender folder you want to create a Config.json you can do this by creating a text file and just renaming it and its extension Config.json. In the json you want:

    "RequiredVersion": 9,

Where it says YOUR_MOD_NAME_HERE, write the name of your mod.

Now in the Lua folder do the same again make a new txt file but this time rename it BootstrapClient.lua

if Ext.Mod.IsModLoaded("67fbbd53-7c7d-4cfa-9409-6d737b4d92a9") then

        modGuid = "the UUID you gave in your meta.lsx",

        raceGuid = "899d275e-9893-490a-9cd5-be856794929f",

            Type = "Visuals",

            Value = "3ae3e4fc-e792-473a-8853-43520dfc1147",

          },

      Mods.SubclassCompatibilityFramework.Api.InsertRaceChildData(raceChildData)

        raceGuid = "899d275e-9893-490a-9cd5-be856794929f",

this you want to be the race you're adding your hair too. The one currently in there is humanoid. This will apply it to all races including modded races if they use it as the parent. For others see [[Modding:Race_UUID|here]]

            Type = "Visuals",

This line is what you're adding to. Visuals is either Hair or Beards or other assets defined in the SharedVisuals file.

            Value = "3ae3e4fc-e792-473a-8853-43520dfc1147",

This uuid has to match the one you gave for the UUID line in your CharacterCreationSharedVisuals

If wanting to create more than one hair copy and paste this section:

          },

Changing entry1 to entry2 and so on. You can also use entrya, entryb as well.

Not fully related to this tutorial but just in case you come up with a use, swap out InsertRaceChildData for RemoveRaceChildData if you want to remove lines from the Races.lsx instead of adding.

[[Category:Modding guides]]