Modding:Creating mods: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
 
(62 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}}
== Basic Tutorials ==
== Introduction ==
Tutorials for basic components of BG3 Modding. You will likely need to understand all of these before you start modding.
[https://forms.gle/eEhyfzsY5hmvVTRV8 '''Request a modding-related wiki page here!''']
* [[Getting Started with BG3 Modding]]
* [[Understanding Mod Folder Structure]]
* [[Modding:Creating meta.lsx|Creating your Meta.lsx]]
* [[Guide:Unpacking_and_Converting_Files|Unpacking and Converting Files]]
* [[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 )]]
== General Tutorials ==
General tutorials for modding BG3, or tutorials that encompass multiple categories.


*[[Guide:Custom_Polymorph|Custom Polymorphing]]
Are you excited about becoming a Baldur's Gate 3 modder, but have absolutely no idea where to start?
*[https://docs.google.com/document/d/1iR-q2sTqxLuk3xXG8W6dbk3QeqQw_jdGkI1WAu45OoU/edit Custom Dye Mod Guide] by AstralSprout
* [https://docs.google.com/document/d/1s0I2zLZXPzmW6DMRXBkLbHjKzOUOhxPWwfz05Y0Bv2g/edit Add your custom hair to BG3 in 10 minutes or less] by EmeraldTechno


== Mesh-Related Tutorials ==
This page is the starting point for resources, tutorials, references and more that you need for modding.
Mesh encompasses visible assets like clothing, armor, weapons, hair, heads, etc. Most of these tutorials use Blender as their program of choice.
* [[Guide:Fixing_Neck_Seams|Fixing neck seams]]
* [[Guide:Fixing_UV_Errors|Fixing UV errors]]
* [[Guide:Fixing_Bone_Errors|Fixing bone errors]]
* [[Guide:Head_Conversion|Head Conversion]]
* [https://www.youtube.com/playlist?list=PLe0NwkOacl_jFoRnGT8iU29WriucyN1mj Padme4000's YouTube tutorials]
** [https://youtu.be/WB0Cx4igByY?si=CIJVAM_Gq3y_6Hex Adding New Colors to Character Creation]
** [https://youtu.be/siC6fak9zDM?si=r1nezgGOs9OWqOOr Creating Hairs Post Patch 9]
** [https://youtu.be/gxmgZ_X1kbI?si=wj7OFqyKkGS3BV2V Joining Different Meshes Into One]
** [https://youtu.be/RMPivc5qunw?si=2orGjIsCvQHWp31O Editing Heads]
* [[Guide:Hair_Creation|Adding New Hairs to Character Creation]]
* [https://drive.google.com/file/d/1FsC1fwRwF0FKvAuPL-Md7WFbCiL0Psvp/view Hair Thinning Begone] by mocia
* [https://www.youtube.com/watch?v=IbivHL2lPrc&list=PLe0NwkOacl_jFoRnGT8iU29WriucyN1mj&index=12 Making Custom Armor - Part 1] by Druundev
* [[Guide:Custom_Hair_Highlight|Custom Hair Highlight/Ombre]]


===== [https://www.youtube.com/playlist?list=PLYJ1Y7lY33WQOho8it-mTq6cIrH8dUeLP Learning Blender] =====
{| class="wikitable"
These tutorials are not directly BG3-related, but are a great stepping stone into using Blender and working with meshes.
|+ Good places to begin:
* [https://youtube.com/playlist?list=PLjEaoINr3zgFX8ZsChQVQsuDSjEqdWMAD&si=85qV8vXb9vMYzq7C Donut Tutorial (Blender 3.0)] by Blender Guru
|-
* [https://www.youtube.com/playlist?list=PLjEaoINr3zgEPv5y--4MKpciLaoQYZB1Z Donut Tutorial (Blender 4.0)] by Blender Guru
! Resource !! Description
* [https://www.youtube.com/watch?v=B11XBZmIIZc Learn Shape Keys In Under 5 Mins] by PIXXO 3D
|-
* [https://www.youtube.com/watch?v=qTgSLYY9uew Fix your SHAPE KEYS! - Blender 2.8 tutorial] by Danny Mac 3D
| [[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?
 
|-
== Texture-Related Tutorials ==
| [[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.
Texturing is usually applied on top of a mesh to make it appear a certain way.
|-
* [[Guide:Texture_Formatting|Texture Formatting]]
| [[Modding:Tutorials|Tutorial List]] || A list of different available tutorials categorised by theme.
* [https://www.youtube.com/watch?v=o_zgNI9nhns&list=PLe0NwkOacl_jFoRnGT8iU29WriucyN1mj&index=13 Making Custom Armor - Part 2] by Druundev
|-
* [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]
| [[Modding:Sample_Templates|Sample and Template Mods]] || Sample/Template mods you can use as a base to create your own mods.
 
|-
== VFX-Related Tutorials ==
|[[Modding:References|References]]
[https://github.com/ImmortalRDI/BG3-Community-Library/wiki Creating Custom Visual Effects in-depth guide] by ImmortalRDI
|References and tables for the various game files you may need.
 
|-
== Scripting Tutorials ==
|[[Modding:Code Snippets|Code Snippets]]
* [[Guide:Getting_Started_with_Scripts|Getting Started with Scripting]]
|Helpful code snippets for modding.
 
|-
== Tools ==
|[[Modding:Other Resources|Other Resources]]
Some extremely useful tools that will make your BG3 modding life so much easier.
|Miscellaneous resources to either help with modding or to add to your own mods.
* [https://github.com/Norbyte/lslib Lslib]
|}
** Needed for many types of conversations necessary for modding.
{{Modding navbox}}
* [https://github.com/ShinyHobo/BG3-Modders-Multitool BG3 Multi-Tool]
** Allows you to pack and unpack mods, search the game’s asset files, and more!
* [https://www.nexusmods.com/baldursgate3/mods/502 BG3 Mini tool]
** Has a variety of helpful functions including creating your Meta.lsx file for you.
* [https://www.nexusmods.com/baldursgate3/mods/1808 BG3 Creator's Cauldron]
** Dive into the world of BG3 homebrewing with Creator's Cauldron! From custom magical armor to powerful spells, this tool makes creating your own BG3 content a breeze.
 
*[https://www.nexusmods.com/baldursgate3/mods/1325 Dice Sprite Generator]
**These tools allow you to generate 25 ANIMATED dice sprites needed for your dice in one click!
 
=== Blender Plugins ===
 
* [https://github.com/Norbyte/dos2de_collada_exporter Mesh import/export plugin]
** You’ll need this if you want to work with .GR2 files (that’s what BG3 uses) in Blender.
 
* [https://www.nexusmods.com/baldursgate3/mods/346 Padme’s Addons]
** Includes addons for Head Export Order, Easy LOD Creation, Normal Map Transfer, Quick UV Buttons and Reset Transforms.
* [https://www.nexusmods.com/baldursgate3/mods/464 Armature Plugin]
** Blender addon which helps to edit the skeleton for BG3 models.
* [https://www.nexusmods.com/baldursgate3/mods/3683 Outfit Builder]
** Given armor in a base body (e.g. HUM_F) and body variants of HUM_F (e.g. HUM_FS, or some body mod here), generate meshes of the armor for those body variants.
* [https://www.nexusmods.com/baldursgate3/mods/4310 Volnos Texture Toolbox]
** A modding resource containing a collection of tools for modifying BG3'ss skin textures, as well as a recreation of Baldur’s Gate 3’s skin shader.
 
== References ==
Baldur’s Gate 3 has a LOT of files. It can be very difficult to find the specific asset you’re looking for. The pages in this section should help you find the files you’re looking for as you’re modding!
 
* [https://bg3ccmoddinglibrary.carrd.co/ Bg3 CC Modding Library] by Weeviljester
* [[Guide:AssetPrefixReferences|Asset Prefix References]]
* [[Modding:VertexColorMaskSlots|Hiding skin/outfit parts: Vertex Color Mask Slots]]
* [[Guide:Hair_Meshes|Hair/Beard Meshes]]
** [https://docs.google.com/spreadsheets/u/0/d/16cQUxQ7FrGVmIPy5929qae4cCQls4ZWuBX_w08zvv5M/htmlview BG3 Hair Reference Spreadsheet (WIP)] by EmeraldTechno
* [[Guide:Head_Models|Head Models]]
* [[Guide:Face_and_Body_Textures|Face and Body Textures]]
* [[Guide:Colour_Map|Colour Map]]s
* [https://bg3-dyes.tumblr.com/ Examples of dyes on clothing/armor]
 
== Code Snippets ==
Code snippets and IDs that are often used, collected here to make your life easier.
* [[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]
* [https://www.nexusmods.com/baldursgate3/mods/2534 Treasure Table Spreadsheet]
 
== Sample Mods ==
One of the most helpful things you can do when you’re starting out with modding is to take a look at sample mods that actually work and start from there. Here are a collection of Sample Mods designed to help you create a finished product.
* [https://www.nexusmods.com/baldursgate3/mods/132 Padme's BG3 Tutorials and Modding Resources] by Padme4000
** Includes Eye Color Template, Hair Color Template, New Head Template, Tattoo and Makeup Template, and Localization Template.
* [https://www.nexusmods.com/baldursgate3/mods/400 Sample 3D Edited Equipment Mod] by AnteMaxx
* [https://www.nexusmods.com/baldursgate3/mods/278 Sample Magic Ring Mod] by AnteMaxx
* [https://www.nexusmods.com/baldursgate3/mods/249 Sample Equipment Mod] by AnteMaxx
* [https://www.nexusmods.com/baldursgate3/mods/294 Add Scars to Your Character] by labotor
* [https://www.nexusmods.com/baldursgate3/mods/1280 Dye Template as Optional File] by Padme4000
* [https://www.nexusmods.com/baldursgate3/mods/4515 Custom Race Template] by Tripsadin
* [https://www.nexusmods.com/baldursgate3/mods/437 Hair Template] by Padme4000
* [https://www.nexusmods.com/baldursgate3/mods/4148 Kay's CC Icon Template] by perseidipity
* [https://www.nexusmods.com/baldursgate3/mods/4200 Sample VFX Mod] by Shivero
 
== Other Resources ==
* [https://www.uuidgenerator.net/ UUID Generator]
* [https://www.nexusmods.com/baldursgate3/images/594 Making armour icons] by AnteMaxx
* [https://www.nexusmods.com/baldursgate3/mods/238 Custom Backdrops for Character Creation and Level Up] by AnteMaxx
* [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 21: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.