G2WwiseDataTool

G2WwiseDataTool is a CLI application which can be used to export Audio Objects, Events, Switches and SoundBanks from a Wwise project's GeneratedSoundBanks folder into files which are compatible with the Glacier 2 engine.

Supported file types

This table shows which Wwise objects are supported and which Glacier 2 engine file types that they get exported to:

Wwise		Glacier 2	Custom
Audio Objects (wem)	->	WWEM	No
Events/Dialogue Events	->	WWEV	Yes
Switches	->	WSWT/WSWB	Yes
SoundBanks (bnk)	->	WBNK	No (custom header added though)

Technical information:

• Non-streamed audio objects get stored in the WWEV files instead of being stored in the SoundBanks.
• Prefetched audio objects get exported to WWEM files and the prefetch data is stored in WWEV files instead of being stored in the SoundBanks.
• Streamed audio objects get exported to WWEM files.
• Exported SoundBanks are identical to the ones which are exported by Wwise apart from a custom header with the file size.

Wwise setup

1. Download the example Wwise project from: https://github.com/glacier-modding/G2WwiseProject.
2. Download and install Wwise 2019.2.15.7667 from https://www.audiokinetic.com/en/download/ (You will need a Wwise account).
3. Setup your Audio Objects, Events, Switches and SoundBanks (make sure to untick the media field for each event that you reference in the SoundBank).
4. Generate SoundBanks.

In-game setup

You will need to create a SoundBank entity which references your new SoundBank in the GlobalData brick ([assembly:/_pro/scenes/bricks/globaldata.brick].pc_entitytype) using QNE (QuickEntity Editor) and creating a entity.patch.json file for your SMF mod.

Here is an example of a SoundBank entity:

{
	"parent": "abcd889eea2e16b2",
	"name": "Example_SoundBank",
	"factory": "[modules:/zsoundbankentity.class].pc_entitytype",
	"blueprint": "[modules:/zsoundbankentity.class].pc_entityblueprint",
	"properties": {
		"m_pBankResource": {
			"type": "ZRuntimeResourceID",
			"value": "[assembly:/sound/wwise/exportedwwisedata/soundbanks/globaldata/example_soundbank.wwisesoundbank].pc_wwisebank"
		}
	}
}

Usage

Requires .NET Runtime 8 installed.

G2WwiseDataTool 1.7.0
Copyright (C) Glacier 2 Modding Organisation

  -i, --input         Required. Path to the SoundbanksInfo.xml file (located in
                      Wwise_Project_Root\GeneratedSoundBanks\Windows\).

  -o, --output        Path to output the files (defaults to current working directory).

  -s, --save-paths    Saves Event, Switch and SoundBank paths to events.txt, switches.txt and soundbanks.txt text files
                      in the output path.

  -f, --filter        Filters which SoundBanks will get exported separated by spaces. Example: --filter
                      Example_SoundBank MyAwesomeSoundBank (case sensitive).

  -v, --verbose       Sets output to verbose messages mode.

  -l, --licenses      Prints license information for G2WwiseDataTool and third party libraries that are used.

  --help              Display this help screen.

  --version           Display version information.

Example Usage

G2WwiseDataTool.exe -i "InputPath\Windows\SoundbanksInfo.xml" -o "OutputPath" -s

For automation with Wwise please see the automation section in the G2WwiseProject repository.

Limitations

• Replacing existing events doesn't always seem to work. The game loads the event data from existing soundbanks instead. You will need to create entirely new events.
  • If you wish to replace existing events in the game you will need to manually rename the generated WWEV file to match the hash of the WWEV that you are wanting to replace.
• Custom States are not possible due to them needing to be in the Init bank.
• Audio objects must be "Sound SFX".

Credits

• 2kpr - For helping by adding support for events which contain multiple audio objects and events which contain multiple mixed stream type audio objects.