/AudioMog

AudioMog is a free all-in-one audio modding tool, that allows users to unpack, and repack supported game's audio binary files.

Primary LanguageC#MIT LicenseMIT

AudioMog

AudioMog is a free all-in-one audio modding tool, that allows users to unpack, and repack supported game's audio binary files. AudioMog was created to assist Kingdom Hearts III modding endeavors, and works on other games such as Melody of Memory, Final Fantasy XV, and more.

Features

  • Unpack audio binary files for supported games into playable wav/hca/ogg files
  • Repack audio binary files with overrides to specific tracks, such that games will be able to use them properly.
  • Provide human-readable track names, for an easier modding experience

Supported formats

Format Unpack Repack Notes
.uexp ✓ ✓ Repacking needs an additional .uasset file
.bytes ✓ ✓
.sab ✓ ✓
.sabf ✓ ✓
.mab ✓ ✓
.mabf ✓ ✓

Usage

In order to use AudioMog, you have to drag supported files onto the executable (AudioMog.exe), or nothing will happen!

  1. Drag any file of the supported formats above to extract its contents, and create an AudioMog project settings .json file.
  2. Replace/override audio files that you wish to change. (e.g. replace music_001.wav with a new music_001.wav)
  3. (Optional) Customize the project settings .json file to your liking
  4. Drag the generated project settings .json file to repack the audio back to its original format
  5. Load the repacked audio binary file into the game using whatever the game's preferred mod loading method is.

Terminal Settings

AudioMog holds several settings under TerminalSettings.json, that you must adjust for specific games to work.

  • Parser
    • OverrideUAssetFileSizeOffsetFromEndOfFile: (optional) Offset in UAsset to replace "expected uexp file size" bytes. (auto when null)
    • MusicFileVersion: When reading music audio binary files, you should only read files of a matching version to this. This serves to warn you if you try to rebuild files of unexpected versions.
    • SoundFileVersion: When reading sound audio binary files, you should only read files of a matching version to this. This serves to warn you if you try to rebuild files of unexpected versions.
  • Audio Extractor
    • ExtractAsRaw: Internally, all supported games use .hca or .ogg files, set this to true to extract these files as they are.
    • ExtractAsWav: Should audio files be converted to .wav upon extraction?
    • You can set both ExtractAsRaw and ExtractAsWav to true, which will give you the file in both formats.
  • Terminal Settings
    • ImmediatelyQuitOnceAllTasksAreDone set this to true to automatically close the AudioMog terminal once tasks are finished.
    • LogLevel Which messages should AudioMog's terminal show? (0: Nothing, 1: Errors only, 2: Errors & Warnings, 3: Everything)

Project Settings

Whenever you extract audio files using AudioMog, you also get a RebuildSettings.json file. Customizing RebuildSettings.json lets you control the repacking in a tighter manner.

  • UseWavFilesIfAvailable: When set to true, AudioMog accepts .wav & .hca files for rebuilding, instead of just .hca. (and prefers .wav first)
  • AdditionalOutputFolders: Specify folder paths here if you want AudioMog to output rebuilt files to these paths, too. (such as directly into your mod pak paths)
  • Originals: This is exclusive to music files, and is not used by AudioMog. It lets you see see the default values for music slices, so that you can copy and edit them in the Overrides section.
  • Overrides: If you wish to override a music slice's entry and exit samples, copy the original slice from Originals in here, and edit the sample values.

Music Slice Fix Settings

If you're editing music files, here are the fields you can put inside each entry of the Overrides array.

  • LoopStartSample: (optional) What sample does the music loop start at.
  • LoopEndSample: (optional) What sample does the music loop end at.
  • EntrySample: (optionial) What sample does the music file start at.
  • ExitSample: (optional) What sample does the music file end at.
  • All of these fields are entirely optional, but if you are replacing music files with different sample rates or lengths, you may need to mess with these.

Specific Games Notes

  • Kingdom Hearts III
    • Some files use sabf2.1 instead of sabf2.0, while no issues occur from replacing, keep in mind that if you find failures with such files, it may be due to unknown new features of the format.
    • Some .hca files use encryption, when AudioMog extracts those, it decrypts them. Therefore, the files you see are not the 'true' raw files, since you would not have been able to play or edit these.
  • Kingdom Hearts 0.2 Birth by Sleep -A fragmentary passage-
    • The files use .ogg format, but their looping information is instead stored in the .uexp. Therefore, the extracted .ogg files you will lose looping information. The converted .wav files have this looping information appended into them, however!
  • Kingdom Hearts: Melody of Memory
    • The files use abnormal amounts of . signs in the name, making it difficult to properly adjust file extensions. If you notice failures when rebuilding, it might be because of failures handling these file names!

Requirements

Build

  • The solution's projects use some C# 7 syntax, and as such require Visual Studio 2017 (or newer)

Credits

  • AudioMog is written by Yoraiz0r
  • Most of the knowledge applied in AudioMog's code comes from vgmstream
  • Special thanks to Ray Cooper, normie, ShonicTH, Jason Storey, and the entire OpenKH community!