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

Help:Adding items

2025-11-25T22:30:41Z

Nebroc: Added link to Icon maker

Mods that deal with items will often edit items that already exist in the game. However, this can lead to conflicts between mods, so it is generally advised to make a new item, instead. This tutorial will cover all of the steps needed to add new items.

Two methods are provided. Using BotW Actor Tool is much simpler, but it is in a beta state and may have bugs.

==Required tools==
Adding new items requires several tools, most of which are described and are available [[Help:Setting up tools|here]].

Both methods require the following:
*[https://www.python.org/downloads/release/python-379/ Python 3.7] (64-bit) or [https://www.python.org/downloads/release/python-3810/ Python 3.8] (64-bit) is necessary for just about every tool.
*[https://github.com/KillzXGaming/Switch-Toolbox/releases Switch Toolbox]
*BOTW Cross-Platform Mod Loader (or <code>bcml</code>) {{Install py package help|package=bcml}}

The new method requires:
*BotW Actor Tool {{Install py package help|package=botw_actor_tool}}

The old method requires:
*A text editor like [https://notepad-plus-plus.org/downloads/ Notepad++]
*Wild Bits {{Install py package help|package=wildbits}}
*Hyrule Builder {{Install py package help|package=hyrule_builder}}
*BOTW Flag Utilities {{Install py package help|package=botw_flag_util}}

==Using BotW Actor Tool==

===Creating a mod directory===
The folder structure is important, as BotW will only load files if they're in a certain location. To begin with, you will want to create a folder structure that looks like this:

*BreathOfTheWild_[MyAwesomeModName]
**content
***Actor*
****Pack*
***Model
***Pack*
***UI
****StockItem

Starred folders will be created by the actor tool if they don't already exist. Note that the folder names are case-sensitive.

===Setting up the tool===
Open a command prompt (WinKey + R, enter <code>cmd</code>) and use the command <code>botw_actor_tool</code> to open it.

If this is your first time using the actor tool, set your paths in the settings menu. If you set them wrong, the tool will warn you. They should be set as follows:
* Game directory should be the content folder of your base game dump. Example: <code>C:\Games\BotW\basegame\content</code>
* Update directory should be the content folder of your update dump. Example: <code>C:\Games\BotW\update\content</code>
* DLC directory should be the 0010 folder of your DLC dump. Example: <code>C:\Games\BotW\DLC\content\0010</code>
* Language should be set to the region and language you use. For example, USen is for United States English, while EUes is for European Spanish.

===Opening the base actor===
Use File -> Open Vanilla Actor to open a list of all actors from vanilla BotW. Pick the actor from the list that most closely matches your new desired item. (e.g. if you want to create a wooden shield, you would pick an actor for one of the base game's wooden shields).

Use https://github.com/MrCheeze/botw-tools/blob/master/botw_names.json for help finding item

Once the tool has loaded the actor data, click on the Model button in the Actor Property box at the top, then scroll to the bottom. There should be a single line that says <code>Folder</code>. Take note of what it says after that, as that is the name of the <code>sbfres</code> file that you will need in [[#Creating your item's resource files]]. Then switch back to the Actor Link tab by clicking on the Actor Link button in the Actor Property box.

===The Actor Link tab===
The Actor Link tab contains the name of your item, the names of the unique files your actor uses, plus some other tidbits. Click on the Actor Name field, and change the name to whatever new name you want, then hit the Apply button to the right of that text field.

Make sure your item's tags (at the bottom) are correct. The tag for a dyable armor is <code>ArmorDye</code>, the tag for a weapon that can have a picture taken for the compendium is <code>ZukanWeapon</code>, anything that can be equipped has the tag <code>CanEquip</code>, etc. If you make a change, make sure to hit the Apply button to the right before moving on.

===The General Param tab===
This tab contains most of the information about the stats of items. For example, a weapon/shield's durability, a weapon's damage, a shield's block rate, an armor's defense, an armor's set (and therefore set bonus) are all stored here. You may want to change some of these things. A comprehensive list of the things that can appear in this tab is available [[Bgparamlist|here]]. Commonly changed parameters include: <code>Life</code> (the durability of the item, in the <code>General</code> category), <code>Power</code> (a weapons' damage, in the <code>Attack</code> category), <code>DefenceAddLevel</code> (an armor's defense rating, in the <code>Armor</code> category)

If your item is an armor that is upgradable, change the line that says <code>NextRankName: !str64 [ActorName]</code> to the actor name for the actor that this one upgrades into. (In game terms, "upgradable" means via the Great Fairies. If your armor is not upgradable, put <code>!str64 ""</code>)

Make sure to click the save button at the bottom before moving on.

===The Model tab===
On this tab, there will be a line toward the bottom that says <code>Folder:</code>.

If your item is an armor piece, this may not match your new armor name. Be sure to check, and change it, if necessary. Note that, if you do need to change it for an armor, you should not include the <code>_Head</code>, <code>_Upper</code>, or <code>_Lower</code> as part of the new Folder.

Whether or not your item is an armor piece, take note of what the Folder field now says. This will be the name for your resource files.

If you changed anything, make sure to click the save button at the bottom before moving on.

===The Texts tab===
This tab contains the entries for what text will be shown by the game.
*If your item is a cookable that has more than one recipe result (like a mushroom skewer) then you should set the BaseName to what you want displayed for its name. Otherwise, the BaseName is not used.
*Set the Name to what you want your item to be named.
*Set the Desc to what you want the inventory to display as the description of your item, when you select it.
*If your item can have a picture taken of it and be put in the compendium, set the PictureBook to field to what you want the compendium summary of the item to be. This is often a copy of Desc.

Again, if you changed anything, make sure to click the save button at the bottom before moving on.

===Saving your item===
Click File -> Save, and then pick the <code>content</code> folder you created in the [[#Creating the mod directory]] step. The tool should freeze for a little less than 10 seconds while it packages all the item's data and saves all the necessary files. This should properly create <code>Actor/ActorInfo.product.sbyml</code>, <code>Pack/Bootup.pack</code>, <code>Pack/Bootup_XXxx.pack</code> (where XXxx is your region/language), and your item's <code>sbactorpack</code> file.

===Creating your item's resource files===
You'll need to copy the resources for the original item that you're modifying to your mod's <code>content\Model</code> folder. You will find the original resource files in your dumped UPDATE files (not the base game files), in the same location. (<code>content\Model</code>) The files you're looking for are the ones that whose names match the <code>Folder</code> field you took note of during the [[#Opening the base actor]] step. There should be two files, one with an <code>sbfres</code> extension (the model) and one with a <code>Tex.sbfres</code> extension. '''If you are modding for WiiU or Cemu, there are actually three files you will need: <code>sbfres</code>, <code>Tex1.sbfres</code>, and <code>Tex2.sbfres</code>. If <code>Tex1.sbfres</code> is not present in your UPDATE files, you will need to find it in your BASE GAME dumped files. This is the case for most, if not all, vanilla (non-DLC) items.'''

Once you have copied the old files to the new location, you need to rename them to whatever it said in the <code>Folder</code> field you took note of during [[#The Model tab]] step.

The bulk of the [[Help:Replacing models|model replacement]] and [[Help:Replacing textures|texture replacement]] is explained in the tutorials linked there. Once you've used those tutorials to replace the bulk of the data, we can change the names that BotW uses to refer to that data. All the rest of this section assumes that you have both <code>sbfres</code> files for your actor open in Switch Toolbox. (If on WiiU, you don't need to open the Tex2 file. Switch Toolbox will read its data whenever you open the Tex1 file, as long as they are in the same folder.)

The first thing to change is the <code>bfres</code> name. This did not happen automatically when you renamed the file. You can do this by clicking on the orange file labeled "FRES" on the left side, clicking on the name on the right side, and changing it.

Some important terms in modeling:
A "model" is the 3D data for a whole actor. The models are everything that is inside the <code>Models</code> folder inside the <code>sbfres</code> file.
An "object" is the 3D data for a piece of an actor. The objects are everything that is inside the <code>Objects</code> folders inside the <code>Models</code> folder.
A single model will be made up of one or more objects.
A "material" is the data the game uses to "paint" a model, so that it knows what color it is, how it reflects light, whether or not it's shiny or dull, etc. The materials are everything that is inside the <code>Materials</code> folders inside the <code>Models</code> folder.
A "texture" (or "map") is a single picture that contains color, light reflection, metallic, or other data for a material. Textures are contained separately, in the <code>Tex.sbfres</code> file. (<code>Tex1.sbfres</code> for WiiU/Cemu)
A material will consist of one or more textures, plus shader data. (The author of this tutorial doesn't even really understand shaders. Sorry.)
Each model will contain one or more materials. Each object will be assigned one material. A single material may be assigned to any number of objects.

The name of the model (inside the <code>Models</code> folder) is important, as the game will not load the actor if the model name doesn't match your item's actor name as you entered it in the actor tool! Object names can be arbitrary, but they generally follow the rule: <code>[ObjectName]__[MaterialName]</code> where <code>[ObjectName]</code> is whatever you want, and <code>[MaterialName]</code> is the name of the material assigned to it. Adhering to this naming convention is encouraged, so that if anyone else ever tries to reuse your files, they can make sense of them.
Click on the model name on the left side that you need to change. On the right side, near the top, the model name will be displayed. Click on that to edit it, and change it to your new mesh name that you used in the actor pack and actor info files. If successful, it will also change on the left side.
You may also change the names of the objects and materials in the same way.
When changing the names of the materials, on the right side, there will be a tab labeled Textures that will be selected by default. It will contain the names of all the textures being used by that material, and these will all be the names of the old textures. Switch over to the texture <code>sbfres</code> now, and change all the textures to names that fit your new actor.
When you are done changing all the names of the textures, switch back to the model <code>sbfres</code> and look at the Textures section of the material. Click on one of the entries in the table (for example, <code>[OldModelName]_Alb</code>) and then click on Edit. A new window will pop up, with a list of all the textures contained in the texture <code>sbfres</code>. Choose the one that corresponds with the new texture (for example, <code>[NewModelName]_Alb</code> or <code>[NewModelName]_Alb.0</code>) and click save. Do this for all the entries in the Textures table for this material, and then repeat the process for every other material.

If you are editing an armor that is dyeable, you then need to expand the Animations folder on the left, then Texture Pattern Animations, then right-click the folder that corresponds to your item (Head for the head, Upper for the torso, Lower for the legs). Select Export, select to save as "Yet Another Markup Language" (or YAML Ain't Markup Language, if it's been since changed to the official name) and save it somewhere. Open the new <code>yaml</code> file that you just saved in a text editor. You will need to edit all the texture and material names to the new ones. For example, changing <code>[OldModelName]_Alb.0</code> to <code>[NewModelName]_Alb.0</code> and <code>[OldMaterialName]</code> to <code>[NewMaterialName]</code> (e.g. <code>Mt_Hood_001</code> to <code>Mt_Hood_9001</code>). Save it, then, back in Switch Toolbox, right-click on the folder inside Texture Pattern Animations that corresponds to your item, and select Replace. Select the <code>yaml</code> you edited.

When you are done, select any file or folder from the model <code>sbfres</code>, in the list on the left, and save it. Switch Toolbox will ask if you want to Yaz0 compress the file, click Yes. Then click on any file or folder from the texture <code>sbfres</code>, in the list on the left, and save it. Switch Toolbox will again ask if you want to Yaz0 compress the file, click Yes. If you are editing a WiiU texture <code>sbfres</code>, it will then ask you to save the Tex2 sbfres, so save it and Yaz0 compress it, as well. And that's it, you are done with the files that tell the game what the new item looks like.

===Creating an inventory icon===
This section covers the inventory icons, the square images you see in the inventory grid in the pause menu. These files are kept in <code>content\UI\StockItem</code> for inventory items. Copy the old <code>sbitemco</code> file for the item you are using as your foundation, to the same location in your mod files (<code>content\UI\StockItem</code>). An <code>sbitemco</code> file is pretty much the same thing as an <code>sbfres</code> for textures, so you will edit it the same way, using Switch Toolbox. Make sure to change the name of the file to <code>[NewActorName].sbitemico</code>, the name of the file it contains in Toolbox to <code>[NewActorName].bitemico</code>, and the texture it contains to <code>[NewActorName]</code>

Note: You can also very easily creating your own icon from a png using [https://gamebanana.com/tools/16205 this tool].

===Installing the mod===
And now you are done! Basically! Use the directions located [[Help:Using_mods#Installing_mods_with_the_graphic_pack_menu|here]] to make a rules.txt if you haven't already. To use the mod, open <code>bcml</code> via command prompt (just run the command <code>bcml</code>) and click the blue circle in the bottom right. Then select Browse, select the rules.txt inside your <code>BreathOfTheWild_[MyAwesomeModName]</code> folder, and click Install. Wait for it to install, and you're ready to play the game with your new item!

==Using text editors and WildBits==

===Before we begin===
'''Do not skip this section, it is very important.'''

This tutorial will use several terms that you may not be familiar with, or will have specific definitions you may not have used before:

*File name (or FileName) - the name of a file. For example, for the file <code>Armor_001.sbfres</code>, the FileName is <code>Armor_001</code>
*File extension (or FileExtension) - the type/extension of a file. For example, for the file <code>Armor_001.sbfres</code>, the FileExtension is <code>sbfres</code>
*Actor name (or ActorName) - the code name of the item, and the FileName of the actor pack. For example, the Hylian Tunic is <code>Armor_001_Upper</code>.
*<code>bfres</code> name (or BfresName) - the code name of the resource files containing the model and texture data for the actor, and the FileName of the <code>bfres</code> for an actor. For example, the Hylian Tunic is part of the Hylian Set and all Hylian Set resources are contained inside <code>Armor_001</code>. In general, an armor's BfresName is the first two parts of its ActorName (e.g. <code>Armor_001</code> out of <code>Armor_001_Upper</code>). This tutorial uses <code>sbfres</code> and <code>bfres</code> mostly interchangeably, but you can think of an <code>sbfres</code> as a ZIP archive that contains a <code>bfres</code>.
*Model name (or ModelName) - the code name of the model inside the resource files to be used. In almost all cases, this is the same as the ActorName. The only exceptions to this are for head armor models that have a mantle variant, like <code>Armor_001</code>. Their ActorName will end in <code>_Head</code>, and their ModelName will end in <code>_Head_A</code>.
*Old - if something is referred to as "old," that means any files you are using as the base files for your new item. For example, if you are creating a new shield that performs similarly to <code>Weapon_Shield_001</code> (is a shield, is wooden, etc.) and you were copying its files to your mod, then <code>Weapon_Shield_001</code> would be the "old" actor name.
*New - anything that refers to the new item you are making. If something is not referred to as "old" or "new," then it is new. For example, if you are making <code>Armor_9001_Head</code> then that will be referred to as either the NewActorName and the ActorName.

Vanilla weapons have the same name as their actor, model, and <code>bfres</code> names. For example, the actor <code>Weapon_Sword_001</code> has the model name <code>Weapon_Sword_001</code> and its resource files are in <code>Weapon_Sword_001.sbfres</code>.

Note that anytime brackets are used, this means that whatever is inside the brackets should be replaced with something else. For example, <code>Bootup_[XXxx].pack</code> could be replaced with <code>Bootup_USen.pack</code> or <code>Bootup_EUen.pack</code> or other names. Do NOT leave the brackets in there. Another example might be <code>[FileName].[FileExtension]</code> which could be replaced with just about anything, like <code>Weapon_Sword_001.bxml</code> or <code>Link.Tex1.sbfres</code>. (Note that, in this case, "Link.Tex1" is the file name and <code>sbfres</code> is the file extension)

If you are ever told to open a Powershell window and run a command, you can do that by holding shift, right-clicking somewhere inside the folder and clicking on "Open Powershell window here." Anytime you do this, it will be to run a Python script.

===Setting up your folder structure===
The folder structure is important, as BotW will only load files if they're in a certain location. To begin with, you will want to create a folder structure that looks like this:

*BreathOfTheWild_[MyAwesomeModName]
**content
***Actor
****Pack
***Model
***Pack
***UI
****StockItem

Note that these names are case-sensitive.

===Creating the actor===
First, figure out what item (that already exists in game) behaves closest to your new item. Find the <code>sbactorpack</code> file for that item, and copy it to <code>content\Actor\Pack</code>. You will find the original file in your dumped UPDATE files (not the base game files), in the same location. (<code>content\Actor\Pack</code>) Make sure you copy it, and don't move the original.

Next, copy <code>ActorInfo.product.sbyml</code> to <code>content\Actor</code> in your mod files. You can find it in your dumped UPDATE files (not the base game files), in the same location. Make sure you copy it, and don't move the original.

Then, copy both <code>Bootup.pack</code> and <code>Bootup_[XXxx].pack</code> to <code>content\Pack</code> in your mod files. You can find them in your dumped UPDATE files (not the base game files), in the same location. There will be several <code>Bootup_[XXxx].pack</code> files. Each one is for a different region and language. For example, USen is for the US version, English language, while EUes is for the European version, Spanish language. Copy only the one(s) you will be making edits for, as any languages that you don't edit will have entries automatically copied into them by one of the later steps in the tutorial. For example, if you edit USen and EUes, EUen will receive your custom entries from USen, and USes will receive your custom entries from EUes.

Lastly, copy your resource files to <code>content\Model</code> (models and textures) and <code>content\UI\StockItem</code> (icons). These files aren't handled by the converter, they're explained more in depth in their own section of the tutorial.

Once you have your mod files assembled navigate to the folder that contains your BreathOfTheWild_[MyAwesomeModName] folder, open a Powershell window, and run the command <code>hyrule_builder unbuild BreathOfTheWild_[MyAwesomeModName]</code>. It will take a bit of time to convert the files, and then create a new folder called BreathOfTheWild_[MyAwesomeModName]_unbuilt, which contains the files you will be editing.

===Editing the actor pack files===
The actor pack files will be located in the various folders inside <code>content\Actor</code>. There will be certain parts of the files that you need to change. All instances of the old actor, model, and BFRES names will need to be changed to the new actor, model, and BFRES names. The following is a list of many of the changes that need to be made, but note that some of these may not apply to your item, and there are some changes that may not appear in this list. Be thorough when you look through the files for things that may need to be changed.
[[File:Addingitems_aampfilenames.png|alt=Actor pack file name changes|thumb|The underlined items need to be changed for this actor pack (in addition to the actor pack name and the contents of each file)]]

*File/Folder names:
**changing the name of the <code>[ActorName].bmodellist</code> file inside <code>content\Actor\ModelList</code>
**changing the name of the <code>[ModelName].bphysics</code> file inside <code>content\Actor\Physics</code>
**changing the name of the <code>[ActorName].bxml</code> file inside <code>content\Actor\ActorLink</code>
**changing the name of the <code>[ActorName].bgparamlist</code> file inside <code>content\Actor\GeneralParamList</code>
**changing the name of the <code>[BfresName]</code> folder inside <code>content\Physics\SupportBone</code>
**changing the name of the <code>[ModelName].bphyssb</code> file inside <code>content\Physics\SupportBone\[BfresName]</code>
**changing the name of the <code>[BfresName]</code> folder inside <code>content\Physics\Cloth</code>
**changing the name of the <code>[ModelName].hkcl</code> file inside <code>content\Physics\Cloth\[BfresName]</code>
*Inside <code>bmodellist</code>:
**changing the line that says <code>Folder: !str64 [BfresName]</code> to the new <code>bfres</code> name
**changing the line that says <code>UnitName: !str64 [modelName]</code> to the new model name
*Inside <code>bphysics</code>:
**changing the line that says <code>support_bone_setup_file_path: !str256 [BfresName]/[ModelName].bphyssb</code> to the new <code>bfres</code> and model names
**changing the line that says <code>cloth_setup_file_path: !str256 [BfresName]/[ModelName].hkcl</code> to the new <code>bfres</code> and model names
**'''Do not change anything with "Havok" in the name as those point to data inside the hkcl file which we cannot change.''' Physics should work fine without changing data ''inside'' the <code>hkcl</code> file, as long as you do change the ''name'' of the <code>hkcl</code> file.
*Inside <code>bxml</code>:
**changing the line that says <code>ActorCaptureUser: [ActorName]</code> to the new actor name
**changing the line that says <code>GParamUser: [ActorName]</code> to the new actor name
**changing the line that says <code>ModelUser: [ActorName]</code> to the new actor name
**changing the line that says <code>PhysicsUser: [ModelName]</code> to the new model name[[File:Addingitems_bgparamlist.jpg|thumb|Example of two parameters commonly changed, inside the bgparamlist file.]]
*Inside <code>bgparamlist</code>:
**If your item is an armor that is upgradeable, changing the line that says <code>NextRankName: !str64 [ActorName]</code> to the actor name for the actor that this one upgrades into. (In game terms, "upgradeable" means via the Great Fairies. If your armor is not upgradable, put <code>!str64</code> noting the extra space after the 4)
**The <code>bgparamlist</code> file also contains most of the information about the stats of items. For example, a weapon/shield's durability, a weapon's damage, a shield's block rate, an armor's defense, an armor's set (and therefore set bonus) are all stored here. You may want to change some of these things. A comprehensive list of the things inside the <code>bgparamlist</code> file is available [[Bgparamlist|here]]. Commonly changed parameters include: <code>Life</code> (the durability of the item, in the <code>General</code> category), <code>Power</code> (a weapons' damage, in the <code>Attack</code> category), <code>DefenceAddLevel</code> (an armor's defense rating, in the <code>Armor</code> category).

Once you've made your changes, '''make sure to save'''.

===Adding the actor info===
The previous step saw you creating the actual actor. This step is for creating the actor metadata that the game uses so that it knows your new actor exists. It also stores most data that appears in menus like the pause menu, crafting menu, or store menus.

Inside <code>content\Actor\ActorInfo</code>, you will find a file for each actor in the game. Find the one for the old actor that you are using as your base, and copy it, changing the name of the new file to <code>[NewActorName].info.yml</code>, then open the file in a text editor. Change the following lines:

*<code>bfres: [BfresName]</code> to your new <code>bfres</code> name
*<code>itemUseIconActorName: [ActorName]</code> should have the [ActorName] replaced with just '''""''' if you're using your own icon, otherwise replace it with the actor name of the icon you'll be using
*<code>mainModel: [ModelName]</code> to your new model name
*<code>name: [ActorName]</code> to your new actor name
*Any additional information you changed in the actor pack that might be shown in any menu. For example, armor value of armor, defensive value of shields, damage of weapons, buying/selling price of items from/to a shop, crafting ingredients if the item is craftable, etc.

Once all the info is changed, '''make sure to save'''.

===Creating the resource files===
This section will cover the files that actually tell the game what the 3D model of the item looks like, in game. You'll need to copy the resources for the original item that you're modifying to your mod's <code>content\Model</code> folder. You will find the original resource files in your dumped UPDATE files (not the base game files), in the same location. (<code>content\Model</code>) The files will be called <code>[OldBfresName].sbfres</code> and <code>[OldBfresName].Tex.sbfres</code>. '''If you are modding for WiiU or Cemu, there are actually three files you will need: <code>[OldBfresName].sbfres</code>, <code>[OldBfresName].Tex1.sbfres</code>, and <code>[OldBfresName].Tex2.sbfres</code>. If <code>[OldBfresName].Tex1.sbfres</code> is not present in your UPDATE files, you will need to find it in your BASE GAME dumped files. This is the case for most, if not all, vanilla (non-DLC) items.'''

Once you have copied the old files to the new location, you will rename them to your new <code>bfres</code> name. Note that this name needs to match the <code>bfres</code> name you used when editing the actor pack files.

The bulk of the [[Help:Replacing models|model replacement]] and [[Help:Replacing textures|texture replacement]] is explained in other tutorials. Once you've used those tutorials to replace the bulk of the data, we can change the names that BotW uses to refer to that data. All the rest of this section assumes that you have both <code>sbfres</code> files for your actor open in Switch Toolbox. (If on WiiU, you don't need to open the Tex2 file. Switch Toolbox will read its data whenever you open the Tex1 file, as long as they are in the same folder.)

The first thing to change is the <code>bfres</code> name. This does not happen automatically when you change the <code>sbfres</code> name. You can do this by clicking on the orange file labeled "FRES" on the left side, clicking on the name on the right side, and changing it.

Some important terms in modeling:
A "model" is the 3D data for a whole actor. The models are everything that is inside the <code>Models</code> folder of the <code>[BfresName].sbfres</code> file.
An "object" is the 3D data for a piece of an actor. The objects are everything that is inside the <code>Models\[ModelName]\Objects</code> folder.
A single model will be made up of one or more objects.
A "material" is the data the game uses to "paint" a model, so that it knows what color it is, how it reflects light, whether or not it's shiny or dull, etc. The materials are everything that is inside the <code>Models\[ModelName]\Materials</code> folder.
A "texture" (or "map") is a single picture that contains color, light reflection, metallic, or other data for a material. Textures are contained separately, in the <code>[BfresName].Tex.sbfres</code> file. (<code>[BfresName].Tex1.sbfres</code> for WiiU/Cemu)
A material will consist of one or more textures, plus shader data. (The author of this tutorial doesn't even really understand shaders. Sorry.)
Each model will contain one or more materials. Each object will be assigned one material. A single material may be assigned to any number of objects.

The ModelName is important, as the game will not load the actor if the ModelName here does not match the ModelName used in the actor pack files and actor info file! Object names can be arbitrary, but they generally follow the rule: <code>[ObjectName]__[MaterialName]</code> where <code>[ObjectName]</code> is whatever you want, and <code>[MaterialName]</code> is the name of the material assigned to it. Adhering to this naming convention is encouraged, so that if anyone else ever tries to reuse your files, they can make sense of them.
Click on the model name on the left side that you need to change. On the right side, near the top, the model name will be displayed. Click on that to edit it, and change it to your new mesh name that you used in the actor pack and actor info files. If successful, it will also change on the left side.
You may also change the names of the objects and materials in the same way.
When changing the names of the materials, on the right side, there will be a tab labeled Textures that will be selected by default. It will contain the names of all the textures being used by that material, and these will all be the names of the old textures. Switch over to the texture <code>sbfres</code> now, and change all the textures to names that fit your new actor.
When you are done changing all the names of the textures, switch back to the model <code>sbfres</code> and look at the Textures section of the material. Click on one of the entries in the table (for example, <code>[OldModelName]_Alb</code>) and then click on Edit. A new window will pop up, with a list of all the textures contained in the texture <code>sbfres</code>. Choose the one that corresponds with the new texture (for example, <code>[NewModelName]_Alb</code> or <code>[NewModelName]_Alb.0</code>) and click save. Do this for all the entries in the Textures table for this material, and then repeat the process for every other material.

If you are editing an armor that is dyeable, you then need to expand the Animations folder on the left, then Texture Pattern Animations, then right-click the folder that corresponds to your item (Head for the head, Upper for the torso, Lower for the legs). Select Export, select to save as "Yet Another Markup Language" (or YAML Ain't Markup Language, if it's been since changed to the official name) and save it somewhere. Open the new <code>yaml</code> file that you just saved in a text editor. You will need to edit all the texture and material names to the new ones. For example, changing <code>[OldModelName]_Alb.0</code> to <code>[NewModelName]_Alb.0</code> and <code>[OldMaterialName]</code> to <code>[NewMaterialName]</code> (e.g. <code>Mt_Hood_001</code> to <code>Mt_Hood_9001</code>). Save it, then, back in Switch Toolbox, right-click on the folder inside Texture Pattern Animations that corresponds to your item, and select Replace. Select the <code>yaml</code> you edited.

When you are done, select any file or folder from the model <code>sbfres</code>, in the list on the left, and save it. Switch Toolbox will ask if you want to Yaz0 compress the file, click Yes. Then click on any file or folder from the texture <code>sbfres</code>, in the list on the left, and save it. Switch Toolbox will again ask if you want to Yaz0 compress the file, click Yes. If you are editing a WiiU texture <code>sbfres</code>, it will then ask you to save the Tex2 sbfres, so save it and Yaz0 compress it, as well. And that's it, you are done with the files that tell the game what the new item looks like.

===Creating an inventory icon===
This section covers the inventory icons, the square images you see in the inventory grid in the pause menu. These files are kept in <code>content\UI\StockItem</code> for inventory items. Copy the old <code>sbitemco</code> file for the item you are using as your foundation, to the same location in your mod files (<code>content\UI\StockItem</code>). An <code>sbitemco</code> file is pretty much the same thing as an <code>sbfres</code> for textures, so you will edit it the same way, using Switch Toolbox. Make sure to change the name of the file to <code>[NewActorName].sbitemico</code>, the name of the file it contains in Toolbox to <code>[NewActorName].bitemico</code>, and the texture it contains to <code>[NewActorName]</code>

===Creating an inventory name and description===
For the in-game text concerning your item, you will need to navigate to <code>content\Pack\Bootup_[XXxx].pack\Message\Msg_[XXxx].product.ssarc</code>. There are many <code>msbt</code> files here, and all of them have text data for the game. For your actor, you'll look in the <code>ActorType</code> folder. Find the file that fits your item type, and open it in your text editor of choice.

Find the name and description entries for the item you used as your base, and copy them to the bottom of the file. An entry in this file starts on the line that says <code>[ActorName]_Name</code> or <code>[ActorName]_Desc</code> and ends one line before the next time that appears. If your item is something that would appear in the Shiekah Slate album, so that you could take pictures of it and track it on the map with the Sheikah Radar, also add an <code>[ActorName]_PictureBook</code>.

Change the <code>- text:</code> line of the name to be your new name, and the <code>- text:</code> line of the description to be your description. If your name or description uses apostrophes, be sure to surround it in quotes. e.g. <code>Zora Mask</code> is fine, but <code>"Zora's Mask"</code> needs the quotes because it contains an apostrophe. If you have a picture book entry as well, copy the text you made for <code>[ActorName]_Desc</code> into it.

When you're done, '''make sure to save'''.

===Converting back===
Now that almost all the files have been edited, you will need to pack them all back up. Go back to the folder that contains BreathOfTheWild_[MyAwesomeModName]_unbuilt, open a Powershell window, and run the command <code>hyrule_builder build [--be] BreathOfTheWild_[MyAwesomeModName]_unbuilt</code>. '''If you are modding for WiiU or Cemu, add the --be. If you don't, the error you get will seem very confusing. This is because it's looking for the Switch paths and not finding them.''' After a little bit of conversion, a new folder will be created, called BreathOfTheWild_[MyAwesomeModName]_unbuilt_build. That folder contains your completed mod. Delete the old BreathOfTheWild_[MyAwesomeModName] and rename the completed mod folder to BreathOfTheWild_[MyAwesomeModName].

===Creating the save game data flags===
'''You should ignore this section if you are making something that never goes into Link's inventory.'''

This section covers the save game flags, which the game uses to remember certain things about your item. If you are adding a common item, like a material or consumable, this will make it so that the little popup that happens the first time you pick up an item, doesn't happen every single time you pick your new item up. It also remembers other things, like whether or not a picture has been taken of your item, whether or not you decided to save that picture, how big the picture is, how long it's been in your inventory, and how long you've had it equipped.

Navigate to the folder that contains your BreathOfTheWild_[MyAwesomeModName] folder you made, open a Powershell window, and run the command <code>botw_flag_util generate BreathOfTheWild_[MyAwesomeModName] -a [-b]</code>. '''If you are modding for WiiU or Cemu, add the -b. If modding for Switch, don't add it. If you run it the wrong way by accident, just run it again the right way. It will let you know that nothing changed, and then write the file for the other console.'''

===Installing the mod===
And now you are done! Basically! Use the directions located [[Help:Using_mods#Installing_mods_with_the_graphic_pack_menu|here]] to make a rules.txt if you haven't already. To use the mod, open <code>bcml</code> via Powershell (just run the command <code>bcml</code>) and select Install... Then select Add Folder, select the <code>BreathOfTheWild_[MyAwesomeModName]</code> folder, and click OK. Wait for it to install, and you're ready to play the game with your new item!

==Troubleshooting==

===My actor isn't appearing in the game!===
Make sure the actor's info entry (part 5 of the tutorial) is correct. Formatting is important here. It's also important to make sure your actor's name is valid. If it isn't, the game won't know what to do with it, so it won't create it. For example, weapons need to be named <code>Weapon_[WeaponProfile]_[AnythingElseYouWant]</code>, while armors need to be named <code>Armor_[ThreeDigitNumber]_[AnythingElseYouWant]_[Head/Upper/Lower]</code> (Except <code>Armor_001_Head</code> or <code>Armor_001_G_Head</code> both work, but <code>Armor_001__Head</code> doesn't because it has two underscores between 001 and Head)

===My weapon/armor actor is appearing in my inventory, but it doesn't equip and disappears if I try to drop it from my inventory!===
This one's difficult: Something, somewhere, in the actor or in one of the resource files, is broken. It could be just about anything except for the text and flags. Whenever the game encounters something it doesn't expect, it silently fails and doesn't create the actor, but doesn't tell you why. There isn't really any better way to pinpoint what could be causing the issue.

===My game is crashing when loading the item!===
Another difficult one, but typically this is because the way you placed the item in the world (which is not covered by this tutorial) was wrong, or, if it's crashing when equipping it (if an item) or when loading it into the world (if it's a field object), it's because the model is broken. Check the [[Help:Replacing models|model replacement tutorial]] for info on the "vertex buffers" and what to do about them.

===My game is crashing after shaders compile!===
Depending on how many mods you have installed, the number of game data flags your game has can cause it to crash. The game loads all flags into a special section of memory when booting up, and if too many flags are loaded, the game doesn't have enough memory to hold them all, and crashes. The Wii U version is limited to about 650 more flags than the vanilla game has. We don't know the limit of the Switch version, but we do know that it is much higher, due to the much larger amount of memory the Switch has.

Alternatively, the [[RSTB]] may have not been edited correctly, or it may be getting overridden by a file from another mod, if you're using more than one (or not using BCML to install ''all'' of your mods). 99.9% of the time, BCML will generate things correctly, but if you've ruled out every other option, then check the BCML merged mod's RSTB entries against those found in BCML's data folder's log files.
[[Category:Guides]]

Help:Using mods

2025-09-19T22:42:15Z

Nebroc: added link for dual booting tiramisu and aroma

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://web.archive.org/web/20240101140009/https://wiiu.hacks.guide/#/ this guide] to set up your Wii U console to use homebrew software.

Note: SDcafiine on Aroma is broken, it will cause performance issues and unexpected crashes. Please follow the following instructions for Tiramisu, you can check the last section of [https://wiiu.hacks.guide/aroma/finalizing-setup.html this page] to learn how to install Tiramisu alongside aroma.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer.

=== Adding your game path ===
Once you're in Cemu, head to <code>Options > General Settings</code> at the top bar, a new window will open. At the bottom of it you will see an <code>Add</code> button, click on it to add your game path.
This should look something like <code>D:/Games/Wii U</code> (put your games from the Dumpling folder here), and Cemu will automatically get all your games, updates and DLCs from there.

Note: On older versions (before Cemu 2.1), you have to install the update and DLC.
To do so, navigate to <code>File > install game title, update or DLC</code> at the top bar, it will open the explorer. Head to <code>Dumpling/Updates/The Legend of Zelda: Breath of the Wild/meta</code> and select the meta.xml file. Follow the same processus for the DLC that should be at <code>Dumpling/DLCs/The Legend of Zelda: Breath of the Wild/meta</code>.
If this has been done correctly, you should now see that Breath of the Wild is on version 1.5.0 and DLC on version 3.0 at the bottom right of the title screen in game.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
[[Help:Tools/UKMM#BCML_or_UKMM?|Don't]]

=== Installing mods using UKMM ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/UKMM|UKMM]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, UKMM is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. UKMM does this automatically. To install mods with UKMM:

# Install UKMM using the instructions [[Help:Tools/UKMM#Installation|here]].
# Open UKMM.
# Set up UKMM using the instructions [[Help:Tools/UKMM#Setup|here]].
# Use the Install tab to install mods. (See [[Help:Tools/UKMM#No,_really,_how_do_I_use_it?|here]] if this is confusing)

For more information on using UKMM, see the [https://nicenenerd.github.io/UKMM/ UKMM docs].

UKMM should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "UKMM" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/UKMM</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://switch.hacks.guide this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Dumping games

2025-06-28T11:58:13Z

Nebroc: Updated Lockpick_RCM link since development has move ryu's git and latest version is required for firmware 20

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 ==

'''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.

=== Dumping from emulators ===

If you already have the game setup on a Switch emulator, you do not need to follow any of the steps with nxdumptool on your Switch. Right click the game in your emulator and:

* ''<code>Extract data</code>'' > <code>''RomFS''</code> ('''[https://ryujinx.app Ryujinx]''')
* ''<code>Dump RomFS</code>'' > <code>''Dump RomFS''</code> > <code>''Full''</code> ('''Yuzu''')

=== Dumping from a Switch ===

Dump the game files directly to your PC 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.

====Prerequisites====
* Keys file generated using [https://git.ryujinx.app/archive/lprcm/-/releases 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.
* [https://github.com/DarkMatterCore/nxdumptool/releases/tag/rewrite-prerelease nxdumptool rewrite] (get both <code>nxdt_host.7z</code> and <code>nxdt_rw_poc.nro</code>).
* [https://zadig.akeo.ie/ Zadig] to setup the driver (used for dumping through USB)

====Setting up the driver====

# First, make sure to dump your keys by injecting the '''Lockpick_RCM''' payload and selecting "Dump title keys", then reboot to Atmosphère.
# Place nxdumptool rewrite (<code>nxdt_rw_poc.nro</code>) into the switch folder of your SD card, open it through the Homebrew Launcher, and plug the Switch to your computer with a USB cable.
# With nxdumptool open, launch Zadig on your computer
# Go to <code>Options</code> and make sure <code>List all devices</code> is checked -- if not, click that option.
# Using the dropdown list with USB devices, select the name of the NRO you launched on your Switch (e.g. <code>nxdt_rw_poc</code>).
# Change the <code>Driver</code> dropdown on the right to <code>libusbK</code> (the actual version number doesn't matter).
# Wait until the installation process finishes. If you did it correctly, Zadig should look like this:
[[File:Zadig.png|border|500x500px]]

====Dumping game files (romfs)====

# Open the host app (.exe file extracted from <code>nxdt_host.7z</code>), and click <code>Start Server</code>
# If the UI says that the Switch is not detected, make sure that nxdt is running on your Switch, that you have setup the driver properly, and that you don't have a bad USB cable.
# On nxdumptool, navigate through the menu by selecting the following options:
## Go to <code>user titles menu</code>, then select <code>The Legend of Zelda: Breath of the Wild</code>
## Select the following options: <code>nca / nca fs dump options</code> -> <code>dump base application</code> -> <code>Program #0</code> -> <code>FS section #2: RomFS</code>
## On the line with <code>use base/patch title</code>: select the installed update
## On the line with <code>output storage</code>: select <code>usb host (pc)</code>
## Select <code>start nca fs section dump</code>

Depending on your USB speed (2.0 or 3.0) and the quality of your cable, it may vary from 10 minutes up to an hour.

'''It may fail if your USB cable is faulty, if the USB port on your PC is faulty, or if you run out of space on your computer (dumping BotW requires at least 14GB of available storage).'''

'''Dumping DLCs'''

Just like mentioned previously, updates share their filesystem data with the base game, so dumping the RomFS with 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 and update separately.

DLCs, on the other hand, must be dumped separately. If you have the DLCs installed, once the dump of the base application and update was completed, repeat previous steps from 1 to 5 again, but select <code>dump dlc</code> instead of <code>dump base application</code> on step 2.
# 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.
When you're done, you'll be able to find the output dumps under <code>NCA FS\Extracted</code> in the nxdumptool host app folder.

=== 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:Using mods

2024-12-12T17:27:21Z

Nebroc: /* Wii U Console */

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://web.archive.org/web/20240101140009/https://wiiu.hacks.guide/#/ this guide] to set up your Wii U console to use homebrew software.

Note: SDcafiine on Aroma is broken, it will cause performance issues and unexpected crashes. Please follow the following instructions for Tiramisu, and use the link above for more informations about installing Tiramisu.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer.

=== Adding your game path ===
Once you're in Cemu, head to <code>Options > General Settings</code> at the top bar, a new window will open. At the bottom of it you will see an <code>Add</code> button, click on it to add your game path.
This should look something like <code>D:/Games/Wii U</code> (put your games from the Dumpling folder here), and Cemu will automatically get all your games, updates and DLCs from there.

Note: On older versions (before Cemu 2.1), you have to install the update and DLC.
To do so, navigate to <code>File > install game title, update or DLC</code> at the top bar, it will open the explorer. Head to <code>Dumpling/Updates/The Legend of Zelda: Breath of the Wild/meta</code> and select the meta.xml file. Follow the same processus for the DLC that should be at <code>Dumpling/DLCs/The Legend of Zelda: Breath of the Wild/meta</code>.
If this has been done correctly, you should now see that Breath of the Wild is on version 1.5.0 and DLC on version 3.0 at the bottom right of the title screen in game.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
[[Help:Tools/UKMM#BCML_or_UKMM?|Don't]]

=== Installing mods using UKMM ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/UKMM|UKMM]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, UKMM is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. UKMM does this automatically. To install mods with UKMM:

# Install UKMM using the instructions [[Help:Tools/UKMM#Installation|here]].
# Open UKMM.
# Set up UKMM using the instructions [[Help:Tools/UKMM#Setup|here]].
# Use the Install tab to install mods. (See [[Help:Tools/UKMM#No,_really,_how_do_I_use_it?|here]] if this is confusing)

For more information on using UKMM, see the [https://nicenenerd.github.io/UKMM/ UKMM docs].

UKMM should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "UKMM" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/UKMM</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://switch.hacks.guide this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Tools/BCML

2024-10-18T20:52:37Z

Nebroc: added a "known issue" with cemu 2.1 AppData stuff

{{Tool infobox
| name = BCML
| authors = Nicene Nerd
| source = https://github.com/NiceneNerd/BCML
| license = GLPv3+
| written_in = Python
}}

BCML ('''B'''reath of the Wild '''C'''ross-platform '''M'''od '''L'''oader) is the mod manager for BotW. It is used to install and uninstall mods, and solves many mod conflicts.

==Setup==
BCML requires Python [https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe 3.8.10] or [https://www.python.org/ftp/python/3.7.9/python-3.7.9-amd64.exe 3.7.9], and the [https://aka.ms/vs/17/release/vc_redist.x64.exe x64 Visual C++ redistributable]. When you open the Python installer, there will be a checkbox that says <code>Add Python to PATH</code>. You MUST check this box, or else BCML can't be installed. From here, continue as normal, and install the x64 Visual C++ redistributable.

Open a command prompt anywhere (if you don't know how, just type <code>cmd</code> into Windows Search).

Most people will want to use BCML version 3.10.4 in order to support more mods. BCML version 3.10.5 and up removed support for older BCML V2 mods in order to allow newer python versions.

To install BCML 3.10.4 open a cmd prompt and run <code>pip install bcml==3.10.4</code> (to install latest bcml type <code>pip install bcml</code>)

You should see a bunch of progress bars, and then a success message.

To run BCML all you need to do is type <code>bcml</code> into a cmd prompt.

If you would like to have a shortcut made, BCML has that option on the settings page.

===Linux Extra Setup===
BCML only has partial support for Linux, so some extra steps are needed to make it work for Linux. (This includes Steam Deck)

First, check the BCML setting to use without a Cemu installation, even if you are using it with Cemu. If Cemu is installed on a different drive than BCML is (e.g. flash drive) then also check the setting to disable links for the master mod.

Second, set the merged export directory to the path that Cemu will read the BCML graphic pack from. Depending on your distro and the app binary you use, this can be different places, so you may need to find the location, yourself. Two examples would be <code>~/.config/cemu/BreathOfTheWild_BCML</code> or <code>~/.local/share/cemu/BreathOfTheWild_BCML</code>. (Note that ~ is Linux shorthand for <code>/home/<username></code> for all non-root accounts)
* Do NOT set the merged export directory to the base graphic pack folder! E.g. <code>~/.config/cemu</code>. Do NOT. If you do, BCML will delete things it shouldn't whenever you install or uninstall a mod.

Last, install your first mod with BCML. Once it is installed, go to the merged export directory in your file viewer and add a file called <code>rules.txt</code> based on the format described on [[Help:Using_mods#Installing_mods_with_the_graphic_pack_menu|this page]].

==Usage==
[[File:BCML-3.png|thumb|right|BCML 3.4.9's UI]]
*'''+''' (in the bottom right): Installs a mod. Note that BCML supports mods in ZIP, RAR, 7z, or BNP formats. It also supports loose file format, in which case you select the <code>rules.txt</code> or <code>info.json</code> to install.
*'''Hamburger button (bottom left)''': Show sort handles in the mod list, to drag and drop, which changes mod load order. Changes the load priority of a mod and then adjusts any RSTB, pack, or text merges as needed.
*'''Circular Arrow (bottom left)''': Remakes all merged mod files. Use this as a first option when you run into mod conflicts.
*'''Export''': Exports all installed mods as a single mod. The exported zip file will be in a graphics pack format, or Atmosphere format (if in Switch mode)
*'''Explore''': Opens the folder where the selected mod is installed.
*'''Hamburger button (top right)''': Dropdown menu that includes the BCML in-app help. Refer to this menu, first, if you have any issues.

If the in-app help does not solve your issue, try consulting the [https://github.com/NiceneNerd/BCML/wiki/Troubleshooting BCML troubleshooting] page. It's a bit out of date, but it has some useful information.

==Known Issues==

*Certain game files are too complex for the basic merging logic, and custom logic will have to be written for them. Almost all mods made as of Oct 17, 2020 are currently supported, but future mods may not be.
*Cemu 2.1+ isn't supported since Cemu moved most of it data to AppData rather than next of the exe, you can [https://wiki.cemu.info/wiki/Release_1.26.2f use Cemu 1.26.2f], follow [https://discord.com/channels/316759222207643649/606813647674540032/1278361320160235581 this workaround] or simply [https://nicenenerd.github.io/UKMM use UKMM].

==Merge All the Mods: Getting Started with BCML 3 Instructional Video==

[https://www.youtube.com/watch?v=8gKRifYyA68 Merge All the Mods: Getting Started with BCML 3 Instructional Video on YouTube]

Help:Using mods

2024-10-17T19:55:05Z

Nebroc: Reworking the instructions to install botw on cemu

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/#/archive/tiramisu/sd-preparation this guide] to set up your Wii U console to use homebrew software.

Note: SDcafiine on Aroma is broken, it will cause performance issues and unexpected crashes. Please follow the following instructions for Tiramisu, and use the link above for more informations about installing Tiramisu.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer.

=== Adding your game path ===
Once you're in Cemu, head to <code>Options > General Settings</code> at the top bar, a new window will open. At the bottom of it you will see an <code>Add</code> button, click on it to add your game path.
This should look something like <code>D:/Games/Wii U</code> (put your games from the Dumpling folder here), and Cemu will automatically get all your games, updates and DLCs from there.

Note: On older versions (before Cemu 2.1), you have to install the update and DLC.
To do so, navigate to <code>File > install game title, update or DLC</code> at the top bar, it will open the explorer. Head to <code>Dumpling/Updates/The Legend of Zelda: Breath of the Wild/meta</code> and select the meta.xml file. Follow the same processus for the DLC that should be at <code>Dumpling/DLCs/The Legend of Zelda: Breath of the Wild/meta</code>.
If this has been done correctly, you should now see that Breath of the Wild is on version 1.5.0 and DLC on version 3.0 at the bottom right of the title screen in game.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install and setup BCML using the instructions [[Help:Tools/BCML#Setup|here]] or in [https://www.youtube.com/watch?v=8gKRifYyA68 this video tutorial].
# Open BCML.
# Click the floating action button to install mods.

For more information on using BCML, see the [https://github.com/NiceneNerd/BCML/tree/master/docs BCML docs].

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "BCML" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/BCML</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://switch.hacks.guide this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Using mods

2024-10-17T19:41:21Z

Nebroc: /* Installing the DLC */

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/#/archive/tiramisu/sd-preparation this guide] to set up your Wii U console to use homebrew software.

Note: SDcafiine on Aroma is broken, it will cause performance issues and unexpected crashes. Please follow the following instructions for Tiramisu, and use the link above for more informations about installing Tiramisu.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

Note: This is no longer required if you use Cemu 2.1+, the emulator will simply retrieve the update and DLC from your game path.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install and setup BCML using the instructions [[Help:Tools/BCML#Setup|here]] or in [https://www.youtube.com/watch?v=8gKRifYyA68 this video tutorial].
# Open BCML.
# Click the floating action button to install mods.

For more information on using BCML, see the [https://github.com/NiceneNerd/BCML/tree/master/docs BCML docs].

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "BCML" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/BCML</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://switch.hacks.guide this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Using mods

2024-10-17T19:38:35Z

Nebroc:

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/#/archive/tiramisu/sd-preparation this guide] to set up your Wii U console to use homebrew software.

Note: SDcafiine on Aroma is broken, it will cause performance issues and unexpected crashes. Please follow the following instructions for Tiramisu, and use the link above for more informations about installing Tiramisu.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install and setup BCML using the instructions [[Help:Tools/BCML#Setup|here]] or in [https://www.youtube.com/watch?v=8gKRifYyA68 this video tutorial].
# Open BCML.
# Click the floating action button to install mods.

For more information on using BCML, see the [https://github.com/NiceneNerd/BCML/tree/master/docs BCML docs].

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "BCML" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/BCML</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://switch.hacks.guide this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Using mods

2024-09-22T10:59:25Z

Nebroc: Changed Switch hacks guide, old one was down

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/#/archive/tiramisu/sd-preparation this guide] to set up your Wii U console to use homebrew software.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install and setup BCML using the instructions [[Help:Tools/BCML#Setup|here]] or in [https://www.youtube.com/watch?v=8gKRifYyA68 this video tutorial].
# Open BCML.
# Click the floating action button to install mods.

For more information on using BCML, see the [https://github.com/NiceneNerd/BCML/tree/master/docs BCML docs].

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "BCML" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/BCML</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://switch.hacks.guide this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Using mods

2024-05-06T19:57:58Z

Nebroc: changed the link to hack the wii u since the default method is now aroma and tiramisu is used to mod botw

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/#/archive/tiramisu/sd-preparation this guide] to set up your Wii U console to use homebrew software.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their un-modded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

=== Setting up and Maximizing Performance ===
Now that you have Cemu and your games files, it is recommended you use [https://cemu.cfw.guide Emiyl's Cemu Setup Guide] to maximize performance on your hardware before installing mods.

=== Installing mods using BCML ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install and setup BCML using the instructions [[Help:Tools/BCML#Setup|here]] or in [https://www.youtube.com/watch?v=8gKRifYyA68 this video tutorial].
# Open BCML.
# Click the floating action button to install mods.

For more information on using BCML, see the [https://github.com/NiceneNerd/BCML/tree/master/docs BCML docs].

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "BCML" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/BCML</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://guide.sdsetup.com this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [https://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [https://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]