ZeldaMods (Breath of the Wild) - User contributions [en]

Help:Dumping games

2024-06-05T02:53:30Z

Charlie43229: Added back "Before running Dumpling, disable auto power off and standby on your Wii U." to the website version.

In order to get a copy of the [[content]] files and [[executable]], you will need to dump ''Breath of the Wild'' from a console. This article provides instructions for Wii U and Switch users.

== Wii U ==
The easiest method for dumping BOTW in a manner compatible with tools like Cemu and BCML is to use Dumpling.

=== Prerequisites ===
* BOTW 1.5.0 on your Wii U
* Any Wii U (Method 1)
* Modded Wii U with Homebrew Launcher (Method 2)

=== Dumping your game files ===

==== Method 1 (Any Wii U) - Website ====

# Insert an SD card into your Wii U.
# Before running Dumpling, disable auto power off and standby on your Wii U.
# Insert any USB devices or game discs you’d like to use in the dump process.
# Launch the Internet Browser app.
# Go to https://dumplingapp.com/
# Select "Dump digital games" or "Dump a game disc" as appropriate.
# Select BOTW using the (A) button and then press (START) (selection N/A if using a disc). Make sure to check the boxes for base game, update, and (if applicable) DLC.
# Set the dump destination.
# Select (START) to begin dumping (which can take a ''very'' long time).
# Once finished, you can put the SD card into your PC and copy the files onto your hard drive.

==== Method 2 (Modded Wii U only) - Homebrew App ====
# Download the latest release of Dumpling from [https://github.com/emiyl/dumpling/releases here].
# Extract the ZIP to the root of your SD card.
# Before running Dumpling, disable auto power off and standby on your Wii U.
# Insert any USB devices or game discs you’d like to use in the dump process.
# Open Dumpling from the Homebrew Launcher.
# Select "Dump digital games" or "Dump a game disc" as appropriate.
# Select BOTW using the (A) button and then press (START) (selection N/A if using a disc). Make sure to check the boxes for base game, update, and (if applicable) DLC.
# Set the dump destination.
# Select (START) to begin dumping (which can take a ''very'' long time).
# Once finished, you can put the SD card into your PC and copy the files onto your hard drive.

== Switch ==
Dump the game files directly to your SD card using nxdumptool. Update data can only be processed if the base game is available, because they share the same filesystem. DLCs don't, so they have to be dumped separately.

'''Warning''': If you misbehave (piracy, online cheating or anything equally stupid), you might get banned from Nintendo online services. If you do not want to leave any traces, turn on airplane mode, back up your eMMC '''before running any homebrew''' and do not ever go online before you have restored the backup.

=== Prerequisites ===
* [https://github.com/DarkMatterCore/nxdumptool nxdumptool].
* Keys file generated using [https://github.com/shchmue/Lockpick_RCM Lockpick_RCM], located at <code>sdmc:/switch/prod.keys</code>. Run the payload on your console through RCM in order to dump the keys needed by nxdumptool to decrypt contents.

=== Dumping game files ===
* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>RomFS options</code>.
* Highlight the <code>Use update/DLC</code> option and use the left/right buttons to cycle through the available updates/DLCs for the game.
*# '''If you have no available updates/DLCs''', this option won't appear. You'll only be able to dump the files from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates are tagged as <code>(UPD)</code>, and they use <code>01007EF00011E800</code> as their ID. v786432 (0.0.12.0) corresponds to BotW v1.6.0 update.
*# DLCs are tagged as <code>(DLC)</code>. <code>01007EF00011F001</code> and <code>01007EF00011F002</code> are the known IDs for the existent BotW DLCs.
* Select <code>RomFS section data dump</code> and wait for the process to finish. This will dump the internal filesystem from the selected update/DLC to the inserted SD card.

Just like it was previously mentioned, updates share their filesystem data with the base game, so dumping the RomFS from an update is equivalent to dumping the whole filesystem from the updated game data. In other words, it isn't necessary to dump the base game filesystem separately if you choose an update.

DLCs, on the other hand, must be dumped separately.

When you're done, you'll be able to find the output dumps in <code>sdmc:/switch/nxdumptool/RomFS</code>.

It is recommended to copy these dumps to your PC, for use with modding tools and to free up space on your SD card.

=== Dumping binaries (executable files) ===
Executables in Switch titles are stored in a different section known as the ExeFS, which is only available in base games and updates. Unlike RomFS data, ExeFS data isn't shared between the update and its base game.

These files can also be dumped using nxdumptool.

* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>ExeFS options</code>.
* Highlight the <code>Use update</code> option and use the left/right buttons to cycle through the available updates for the game.
*# '''If you have no available updates''', this option won't appear. You'll only be able to dump the binaries from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates use <code>01007EF00011E800</code> as their ID. v786432 corresponds to BotW v1.6.0 update.
* Select <code>ExeFS section data dump</code> and wait for the process to finish. This will dump the binaries from the selected update to the inserted SD card.

When you're done, you'll be able to find the output dump in <code>sdmc:/switch/nxdumptool/ExeFS</code>.

Help:Dumping games

2024-05-14T22:45:25Z

Charlie43229: Added the web version of Dumpling to the Wii U section as an additional method

In order to get a copy of the [[content]] files and [[executable]], you will need to dump ''Breath of the Wild'' from a console. This article provides instructions for Wii U and Switch users.

== Wii U ==
The easiest method for dumping BOTW in a manner compatible with tools like Cemu and BCML is to use Dumpling.

=== Prerequisites ===
* BOTW 1.5.0 on your Wii U
* Any Wii U (Method 1)
* Modded Wii U with Homebrew Launcher (Method 2)

=== Dumping your game files ===

==== Method 1 (Any Wii U) - Website ====

# Insert an SD card into your Wii U.
# Insert any USB devices or game discs you’d like to use in the dump process.
# Launch the Internet Browser app.
# Go to https://dumplingapp.com/
# Select "Dump digital games" or "Dump a game disc" as appropriate.
# Select BOTW using the (A) button and then press (START) (selection N/A if using a disc). Make sure to check the boxes for base game, update, and (if applicable) DLC.
# Set the dump destination.
# Select (START) to begin dumping (which can take a ''very'' long time).
# Once finished, you can put the SD card into your PC and copy the files onto your hard drive.

==== Method 2 (Modded Wii U only) - Homebrew App ====
# Download the latest release of Dumpling from [https://github.com/emiyl/dumpling/releases here].
# Extract the ZIP to the root of your SD card.
# Before running Dumpling, disable auto power off and standby on your Wii U.
# Insert any USB devices or game discs you’d like to use in the dump process.
# Open Dumpling from the Homebrew Launcher.
# Select "Dump digital games" or "Dump a game disc" as appropriate.
# Select BOTW using the (A) button and then press (START) (selection N/A if using a disc). Make sure to check the boxes for base game, update, and (if applicable) DLC.
# Set the dump destination.
# Select (START) to begin dumping (which can take a ''very'' long time).
# Once finished, you can put the SD card into your PC and copy the files onto your hard drive.

== Switch ==
Dump the game files directly to your SD card using nxdumptool. Update data can only be processed if the base game is available, because they share the same filesystem. DLCs don't, so they have to be dumped separately.

'''Warning''': If you misbehave (piracy, online cheating or anything equally stupid), you might get banned from Nintendo online services. If you do not want to leave any traces, turn on airplane mode, back up your eMMC '''before running any homebrew''' and do not ever go online before you have restored the backup.

=== Prerequisites ===
* [https://github.com/DarkMatterCore/nxdumptool nxdumptool].
* Keys file generated using [https://github.com/shchmue/Lockpick_RCM Lockpick_RCM], located at <code>sdmc:/switch/prod.keys</code>. Run the payload on your console through RCM in order to dump the keys needed by nxdumptool to decrypt contents.

=== Dumping game files ===
* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>RomFS options</code>.
* Highlight the <code>Use update/DLC</code> option and use the left/right buttons to cycle through the available updates/DLCs for the game.
*# '''If you have no available updates/DLCs''', this option won't appear. You'll only be able to dump the files from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates are tagged as <code>(UPD)</code>, and they use <code>01007EF00011E800</code> as their ID. v786432 (0.0.12.0) corresponds to BotW v1.6.0 update.
*# DLCs are tagged as <code>(DLC)</code>. <code>01007EF00011F001</code> and <code>01007EF00011F002</code> are the known IDs for the existent BotW DLCs.
* Select <code>RomFS section data dump</code> and wait for the process to finish. This will dump the internal filesystem from the selected update/DLC to the inserted SD card.

Just like it was previously mentioned, updates share their filesystem data with the base game, so dumping the RomFS from an update is equivalent to dumping the whole filesystem from the updated game data. In other words, it isn't necessary to dump the base game filesystem separately if you choose an update.

DLCs, on the other hand, must be dumped separately.

When you're done, you'll be able to find the output dumps in <code>sdmc:/switch/nxdumptool/RomFS</code>.

It is recommended to copy these dumps to your PC, for use with modding tools and to free up space on your SD card.

=== Dumping binaries (executable files) ===
Executables in Switch titles are stored in a different section known as the ExeFS, which is only available in base games and updates. Unlike RomFS data, ExeFS data isn't shared between the update and its base game.

These files can also be dumped using nxdumptool.

* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>ExeFS options</code>.
* Highlight the <code>Use update</code> option and use the left/right buttons to cycle through the available updates for the game.
*# '''If you have no available updates''', this option won't appear. You'll only be able to dump the binaries from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates use <code>01007EF00011E800</code> as their ID. v786432 corresponds to BotW v1.6.0 update.
* Select <code>ExeFS section data dump</code> and wait for the process to finish. This will dump the binaries from the selected update to the inserted SD card.

When you're done, you'll be able to find the output dump in <code>sdmc:/switch/nxdumptool/ExeFS</code>.

Help:Sound modding

2024-04-27T17:21:53Z

Charlie43229: Shared a method of circumventing the BFWAV duration limit using Switch Toolbox and slightly reworded surrounding text. Also added Switch Toolbox to the prerequisites.

You'll need to understand the files in this game and how they work to get a good grasp on what you need to do to achieve the goals you want. This guide will show you how replace simple tracks in the game with ones you want. An illustrated guide can be found [https://gamebanana.com/tuts/13088 here] To replace bigger/more complex tracks, follow the advanced guide here (tutorial incomplete/not made yet).

To see what can be done in music modding and have a reference point, there are examples such as [https://gamebanana.com/gamefiles/10178 Lylah's Complete Music Overhaul] which has modded over 210 music files in the game that function just how the base game's files do, employing the methods found here.

==The 4 main sound files==
There are 4 types of files you mostly need to concern yourself with in music modding:

*'''BFSTM''' (.bfstm) "Binary Cafe Stream" files
*'''BFSTP''' (.bfstp) "Binary Cafe Stream Prefetch" files
*'''BFWAV''' (.bfwav) "Binary Cafe Wave" files
*'''Bars''' (.bars) files

BFSTMs are the main music files in this game, which you can find under content/Sound/Resource/Stream in the unpacked base game folder and DLC music in the Update Data folder. When making a mod, always treat it as an 'update' so anything you make goes in one 'content' file structure.

BFSTPs are essentially the precursor of BFSTMs. A lot of BFSTMs can't play immediately as the game has to load them in, so in order to avoid that, there are "prefetch" files for each of these BFSTMs that contain compressed data of their respective file and only play for 1 second before switching over to the BFSTM to play the rest. These are known as BFSTPs.

BFWAVs are another type of music file that are only for smaller sounds, short events, almost every sound effect in the game, etc.

'''All''' BFWAVs and BFSTPs are contained within '''Bars''' files. Bars files are simply containers for these files, and can contain multiple BFSTPs or BFWAVs within them if they concern one object/category (e.g: Guardian sword sfx). These can be found under content/Sound/Resource in the update folder for the game data.

'''IMPORTANT:''' ''This game's sound files have a sample rate '''32000Hz''' for the Wii U version, and '''48000Hz''' for the Switch version. The music you get from Youtube and most MP3s are usually in '''44100Hz''' or above, so make sure to convert before you start working on your new files. All your music mods should be using the appropriate sample rate to avoid distortions and glitches.''

For simple files, such as the one that plays near the Temple of Time, you only need to worry about 1 BFSTM file. In this case: the file would be ''BGM_Spot_TempleOfTime.bfstm''. This goes for other BGM_Spot files you may want to mod. However, if you want to replace the music for things that can start spontaneously, such as a Guardian battle (Stalkers/Skywatchers), that has at least 5 files associated with it: ''BGM_Guardian_main.bfstm'', ''BGM_Guardian_outro.bfstm'', and '''GuardianBGM.bars''' which contains BGM_Guardian_main.'''bfstp''' and BGM_Guardian_outro.'''bfstp'''.
This guide will go through how to replace the Temple of Time music as an example, and then the Guardian BGM later as it needs more steps. To mod only the former, only the 1st and 2nd resources listed below are required, but it is recommended to obtain everything in the list to make modding simpler in the future.

==Prerequisites==

#A music editing software of your choice, e.g: Wavepad Sound Editor or Audacity
#[https://github.com/libertyernie/LoopingAudioConverter/releases Looping Audio Converter]
#[https://github.com/NanobotZ/bfstp-fixer bfstp fixer]
#[https://github.com/aboood40091/BCFSTM-BCFWAV-Converter BCFSTM-BCFWAV Converter]
#Python 3.7
#[https://github.com/NanobotZ/BarsTool/releases Bars Tool]
#VLC Media player for previewing BFSTM files (not necessary but highly recommended)
#NW4F Wave converter for converting Wav files to BFWAV
#[https://www.foobar2000.org/ Foobar2000 Media Player] and [https://github.com/vgmstream/vgmstream vgmStream plugin] for previewing/converting BFWAV and BFSTM files. Foobar2000's [https://www.foobar2000.org/FAQ FAQ] page has instructions for installing the plugin.
#[https://github.com/KillzXGaming/Switch-Toolbox/releases Switch Toolbox] for editing sample limits of BFWAV files

==Creating a new sound==
Using the Temple of Time as an example, the fundamentals of this guide apply to any future tracks you make in terms of looping.

First, preview the actual original game file you're replacing so that you are aware of how long it is and what constraints you should roughly keep your new file in (there's nothing wrong with making a loop a minute or so longer than normal for BGM_Spots, but it is not recommended for other tracks as it may function abnormaly).

===Creating a loop===
Assuming you have a file or sample you want to use, open it up in a sound editor or software of your choice. This guide uses Wavepad, as it is perfect for this type of editing.
[[File:Wavepad_Demo_1.png|thumb|A file open in Wavepad, the sample rate is 41000Hz, which must be converted to 32000Hz before edits are made.]]

====Editing the sound====
Make the edits as you wish to your file, such as volume adjustment (ideally near the original file's), reverb, fades, equalising, mixing, etc. If the file is very 'droney' (like a choir) with little percussion or fades out, you can do an easy trick as shown below.
[[File:Wavepad_Demo_2,_Selecting_Intro.png|thumb|A zoomed in image of the selection process in Wavepad to create a seamless loop from the outro back into the main song.]]
Select a portion of the beginning of the song, find out precisely what ''sample'' you have selected it to (A sample is the most precise unit of song editing, as milliseconds are too imprecise here), and note it down. Then copy/paste your selection onto a new file and give it a fade in. After that, copy that file and paste mix it into the last part of the original song you are using so the intro fades in while the outro fades out.
Make a note of where your '''new endpoint''' for the song is (in samples, not milliseconds), and delete any excess space after that. If for some reason the editor you're using doesn't show the ''sample'', get as accurate a time as possible (down to the one-thousanths of a second), and multiply that time, in seconds, by the sample rate of the file (e.g. 7.052 seconds * 48000Hz = 338,496 sample).

IMPORTANT: When you are creating a loop, you must ensure that the start point and end point of the loop are ideally when the wave form reaches 0 amplitude, and one wave is coming up while the other is going down, to ensure optimal flow. This is how you achieve seamless loops. Failure to adhere to these principles means skips, clicks, 'pops' or static will be heard when the song loops.

Save your file as a .wav and then open it up in '''Looping Audio Converter'''.

====Entering loop data====
When opening Looping Audio Converter, the setup should remain relatively untouched apart from 3 areas:

*Save directory (can be anywhere you want that's the easiest to access)
*Output Format (should be BFSTM)
*Loop Information option (should be set to 'Ask for all files')

[[File:File_open_in_Looping_Audio_Converter.png|thumb|The parameters highlighted should be the only ones changed to what is seen. The directory can be set to the quickest place to grab the outputted file from (e.g: Desktop)]]
Click 'Start' and then a prompt should appear allowing you to enter your loop data in samples, which will be simple since you made a note of the points earlier. Ensure the 'Enable' and 'Loop' boxes are checked, and click 'Okay'. This should output your wav as a BFSTM with the loop data written onto it. Rename your new track to the original name of the track you wanted to replace. It is now ready to be used in your mod. BFSTMs are stored under content/Sound/Resource/Stream.

====Tracks that require a prefetch (.bfstp)====
Some tracks need to be loaded in by a one-second prefetch that contains compressed data of the BFSTM, and you can find these by analysing the list of .bars file to see if your track has one. All sound effects and battle themes have a bfstp stored inside a respective .bars file, e.g: ''GuardianBGM.bars'' contains the prefetches for the main Guardian theme and outro. Assuming you followed the same looping steps as mentioned above, you should have a Guardian_Main theme that loops, and a Guardian_Outro that does not loop (select 'Keep as non-looping' in Looping Audio Converter). Once the new BFSTMs have been made, you should follow the [https://gamebanana.com/tuts/12856 bfstp fixer] method, where you place bfstpfixer.py, BCFSTM-BCFWAV-Converter, your BFSTMs, and a .bat file with the following code:

'''For Wii U''' 
<nowiki>for /r %%i in (*.bfstm) do python main.py -format FSTP -bom 0 "%%i"</nowiki> 
<nowiki>for /r %%i in (*.bfstp) do python bfstpfixer.py "%%i"</nowiki>

'''For Switch''' 

*'''Important:''' ''The first line is used to also convert your current BFSTM(s) to use a little endian, since Looping Audio Converter converts using a big endian. Be sure to copy the new BFSTMs into your working folder after they've been converted, otherwise your audio won't play ingame.'' 

<nowiki>for /r %%i in (*.bfstm) do python main.py -format FSTM -bom 1 "%%i"</nowiki> 
<nowiki>for /r %%i in (*.bfstm) do python main.py -format FSTP -bom 1 "%%i"</nowiki> 
<nowiki>for /r %%i in (*.bfstp) do python bfstpfixer.py "%%i"</nowiki>

in the same directory and run the .bat file. This should output 2 new files for each BFSTM you had. Keep the .bfstps that have 'fixed' at the end of their name.
[[File:The_directory_of_the_BFSTP_fixer_immediately_after_running_the_.bat_file.png|thumb]]
Make a copy of the .bars file you want to modify and place it somewhere safe to work with to avoid accidentally tampering with the game's core files. Open up the new copy of the .bars file and observe the names of the specific files you want to replace. They should have a similar or identical name to the BFSTMs they are made for. Rename your new files to these names respectively, and then click 'Replace' for every file you are replacing.
[[File:A_file_open_in_Bars_Tool.png|thumb|GuardianBGM.bars open in Bars Tool, showing the various BFSTPs and BFWAVs inside.]]
A backup .bars file will be generated once you do so that contains the bars data before you made any edits, and the original file is now updated with your new data. Place the modified bars file into content/Sound/Resource of your mod folder, and your BFSTMs in content/Sound/Resource/Stream, and you should now have a working music mod without any glitches or abnormalities.

====Sound effects (SFX) and BFWAVs====
Almost every sound effect in the game is in .bfwav format, and are also stored in .bars files. If a replacement BFWAV you make is not shorter than or the exact same length as the original file you are modding (which you can check by opening it in Foobar2000), you can open the .bars file with Switch Toolbox and edit the limit. Edit the "Unknown" paramater in the Meta Data for your .bfwav to be equal to or greater than the sample count of your new sound. If/when your new sound effect in .wav format complies with this limit, you can simply drag it over the NW4FWaveConverter.exe and it should output a new bfwav of your file. Then, using the Bars tool as previously mentioned, replace the old bfwav with your new one and implement the new .bars file into your mod.

[[Category:Guides]]