Modding:Creating mods: Difference between revisions

From Baldur's Gate 3 Wiki
No edit summary
 
(84 intermediate revisions by 4 users not shown)
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.
|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
|image=Modding_resources.webp
}}{{NavModding}}
}}{{Modding box}}
== General Tutorials ==
== Introduction ==
* [[Guide:Unpacking_and_Converting_Files|Unpacking and Converting Files]]
[https://forms.gle/eEhyfzsY5hmvVTRV8 '''Request a modding-related wiki page here!''']
* [[Modding:Dependencies|Dependencies]]
* [[Guide:Packaging_Mods|Packaging Mods]] for [[Guide:Installing_Mods|install]]
* [[Guide:Working with lsx files|Working with LSX files ( example with Progressions.lsx )]]
* [[Guide:Custom_Polymorph|Custom Polymorphing]]
* [[Guide:Texture_Formatting|Texture Formatting]]
* [https://www.youtube.com/playlist?list=PLe0NwkOacl_jFoRnGT8iU29WriucyN1mj Padme4000's tutorials]
* [https://docs.google.com/document/d/1iR-q2sTqxLuk3xXG8W6dbk3QeqQw_jdGkI1WAu45OoU/edit Custom Dye Mod Guide by AstralSprout]


=== Mesh Related Tutorials ===
Are you excited about becoming a Baldur's Gate 3 modder, but have absolutely no idea where to start?


* [[Guide:Fixing_Neck_Seams|Fixing neck seams]]
This page is the starting point for resources, tutorials, references and more that you need for modding.
* [[Guide:Fixing_UV_Errors|Fixing UV errors]]
* [[Guide:Fixing_Bone_Errors|Fixing bone errors]]
* [[Guide:Head_Conversion|Head Conversion]]
* [[Guide:Hair_Creation|Adding new Hairs to Character Creation]]
* [[Guide:Custom_Hair_Highlight|Custom Hair Highlight/Ombre]]
* [https://astropad.com/how-to-add-texture-to-a-3d-model-using-blender-an-ipad-and-uv-mapping/ How to add texture to a 3D model using Blender, an iPad, and UV Mapping]
* [https://www.youtube.com/playlist?list=PLYJ1Y7lY33WQOho8it-mTq6cIrH8dUeLP Learning Blender]
* [https://youtube.com/playlist?list=PLjEaoINr3zgFX8ZsChQVQsuDSjEqdWMAD&si=85qV8vXb9vMYzq7C Donut Tutorial] which is a great stepping stone into using blender and working with meshes
* [https://www.youtube.com/watch?v=B11XBZmIIZc Learn Shape Keys In Under 5 Mins]
* [https://www.youtube.com/watch?v=qTgSLYY9uew Fix your SHAPE KEYS! - Blender 2.8 tutorial by Danny Mac 3D]


== Scripting ==
{| class="wikitable"
* [[Guide:Getting_Started_with_Scripts|Getting Started with Scripting]]
|+ Good places to begin:
 
|-
=== Tools ===
! Resource !! Description
* '''[https://github.com/Norbyte/lslib Lslib]'''
|-
* '''[https://github.com/ShinyHobo/BG3-Modders-Multitool BG3 Multi-Tool]'''
| [[Modding:Getting Started with BG3 Modding|Getting Started with BG3 Modding]]|| Want to know where to release your mod, or want to know how permissions work for mods?
* '''[https://www.nexusmods.com/baldursgate3/mods/502 BG3 Mini tool]'''
|-
* '''[https://www.nexusmods.com/baldursgate3/mods/1808 BG3 Creator's Cauldron]'''
| [[Modding:Tools|Tools and Plugins]] || A list of useful tools and plugins that are available either specifically for BG3 Modding or that help with BG3 Modding.
* '''[https://www.nexusmods.com/baldursgate3/mods/4310 Volnos Texture Toolbox - BG3 texture tools for blender]
|-
'''
| [[Modding:Tutorials|Tutorial List]] || A list of different available tutorials categorised by theme.
*'''[https://www.nexusmods.com/baldursgate3/mods/1325 Dice Sprite Generator]'''
|-
 
| [[Modding:Sample_Templates|Sample and Template Mods]] || Sample/Template mods you can use as a base to create your own mods.
=== Blender Plugins ===
|-
 
|[[Modding:References|References]]
* [https://github.com/Norbyte/dos2de_collada_exporter Mesh import/export plugin]
|References and tables for the various game files you may need.
* [https://www.nexusmods.com/baldursgate3/mods/346 Padme Plugins]
|-
* [https://www.nexusmods.com/baldursgate3/mods/464 Armature Plugin]
|[[Modding:Code Snippets|Code Snippets]]
* [https://www.nexusmods.com/baldursgate3/mods/3683 Outfit Builder]
|Helpful code snippets for modding.
 
|-
== References ==
|[[Modding:Other Resources|Other Resources]]
A good external resource [https://bg3ccmoddinglibrary.carrd.co/ Bg3 CC Modding Library] put together by Weeviljester
|Miscellaneous resources to either help with modding or to add to your own mods.
 
|}
* [[Guide:AssetPrefixReferences|Asset Prefix References]]
{{Modding navbox}}
* [[Modding:VertexColorMaskSlots|Hiding skin/outfit parts: Vertex Color Mask Slots]]
* [[Guide:Hair_Meshes|Hair/Beard Meshes]]
* [[Guide:Head_Models|Head Models]]
* [[Guide:Face_and_Body_Textures|Face and Body Textures]]
* [[Guide:Colour_Map|Colour Map]]s
 
== Code Snippets ==
* [[Guide:Race_UUID|Race UUID]]s
* [https://pastebin.com/g0fUYFAL Interactable Item UUIDs]
* [https://www.scribd.com/document/666568844/Bg3-Items-v2 All items UUIDs]
* [https://pastebin.com/RLB7M0c8 Enemy types]
 
== Sample Mods ==
* [https://www.nexusmods.com/baldursgate3/mods/132 Padme's BG3 Tutorials and Modding Resources]
* [https://www.nexusmods.com/baldursgate3/mods/400 Sample 3D Edited Equipment Mod]
* [https://www.nexusmods.com/baldursgate3/mods/278 Sample Magic Ring Mod]
* [https://www.nexusmods.com/baldursgate3/mods/249 Sample Equipment Mod]
* [https://www.nexusmods.com/baldursgate3/mods/294 Add Scars to Your Character]
* [https://www.nexusmods.com/baldursgate3/mods/1280 Dye Template as Optional File]
 
== Other Resources ==
* [https://www.uuidgenerator.net/ UUID Generator]
* [https://www.nexusmods.com/baldursgate3/images/594 Making armour icons]
* [https://www.nexusmods.com/baldursgate3/mods/238 Custom Backdrops for Character Creation and Level Up]
* [https://boundingboxsoftware.com/materialize/ Materialize]
=== Colour ===
* [https://docs.google.com/spreadsheets/d/1yXrWOIPoBe8p6MftEgFnZATvnoEvmGXGlCClenNXj_4/edit#gid=0 Colouring cheat sheet]
* [https://ajalt.github.io/colormath/converter/ ColourMath Colour Converter] Use sRGB 0-1 for the vec3 value.
* [https://rgbcolorpicker.com/0-1 RGB Color Picker]
== Folder Structure ==
* Mod Name (root folder)
** Generated
*** Public
**** Mod Name
***** [PAK]_Mod_Name <- models and textures
** Localization
*** Language <- usually ''English''
**** <code>Mod_Name.xml</code> <- text for items and spells
** Mods
*** Mod Name
**** <code>meta.lsx</code> <- Created manually or automatically with the BG3 Mini Tool
** Public <- use one of the Sample Mods above as a template for this folder
*** Game <- icons and other UI elements
*** Mod Name <- mod files in plain-text or XML
=== Example meta.lsx ===
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<save>
    <version major="4" minor="0" revision="8" build="612"/>
    <region id="Config">
        <node id="root">
            <children>
                <node id="Dependencies"/>
                <node id="ModuleInfo">
                    <attribute id="Author" type="LSString" value="AUTHOR NAME HERE"/>
                    <attribute id="CharacterCreationLevelName" type="FixedString" value=""/>
                    <attribute id="Description" type="LSString" value=""/>
                    <attribute id="Folder" type="LSString" value="MOD FOLDER NAME HERE"/>
                    <attribute id="LobbyLevelName" type="FixedString" value=""/>
                    <attribute id="MD5" type="LSString" value=""/>
                    <attribute id="MainMenuBackgroundVideo" type="FixedString" value=""/>
                    <attribute id="MenuLevelName" type="FixedString" value=""/>
                    <attribute id="Name" type="LSString" value="MOD NAME HERE"/>
                    <attribute id="NumPlayers" type="uint8" value="4"/>
                    <attribute id="PhotoBooth" type="FixedString" value=""/>
                    <attribute id="StartupLevelName" type="FixedString" value=""/>
                    <attribute id="Tags" type="LSString" value=""/>
                    <attribute id="Type" type="FixedString" value="Add-on"/>
                    <attribute id="UUID" type="FixedString" value="UUID HERE"/>
                    <attribute id="Version64" type="int64" value="36029237253119790"/>
                    <children>
                        <node id="PublishVersion">
                            <attribute id="Version64" type="int64" value="36028797018963968"/>
                        </node>
                        <node id="TargetModes">
                            <children>
                                <node id="Target">
                                    <attribute id="Object" type="FixedString" value="Story"/>
                                </node>
                            </children>
                        </node>
                    </children>
                </node>
            </children>
        </node>
    </region>
</save>
</pre>
 
== Gallery ==
<gallery heights="300px">
Blender279b_collada_export_settings.webp|Collada/DAE export settings for Blender 2.79b
Blender293_collada_export_settings.webp|Collada/DAE export settings for Blender 2.93
GnuIMP_export-settings.webp|DDS export settings for GnuIMP 2.10
Blender279b_gr2_export_settings_1.webp|Export settings for Blender 2.79b with LaughingLeader's GR2 Export Plugin (1)
Blender279b_gr2_export_settings_2.webp|Export settings for Blender 2.79b with LaughingLeader's GR2 Export Plugin (2)
Blender279b_gr2_export_settings_3.webp|Export settings for Blender 2.79b with LaughingLeader's GR2 Export Plugin (3)
</gallery>
[[Category:Modding guides]]
[[Category:Modding guides]]

Latest revision as of 22:00, 13 April 2024

Introduction[edit | edit source]

Request a modding-related wiki page here!

Are you excited about becoming a Baldur's Gate 3 modder, but have absolutely no idea where to start?

This page is the starting point for resources, tutorials, references and more that you need for modding.

Good places to begin:
Resource Description
Getting Started with BG3 Modding Want to know where to release your mod, or want to know how permissions work for mods?
Tools and Plugins A list of useful tools and plugins that are available either specifically for BG3 Modding or that help with BG3 Modding.
Tutorial List A list of different available tutorials categorised by theme.
Sample and Template Mods Sample/Template mods you can use as a base to create your own mods.
References References and tables for the various game files you may need.
Code Snippets Helpful code snippets for modding.
Other Resources Miscellaneous resources to either help with modding or to add to your own mods.