Editing Modding:Unpacking and converting files

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
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}}
}}Main page: [[Modding Resources]]
== Necessary Tools ==
== Tools ==
* LSLIB by Norbyte
* LSLIB by Norbyte
** ''Note: This step is primarily for acquiring the '''granny2.dll''' from a previous version of LSLIB. The latest release version may already have this file present, in which case you can just install the latest release.''
** ''Note: This step is primarily for acquiring the '''granny2.dll''' from a previous version of LSLIB. The latest release version may already have this file present, in which case you can just install the latest release.''
** Install [https://github.com/Norbyte/lslib/releases/tag/v1.15.13 1.15.13] first, then install whichever is the [https://github.com/Norbyte/lslib/releases LATEST] release.
** Install [https://github.com/Norbyte/lslib/releases/tag/v1.15.13 1.15.13] first, then install whichever is the [https://github.com/Norbyte/lslib/releases LATEST] release
* Modders Multitool by ShinyHobo
* Modders Multitool by ShinyHobo
** Install [https://github.com/ShinyHobo/BG3-Modders-Multitool/releases LATEST] release.
** Install [https://github.com/ShinyHobo/BG3-Modders-Multitool/releases LATEST] release
** Make sure the folder you use for Multitool is separate from the LSLIB folder.


'''The Tool has an official wiki that now breaks down unpacking and other parts of the tool: [https://github.com/ShinyHobo/BG3-Modders-Multitool/wiki BG3 Modders Multitool Wiki]'''
Unzip the Modders Multitool. This is a small program that simplifies unpacking and viewing of files. It throws all unpacked files into its own directory, so put it where there is enough free disk space.


Please use that for the most up-to-date information.
ExportTool of the latest version can be placed in any convenient place. This is the "engine" that decompresses files and converts them into a readable format. Modders Multitool uses it.


<br>
== Tools Settings ==
Now to ExportTool.  
 
Before unpacking the files, you need to do a few tweaks.
Run '''bg3-modders-multitool.exe''' from the folder where you unpacked Modders Multitool and click on the asterisk.


This project needs the '''granny2.dll''' file to work correctly. Due to licensing issues at one point, Norbyte removed this file from some of the later versions of ExportTool, but it exists in older versions, such as v1.15.13, the link to which is above.
[[File:Modders Multitool_01.webp|650px|frameless|center]]


Verify that the '''granny2.dll''' file is present in the ExportTool's '''root folder''' and in the '''Tools''' sub-folder. If the file is present in both of these folders, then nothing more needs to be done with ExportTool and you can skip to the next section of this guide.
Here you will need to specify the path to divine.exe, which is located in '''ExportTool-vX.X.X/Tools'''
And the <code>.exe</code> of the game itself in the path Baldurs Gate 3/bin. For '''Vulcan it is bg3.exe''', for '''DirectX bg3_dx11.exe'''
[[File:Modders Multitool 02.webp|650px|frameless|center]]


If the '''granny2.dll''' file is missing from the '''root folder''' and/or the '''Tools''' sub-folder of the latest version of ExportTool, then you will need to copy the file over from the older version v1.15.13. Open the archive '''ExportTool-v1.15.13.zip''', copy the '''granny2.dll''' file, and paste it where you unpacked the latest version of ExportTool in the '''root folder''' and in the '''Tools''' sub-folder. Nothing more needs to be done with ExportTool.
<br>
Now to ExportTool.  


To run ExportTool, open ConverterApp.exe.
It needs the '''granny2.dll''' file to work correctly. Because of licensing problems, Norbyte removed it from the latest versions, but the file remains in the old ones, for example in v1.5.13, the link to which is above.
Open the archive '''ExportTool-v1.15.13.zip''', find there '''granny2.dll''', and throw it where you unpacked the latest version of ExportTool in the '''root folder''' and in the '''Tools''' folder. Nothing more needs to be done with ExportTool.


== Unpacking Process ==
== Unpacking Process ==


Currently we no longer need to directly unpack the game pak files thanks to Multitool updates. Instead, you can index your files and unpack the files as you need them. This saves you some hard drive space, as BG3 has a lot of files.
Open Modders Multitool again and click '''Unpack.pak Files'''. A menu appears.
 
=== Indexing ===
 
'''[https://github.com/ShinyHobo/BG3-Modders-Multitool/wiki/Index-Search Multitools wiki post on Indexing and Searching]'''
 
In Multitool, go to {{InfoBlob|Utilities > Index > Index Pak Files}} and this will now index all the unpacked pak files. Much quicker and easier to maintain than unpacking all of the paks.
* When we get new hot fixes, follow the above again to index the new hotfix paks.
 
However, whenever we get a full patch release, it is advised to first clear out the index and reindex using the following method: {{InfoBlob|Utilities > Index > Clear Index and then Utilities > Index > Index Pak Files}}
 
If you still want to unpack game paks manually rather than unpacking individual files via the new method, you can use: '''{{InfoBlob|'''Utilities''' > '''Game File Operations''' > '''Unpack Game Files'''.}}'''
** As of Patch 4, when a new patch is released, the hotfix paks get implemented into the main paks.
 
==== Index Search Unpacking ====
 
If you know the common name used on assets you want to unpack, you can use index search (once it has finished indexing) to unpack specific assets. For example, let’s say we want to create head mods, and thus we need the head models unpacked from the assets.
 
Here we search using the filter to only show GR2 Assets, as shown below:
 
[[File:Multitool Filter.webp|600px]]
 
Then we search for NKD_Head as shown below:
 
[[File:Multitool Extract Selected.webp|600px]]
 
Now we Select All and Extract Selected.
 
Note that this will extract more than just the races we can play as, but will use considerably less space than extracting the whole of the models.pak, if all we want to do is create head mods. You can also use this to go through the list to select specific assets you want to extract. This is not exclusive to GR2's, just pick the assets you want to filter and then you can extract.
* Be aware of your hard drive space where you placed the multitool, as it will create an {{InfoBlob|UnpackedData}} folder where it extracts these files to.
 
=== Manually Unpacking ===
 
If you still want to unpack game paks manually rather than unpacking individual files via the new method you can use {{InfoBlob|'''Utilities''' > '''Game File Operations''' > '''Unpack Game Files'''.}}
* Generally this is only advised if you have more than enough hard drive space to dedicate to unpacked files, as they can take up quite a bit of space.
* A menu will appear similar to below:
** (As of Patch 4 when a new patch is released the hotfix packs get implemented into the main paks)


[[File:Unpack paks.webp]]
[[File:207px-Pak_Selection.webp|frameless|center]]


Common files:
Common files:
* English.pak —  this is where the localization files are located, aka all text strings that are displayed in the game.
* English.pak —  this is where the localization files are located. All text strings that are displayed in the game.
* Gustav.pak — text files in .lsf format. Level data, dialog files, equipment stats, spells.
* Gustav.pak — text files in .lsf format. Level data, dialog files, equipment stats, spells.
* Materials.pak — materials (shaders). It is useless in itself, but you can see what materials are in the game to assign them to your model.  
* Materials.pak — materials (shaders). It is useless in itself, but you can see what materials are in the game to assign them to your model.  
* Models.pak — models in .gr2 format. Heads, hair, armour, architecture, etc.
* Models.pak — models in .gr2 format. Heads, hair, armor, architecture, etc.
* Textures.pak — textures in .dds format. There are not a lot of them here, since most textures are held in VirtualTextures. These are mostly color ID masks that divide the armour into zones for coloring. But there are textures for faces, hair, tattoos. Some environment textures.
* Textures.pak — textures in .dds format. There are not a lot of them here, mostly they are color ID masks that divide the armor into zones for coloring. But there are textures for faces, hair, tattoos. Some environment textures.
* Shared.pak — text files in .lsf format. Overlaps with Gustav in some respects. Model data with assigned materials, skin, hair, eye colors, etc. for the character editor, also equipment stats, spells.
* Shared.pak — text files in .lsf format. Overlaps with Gustav in some respects. Model data with assigned materials, skin, hair, eye colors, etc. for the character editor, also equipment stats, spells.
* VirtualTextures.pak — Most of the textures of the game are here, packed in virtual textures to improve performance.
* VirtualTextures.pak — most of the textures of the game, are packed in virtual textures to improve performance.  
* Voice.pak — voice lines.
* Voice.pak — voice lines.


Line 83: Line 52:
== Files conversion ==
== Files conversion ==


Most unzipped files are not viewable or editable as-is, so you will have to convert them to a readable format.  
Most unzipped files are not viewable or editable, so you will have to convert them to a readable format.  


=== .lsf → .lsx ===
=== .lsf → .lsx ===
Line 110: Line 79:
=== .dds ===
=== .dds ===
Texture files from '''Textures.pak'''.
Texture files from '''Textures.pak'''.
These can be opened by installing the [https://developer.nvidia.com/nvidia-texture-tools-exporter Adobe Photoshop Plugin] from the Nvidia website. For those who don't have Photoshop, the free [https://www.gimp.org/downloads/ Gimp] from version 2.10.10 onwards should have .dds support. [https://www.getpaint.net/ Paint.net] can also open .dds files and is free.
These can be opened by installing the [https://developer.nvidia.com/nvidia-texture-tools-exporter Adobe Photoshop Plugin] from the Nvidia website. For those who don't have Photoshop, the free [https://www.gimp.org/downloads/ Gimp] from version 2.10.10 onwards should have .dds support.
<br>
<br>
If you need to import textures into other programs or engines (Substance Painter, Blender, Unreal, Unity), it's best to save them in Targa (.tga) format. This will leave the alpha channel intact.
If you need to import textures into other programs or engines (Substance Painter, Blender, Unreal, Unity), it's best to save them in Targa (.tga) format. This will leave the alpha channel intact.
Line 124: Line 93:


=== .loca → .xml ===
=== .loca → .xml ===
Localization text from '''English.pak''' (the same for other languages).
Localization text from '''English.pak''' (presumably the same for other languages).
The <code>.loca</code> files can be converted with Export Tool. Select the <code>.loca</code> file and specify the name of a <code>.xml</code> file to use as output.
The <code>.loca</code> files can be converted with Export Tool. Select the <code>.loca</code> file and specify the name of a <code>.xml</code> file to use as output.
[[Category:Modding guides]]
[[Category:Modding]]
Please note that all contributions to Baldur's Gate 3 Wiki are considered to be released under the CC BY-NC-SA license, except when noted otherwise (see BG3Wiki:Copyrights for details). If you do not want your writing to be edited and redistributed at will, do not submit it here. Per our Content Rules, you are promising that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://bg3.wiki/wiki/Modding:Unpacking_and_converting_files"