https://github.com/s-thom/bg3-sounds-converter

A quick script to run other tools to convert and categorise the sounds from Baldur's Gate 3
https://github.com/s-thom/bg3-sounds-converter

baldurs-gate baldurs-gate-3 baldurs-gate-iii conversion vgmstream wwise

Last synced: 3 months ago
JSON representation

A quick script to run other tools to convert and categorise the sounds from Baldur's Gate 3

• Host: GitHub
• URL: https://github.com/s-thom/bg3-sounds-converter
• Owner: s-thom
• License: mit
• Created: 2023-11-19T00:36:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-16T06:50:19.000Z (about 1 year ago)
• Last Synced: 2025-03-09T12:51:51.584Z (3 months ago)
• Topics: baldurs-gate, baldurs-gate-3, baldurs-gate-iii, conversion, vgmstream, wwise
• Language: Python
• Homepage:
• Size: 10.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# BG3 sound categoriser

This script is heavily based on (by which I mean copy/pasted from) [/u/NikolayTeslo's comment](https://www.reddit.com/r/BaldursGate3/comments/14eipmt/comment/k16mtq7/) in /r/BaldursGate3. This script will also use vgmstream to do the conversion so you don't need a separate step for that.

## Requirements

This script assumes you are on Windows and are comfortable enough in a terminal to run a command or two.

You will need to download/install a few things to make this work.

- [BG3 Modders Multitool](https://github.com/ShinyHobo/BG3-Modders-Multitool)

  - Used to unpack the audio files and metadata from the game.

  - Download the latest release from [the releases page](https://github.com/ShinyHobo/BG3-Modders-Multitool/releases) and extract somewhere.

- [Python 3](https://www.python.org/)

  - Used to run this script.

  - Install how you would normally install Python, The Windows Installer from [the website](https://www.python.org/downloads/) is a good choice if you don't know what to do.

  - Run `python --version` to check that Windows doesn't have the broken alias enabled.

    - If it does, then search Settings for "app execution aliases" and disable the entries for `python.exe` and `python3.exe`.

- [vgmstream](https://github.com/vgmstream/vgmstream)

  - Used to convert the `.wem` files to `.wav` so audio players can play them.

  - Download the latest release from [the builds website](https://vgmstream.org/) and extract the folder somewhere.

  - Double check the release has a bunch of DLLs included.

- [wwiser](https://github.com/bnnm/wwiser)

  - Used to convert the `.bnk` files to XML so they can be read.

  - Download both `wwiser.pyz` and `wwnames.db3` from [the releases page](https://github.com/bnnm/wwiser/releases) and place them in the folder this README resides.

## Usage

1. Ensure you check this project out in a path with _no spaces_ in the name

   - This project is currently sensitive to this, and having spaces in any paths will mean it doesn't work.

2. Open the Modders Multitool

   - Make sure you have your game path set correctly. This can be confirmed by opening the Configuration dialog from thetop menu.

3. In the top menu, select `Utilities` > `Game File Operations` > `Unpack Game Files`.

4. Select `SharedSoundBanks.pak` and `SharedSounds.pak` and confirm.

5. Wait for the unpacking to complete.

6. Back in this project, change the constants in `categoriser.py`

   - `wwiser_pyz` should be the path of the `wwiser.pyz` you downloaded.

   - `folder_vgmstream` should be the folder you extracted vgmstream to.

   - `folder_unpacked_data` should be the `UnpackedData` folder in your BG3 Modders Multitool location.

   - `folder_audio_converted` should be the folder where you want your final files to be.

7. If you want the files renamed to more human-friendly names, check the advanced section.

8. Run `python categoriser.py`

   - This will take some time, so go off and enjoy your life while it does its thing.

9. Your audio files will be categorised in the converted folder.

   - The file names will be numbers, not human friendly names. If you are looking for something specific, then you will need to sort through them manually.

### Advanced: Renaming

> [!NOTE]

> These steps require [wsl](https://learn.microsoft.com/en-us/windows/wsl/), or some other way of using Linux, as you will be dealing with file paths that are invalid in Windows.

This step uses the [bg3-sids wiki](https://github.com/HumansDoNotWantImmortality/bg3-sids/wiki) by HumansDoNotWantImmortality.

1. In `wsl`, clone `https://github.com/HumansDoNotWantImmortality/bg3-sids.wiki.git`.

   - If you accidentally run this in Windows, you'll find that it can't check any of the files out. Open `wsl` and run `git checkout master` to actually check out the files.

2. In `wsl`, run the following script in that project to make the file names valid in Windows.

   ```sh

   for file in *; do

     new_file=$(echo "$file" | sed 's/[\\&]/_/g')

     mv "$file" "$new_file"

   done

   ```

3. Back in this project, set `should_rename` to True and `folder_bg3sids_wiki` to the path you cloned the wiki to.

4. Switch back to Windows to run the Python script.

## Future plans

- None. I'll only revisit this if I need to mess with more audio files.