Editing Modding:Coding An Item

}}{{Modding box}}{{Modding sidebar}}<div column-width: "60em2;>

You have made a mesh for a human man, a circlet. We are going to add it to the game. [[Modding:Creating and Exporting Meshes in Blender|(See here for how to make new meshes in Blender!)]]

 

***Public

****<code>MySweetMod.loca</code> <- text for items and spells

******** [PAK]_Armor <-- material and mesh LSX for custom outfits and weapons

*****Stats

In these will be a visualbank (list of meshes),a materialbank (list of materials) and a texturebank (list of textures). You can split them into their own pages or combine them all, it doesn't matter. When the multitool converts them they will all get merged together anyway. This separation is for viewer ease as they can become very long. For our needs we are putting them into 2 lsx, a meshes and a texture/material one.

  <attribute id="Name" type="LSString" value="HUM_M_CLT_MySweetCirclet" /> '''Referenced nowhere else but try to make it unique so you don't potentially mess up another item.'''

  <attribute id="LOD" type="uint8" value="0" /> '''What level of LOD it is. This is a LOD0, so it is the highest quality mesh and the one we see in cutscenes.'''

  <attribute id="MaterialID" type="FixedString" value="00000000000000000000004" /> '''What material it links up to (see materialbank code).'''

  <attribute id="ObjectID" type="FixedString" value="HUM_M_CLT_Headwear_Circlet_Silver_A.HUM_M_CLT_Headwear_Circlet_Silver_A_Mesh.0" /> '''The .0 denotes mesh order, which is not the same as LOD. It is set in the Blender export.'''

  <attribute id="LOD" type="uint8" value="1" /> '''This is a LOD1 mesh.'''

  <attribute id="ObjectID" type="FixedString" value="HUM_M_CLT_Headwear_Circlet_Silver_A.HUM_M_CLT_Headwear_Circlet_Silver_A_Mesh_LOD1.1" />  

This code would stop the body's feet from loading in and clipping, ideal for boot items. See [https://bg3.wiki/wiki/Modding:VertexColorMaskSlots here for a full list of Vertex Mask Slots for the body.]

  <node id="ScalarParameters"> '''x7'''

  <node id="Texture2DParameters">

Now the material we have found, SourceFile "Public/Shared/Assets/Materials/Characters/CHAR_BASE.lsf" is a fairly standard shader without transparency or glowing. Materials that can be Transparent have 'Alpha' in the title. For example, "Public/Shared/Assets/Materials/Characters/CHAR_BASE_AlphaTest_2S.lsf" or "CHAR_BASE_AlphaTest_2S_Dither" will enable alpha and make the mesh visible from both sides (turns off backface culling). Underwear needs to have a Dither shader or it won't hide correctly.

     <attribute id="SRGB" type="bool" value="False" /> Ensure this is set to False on anything except a Basecolour! All other maps do not convey colour information so they don't need it on.

If there is anything wrong with the material, your item may simply refuse to show up, so it is worth double-checking everything here.

==RootTemplate ==

Now for the game to recognise the circlet as an item, we add it to the root template lsx:

  <attribute id="ParentTemplateId" type="FixedString" value="4d2e0931-3a01-4759-834b-8ae36749daab" /> '''This tells the game roughly what kind of item it is, such as in this case a helm. You should use the right kind for your item to avoid inherited problems. For example a shield will not know it is a shield without this ParentTemplate.''' '''If something is not specified in your root template, [such as description, icon, equip sound] it will fall back on this parenttemplate and use the ones listed there.'''

  '''The races Githyanki, Dragonborn, Tiefling and Half Orcs are set to automatically use HUM or HUM_STRONG models, unless they are manually opted out by adding this Parentrace node. '''

  '''Adding this parentracenode will set the item to use race-specific meshes for any race you specify with its [https://bg3.wiki/wiki/Modding:Race_UUID Race UUID.] '''

  '''You may wish to not bother making a tiefling specific mesh unless there is very obnoxious tail or horn clipping, so you can simply not include them in the parentrace node.'''

  <attribute id="MapValue" type="guid" value="00000000-0000-0000-0000-000000000000" /> This zeroes the race out of the ParentRace node.

You can look at the game’s own armor.txt for ideas of what to put here. You can delete what you don't wish to add, all you really need is the entry, the type, what slot it uses and the RootTemplate.

  type "Armor" '''Note that the 'type' section can enable the item to spawn in random places the game randomly puts items. If you wish it to never spawn anywhere else, either set <code>type ""</code>'''. Or, potentially, add <code>data "ItemGroup" ""</code> below.

  data "Rarity" "Rare" '''This effects what colour it is in your inventory, rarer things get a different colour outline.'''  

If adding a custom passive, your '''Passive.txt''' will look like this. You don't need a passive.txt at all, you can make perfectly good items just reusing the game's passives, this is just for the ambitious.

  object category "I_MY_COOL_NEW_CIRCLET",1,0,0,0,0,0,0,0

 

This will make it spawn in the tutorial chest. Other treasuretable codes to put it different places can be found [https://www.nexusmods.com/baldursgate3/mods/2534 here- Modder's Resource - Treasure Table Spreadsheet].

 

Make sure you don't forget the ''I_'' prefix for the item!

The numbers affect the drop rate chance among other things. The numbers above will cause the item to always spawn in the chest. For more info see Larian's wiki page on [https://docs.larian.game/Treasure_Tables TreasureTables], it is for a different game but shares the same idea.

If you plan to put a lot of items in your mod, it is recommended to create a bag item containing them and put that in the Tutorial Chest, to avoid clutter.

[[Category:Modding guides]]

[[Category:Armor modding]]

mod, or add it to the back of an existing mod. When you know the fault is not with your mesh, you check your materials, and so you can fix things one step at a time.{{Modding navbox}}