{{lowercase}}
<onlyinclude>
'''Message Studio Binary Text'''
<code>MSBT</code> is a binary file format belonging to LibMessageStudio (LMS). These files store the game's text and can contain "tags" that define how said text is displayed/interacted with.</onlyinclude>

== File Layout ==
<code>MSBT</code> files are composed of a file header followed by blocks (each with their own block header). All sections/blocks must be aligned to 0x10 (16) bytes. In BotW, the file layout is as follows:
* Header
* Labels Block
* Attributes Block
* Text Block
The list of possible blocks is as follows:

* LBL1 (labels)
* TXT2 (text)
* ATR1 (attributes)
* TSY1 (style info)
* ATO1 (unknown)

== File Header ==

=== Header Structure ===
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 8
| char[8]
| msbt file signature (magic) <code>4D 73 67 53 74 64 42 6E</code> or "MsgStdBn"
|-
| 0x08
| 2
| u16
| Byte-Order Mark
|-
| 0x0a
| 2
|
| Padding {{check}}
|-
| 0x0c
| 1
| u8
| Encoding (0 = UTF8, 1 = UTF16, 2 = UTF32 - games generally only support one specific encoding) {{check}}
|-
|0x0d
|1
|u8
|Version (3)
|-
| 0x0e
| 2
| u16
| Block Count {{check}}
|-
| 0x10
| 2
|
| Padding {{check}}
|-
| 0x12
| 4
| u32
| File Size
|-
| 0x16
| 10
|
| Padding {{check}}
|}

== Block Header ==
This header is shared across all block types. The block data follows directly after the header and is aligned to 0x10 (16) bytes. The block size does not include the size of the header.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| Block Signature
|-
| 0x04
| 4
| u32
| Block Size
|-
| 0x08
| 8
|
| Padding
|}

== Labels Block ==
The labels block contains the label names for file's text. Its signature is <code>LBL1</code>.

The section begins with a four-byte header specifying the number of label groups.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| Label Group Count
|}

=== Label Groups ===
Following the header is a table of label groups. Each entry in the table is eight bytes. The first four bytes specify the number of labels in the group and the second four specify the offset of the first label relative to the start of the section. The number of label groups in many games appears to be the smallest prime number larger than half the number of labels (with a max of 101 groups and a minimum of 2). In BotW, this may not always be the case.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| Label Count
|-
| 0x04
| 4
| u32
| Offset
|}
Messages are sorted into label groups by hashing the label name. A recreation of the hash function is as follows:<syntaxhighlight lang="python3">
def calc_hash(label):
hash = 0
for char in label:
hash = hash * 0x492 + ord(char)
return (hash & 0xFFFFFFFF) % num_label_groups
</syntaxhighlight>

=== Labels ===
Following the label groups is the array of labels. Each label consists of a u8 string length followed by a null-terminated string. At the end of the label is a u32 index specifying the index of the message that corresponds to the label in the text block.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 1
| u8
| String Length
|-
| 0x01
| ''n''
| char[''n'']
| Label String
|-
| 0xnn
| 4
| u32
| Message Text Index
|}

== Attributes Block ==
The attributes block stores additional, optional attributes that can be associated with messages. Its signature is <code>ATR1</code>. The interpretation of attribute data is completely up to the game's discretion and attributes in BotW are not fully understood at this time. The attribute seem to indicate which actor should be attributed with the dialog (A good example is in <code>100enemy.msbt</code> where <code>NPC_GodVoice</code> is referenced).

Each attribute corresponds to the message of the same index in the text block {{check}}.

The block begins with an eight-byte header that specifies the number of attributes and the size of a single attribute.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| Attribute Count
|-
| 0x04
| 4
| u32
| Attribute Size
|}
Following the brief header is an array of the attribute data. In many cases, this data is actually a string offset relative to the start of the section (as is the case in BotW).
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| Attribute String Offset
|}

=== Attribute Strings ===
Should the attribute data be a string offset, then the data is followed by an array of null-terminated strings encoded using the encoding specified in the file header. In BotW, this is means UTF16-LE on Switch and UTF16-BE on Wii U.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| ''n''
| char_type[]
| String
|}

== Text Block ==
The text block contains the text for messages. Its signature is <code>TXT2</code>.

The section begins with a small four-byte header specifying the number of messages in the section.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| Message Count
|}
Following the brief header is an array of u32 offsets to the text strings. Each offset is relative to the beginning of the section.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| 4
| u32
| String Offset
|}

=== Message Strings ===
The strings are stored as an array of strings encoded using the encoding specified in the header. In BotW, this is means UTF16-LE on Switch and UTF16-BE on Wii U. Each string is read from its specified offset until the next string offset. The last string uses the section size specified in the block header to determine its end position.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
| 0x00
| ''n''
| char_type[]
| String
|}

== Tags ==
{{expand section}}
Message strings can contain tags that alter how the message is displayed or processed. These tags are processed by <code>nn::ui2d::TagProcessorBase</code> which in Nintendo EPD games is extended by<code>eui::TagProcessor</code> which can then be further extended by the game to handle game-specific tags. The interpretation of tags is completely game-dependent.

Tags are embedded directly inside of the text and begin with a brief tag header.
{| class="wikitable"
!Offset (h)
!Size
!Data Type
!Description
|-
|0x00
|2
|u16
|Signature (<code>00 0e</code> or <code>00 0f</code>)
|-
|0x02
|2
|u16
|Tag Group
|-
|0x04
|2
|u16
|Tag Type
|-
|0x06
|2
|u16
|Extra Data Size (this value is ignored for <code>00 0f</code> tags which have no data)
|-
|0x08
|?
|?
|Extra data (size is dependent on Extra Data Size, type is dependent on Group and Type)
|}
In Nintendo EPD games, tag group 0 tags are system tags, group 1 is <code>eui</code> tags, group 2 is app (game) specific tags, and group 201 is grammar tags. The other groups are currently unknown. In BotW, group 4 appears to be for animations and group 5 appears to be for delays.

For example, in <code>100enemy.msbt</code> the following data appears:
<pre> | 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F |
---|-------------------------------------------------|------------------|
00 | 00 57 00 68 00 69 00 63 00 68 00 20 00 70 00 61 | .W.h.i.c.h. .p.a |
10 | 00 72 00 74 00 20 00 6F 00 66 00 20 00 74 00 68 | .r.t. .o.f. .t.h |
20 | 00 65 00 20 00 54 00 72 00 69 00 61 00 6C 00 20 | .e. .T.r.i.a.l. |
30 | 00 77 00 6F 00 75 00 6C 00 64 00 20 00 79 00 6F | .w.o.u.l.d. .y.o |
40 | 00 75 00 0A 00 6C 00 69 00 6B 00 65 00 20 00 74 | .u...l.i.k.e. .t |
50 | 00 6F 00 20 00 63 00 68 00 61 00 6C 00 6C 00 65 | .o. .c.h.a.l.l.e |
60 | 00 6E 00 67 00 65 00 3F 00 0E 00 01 00 06 00 0A | .n.g.e.?........ |
70 | 00 02 00 03 00 04 00 05 02 03 00 00 | ............ |
</pre>
At byte <code>0x68</code> is the tag header followed with tag group 1 and tag type 6. 0xa is the size of the extra data with the extra data being <code>[00 02 00 03 00 04 00 05 02 03]</code>.

=== Tags ===
Not all tags functions are currently known.

==== System Tags ====
{| class="wikitable"
!Group
!Type
!Notes
|-
| 0
| 0
|Ruby (extra data is a u16 display span followed by the ruby text)
|-
| 0
| 1
| Font (extra data is a u16 font type)
|-
| 0
| 2
|Font Size (extra data is a u16 font size)
|-
| 0
| 3
|Font Color (extra data is a u16 color type)
|-
| 0
| 4
| Page Break (no extra data)
|}
The available colors in BotW are red, green, blue, gray, and orange in that order. 0xffff indicates a reset to the default white text color. These colors are generally either hardcoded in the game's executable or defined in a separate MSBP file if present. If defined in a MSBP file, the color type instead acts as an index into the colors in the MSBP file.

==== EUI Tags ====
{| class="wikitable"
!Group
!Type
!Notes
|-
| 1
| 0
|Delay (extra data is a u32 frame count)
|-
| 1
| 1
| Text Speed?
|-
| 1
| 2
|No Text Scroll?
|-
| 1
| 3
|Auto Advance (extra data is a u32 frame count)
|-
|1
|4
|Two Choices (extra data is an array of u16 label indices for each choice followed by a u8 selected index and u8 cancel index)
|-
|1
|5
|Three Choices
|-
|1
|6
|Four Choices
|-
|1
|7
|Picture Font (Icon) (extra data is two u8s, the second being the type)
|-
|1
|8
|
|-
|1
|9
|
|-
|1
|10
|
|}

==== App Tags ====
// TODO

==== Group 3 Tags ====
// TODO

==== Group 4 Tags ====
// TODO

==== Grammar Tags ====
// TODO

== Compiling the Sections ==
The sections are held together by the indexes in the labels table. The indexes correspond to the attributes table and the texts table. The data can be compiled using the index.

By default the indexes in the labels table are not in order, but the text table is (and possibly the attributes table). Below is the labels table in <code>100enemy.msbt</code>.
{| class="wikitable"
!String Count
!Offset
!Label
!Index
|-
| 1
| 188
| talk20
| 3
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 0
| 188
|
|
|-
| 1
| 199
| 0002
| 8
|-
| 1
| 208
| 0003
| 9
|-
| 1
| 217
| 0004
| 10
|-
| 1
| 226
| 0005
| 11
|-
| 1
| 235
| talk13
| 4
|-
| 0
| 235
|
|
|-
| 1
| 246
| talk14
| 5
|-
| 1
| 257
| talk15
| 6
|-
| 1
| 268
| talk16
| 7
|-
| 1
| 279
| talk17
| 0
|-
| 1
| 290
| talk18
| 1
|-
| 1
| 301
| talk19
| 2
|}
And the texts table.
{| class="wikitable"
!Index
!Text
|-
| 0
| Which part of the Trial would you like to challenge?
|-
| 1
| Which part of the Trial would you like to challenge?
|-
| 2
| Which part of the Trial would you like to challenge?
|-
| 3
| You cannot participate in the Trial when the Master Sword is out of energy.
|-
| 4
| That sword you have reunited with... the Master Sword...it has yet to realize its true splendor. The trial that will awaken its true power... If you wish to rise to the challenge, place the Master Sword in its pedestal.
|-
| 5
| The Master Sword you wield is now more powerful than before. If you desire still more power and wish to retry the blade's test... once again place the Master Sword in its pedestal
|-
| 6
| Now your body, mind, and soul are ready to wield the Master Sword at its full potential. But do not let your guard down. Just as before, if you use your sword to excess, it will run out of energy and become unusable until it recovers. It would be reckless to rely only on your blade when facing Ganon. Prepare for the worst, and consider freeing the Divine Beasts before confronting your fate. Her smile... The princess's sweet smile... How I would love to see it once more..
|-
| 7
| Now your body, mind, and soul are ready to wield the Master Sword at its full potential. But do not let your guard down. Just as before, if you use your sword to excess, it will run out of energy and become unusable until it recovers. That blade is more than a tool. It is your partner across time, your ally from 100 years past... Wield it with care. Her smile... The princess's sweet smile...How I would love to see it once more...
|-
| 8
| Beginning Trials
|-
| 9
| Middle Trials
|-
| 10
| Final Trials
|-
| 11
| Cancel
|}
Using the indexes to match the labels to the attributes and texts tables, the following table can be compiled.

The empty labels are not fully understood.
{| class="wikitable"
!Label
!Index
!Attribute
!Text
|-
| talk17
| 0
| NPC_GodVoice
| Which part of the Trial would you like to challenge?
|-
| talk18
| 1
| NPC_GodVoice
| Which part of the Trial would you like to challenge?
|-
| talk19
| 2
| NPC_GodVoice
| Which part of the Trial would you like to challenge?
|-
| talk20
| 3
| NPC_GodVoice
| You cannot participate in the Trial when the Master Sword is out of energy.
|-
| talk13
| 4
| TwnObj_Village_Korok_DekuTree_A_01
| That sword you have reunited with... the Master Sword...it has yet to realize its true splendor. The trial that will awaken its true power... If you wish to rise to the challenge, place the Master Sword in its pedestal.
|-
| talk14
| 5
| TwnObj_Village_Korok_DekuTree_A_01
| The Master Sword you wield is now more powerful than before. If you desire still more power and wish to retry the blade's test... once again place the Master Sword in its pedestal
|-
| talk15
| 6
| TwnObj_Village_Korok_DekuTree_A_01
| Now your body, mind, and soul are ready to wield the Master Sword at its full potential. But do not let your guard down. Just as before, if you use your sword to excess, it will run out of energy and become unusable until it recovers. It would be reckless to rely only on your blade when facing Ganon. Prepare for the worst, and consider freeing the Divine Beasts before confronting your fate. Her smile... The princess's sweet smile... How I would love to see it once more...
|-
| talk16
| 7
| TwnObj_Village_Korok_DekuTree_A_01
| Now your body, mind, and soul are ready to wield the Master Sword at its full potential. But do not let your guard down. Just as before, if you use your sword to excess, it will run out of energy and become unusable until it recovers. That blade is more than a tool. It is your partner across time, your ally from 100 years past... Wield it with care. Her smile... The princess's sweet smile...How I would love to see it once more...
|-
| 0002
| 8
|
| Beginning Trials
|-
| 0003
| 9
|
| Middle Trials
|-
| 0004
| 10
|
| Final Trials
|-
| 0005
| 11
|
| Cancel
|}
The attribute table is still not fully understood. In this example, there are 8 attribute entries in the table, but they correctly map to the 8 blocks of dialog.

<references />

[[Category:File formats]]
[[Category:File extensions]]
[[Category:File extensions (MSBT)]]

== Tools ==
{{tool table|category=Tools (MSBT)}}

[[Category:File formats]]

Help:Replacing models

2024-12-21T04:12:58Z

Ginger: /* General */ FBX converter

Model replacement is the process of changing the shape of an entity (weapon, character, etc) to a custom shape, either created by you or by someone else. Examples of model replacements include the [https://gamebanana.com/skins/163434 Zelda] and [https://gamebanana.com/skins/163132 Linkle] replacement mods.

This tutorial assumes you either have a model already, or will be editing one of the in-game models. It also assumes you will be replacing an in-game model, not making a new one. Pictures dealing with modeling programs are taken in 3ds Max, but similar options should be available in your program of choice.

==Required Tools==
Model replacement in Breath of the Wild requires a set of tools. These tools will vary somewhat, based upon your personal preference, but the tools below are currently the most effective for properly modding the game.

*[https://github.com/KillzXGaming/Switch-Toolbox/releases Switch Toolbox] (Yes, even if you are using WiiU or Cemu)
*A 3D modeling program of your choice (common choices are 3ds Max and Blender)
*(optional) If you are using 3ds Max, the [https://github.com/Aaaboy97/BotW-Tools/tree/master/CSV%20Exporting CSV export] script
*(optional) If you are using 3ds Max, the [https://www.vg-resource.com/thread-29836.html BFRES importer] MaxScript may be helpful. (expand the "Wii U & Nintendo Switch - BFRES importer (originally by ItsEasyActually)" to find it)
*(optional) [https://github.com/Shadsterwolf/BotWUnpacker/releases BotWUnpacker]

==Tutorial==

===Obtaining a Rig===
[[File:ModelReplacement_obtainRig.png|alt=Obtaining a rig|thumb|The red box shows what to click to extract a model.]]
[[File:ModelReplacement VertexBuffers.png|thumb|Select the object (left) and read the vertex buffers (right)]]
<blockquote>Summary: Export a model from the SBFRES you want to use, using Switch Toolbox. Take note of the skin count and the vertex buffers and formats.</blockquote>A "rig" or "skeleton" is a set of "bones" that animations use. Every model is made up of several pieces: objects (which tells the game how to make the model in 3D), materials (which tell the game what the model should look like), and the rig (which tells the game how the model moves during animations). If you were to consider a door, the objects would be the rectangle for the main door and sphere of the knob, the materials would be the wood grain and brown coloring of the door and silver reflective surface of the knob, and the rig would be what tells the game that the knob rotates and the door swings inward.
In order to obtain a rig, you should find the SBFRES archive for the model you wish to use a rig from. Most models are contained in the game files in the content\Model folder. Once you've chosen your SBFRES, copy it to a safe place away from the game files, so you don't accidentally modify any of the original game's files.

Open Switch Toolbox, select File -> Open from the toolbar, and select your SBFRES. On the left side, expand the only available option, and then expand Models. Right-click on the model you need and select Export. If there are multiple options, pick as many as you need. For example, if you are replacing an entire armor set, you would export all three models, but if you were only replacing one piece of the armor, you would export just that piece. Export it as a DAE file. Switch Toolbox will ask if you want to export textures. It's not needed, but it doesn't hurt.

Next, expand the model(s) you are exporting, expand the Objects folder, and select each object in turn. On the right side of Switch Toolbox, you'll see a collapsed section labeled Vertex Buffer. Expand it. In this section, you will see several important things: the skin count, the vertex buffers, and the buffer formats. It's not important to know what all of these things mean if you don't wish, but take note of what they are for every object that you'll be replacing. Screenshots or a text file work well for saving this info. It will be important later.

Note: if you wish to export all the models in an SBFRES quickly, right-click on the Models folder instead and select Export All.

===Import the Original to Your Workspace===
[[File:ModelReplacement_importModel.png|alt=Import the Original Model|thumb|Click on 1 to expand the menu, then click on 2 (or highlight 2 and click on 3) to import. Blender's layout for this step is almost identical.]]
<blockquote>Summary: Import the DAE into a shared workspace with your model, so that the object list has your objects, the original objects, and the original skeleton.</blockquote>Open your 3D modeling program of choice, and bring your replacement model into the workspace. Then, go to File -> Import, and import the DAE model you extracted from the SBFRES. If you exported multiple models, only import the model you are currently working with. For example, if you exported an entire armor, you should only import the legs (or whatever part you are working with). Once you have finished the "Export Your Rigged Model" step, return here to repeat the process for other models.
You may see errors when you import with 3ds Max - this is normal, you can ignore them. Blender suppresses these errors, so you won't see them.
Combine the original model's objects, roughly along the lines of how your objects are. For example, if the original model has separate fingers, hands, and arms, and your model has separate hands and arms, combine the fingers with the hands. Or if your model is only a single object, combine all the original model's objects into a single object. In 3ds Max, you can do this with Command Panel -> Modify -> Edit Geometry -> Attach, and selecting the object to attach the selected object to. In Blender, you can do this by selecting multiple objects with Ctrl+click in Object mode, then right-clicking and selecting Join.

In your object list, you will now see the original model's objects along with your objects. You will also see the original model's skeleton, which is important to have and you should generally not touch it.

===Align Your Model With the Original===
[[File:ModelReplacement_alignModel.png|alt=Align Your Model|thumb|Select your model (1), select the mesh (2), select the type of thing to modify (3), and select how to modify it (4).]]
<blockquote>Summary: Get your objects to match up with the original ones, as close as possible. Anything delicate is important: feet, hands/fingers, waists, necklines, handles of weapons, etc.</blockquote>In all likelihood, your model will differ greatly from the original you just imported. Using the Move, Rotate, and Scale tools, make sure your model lines up with the original's - the closer the better.
There are also plenty of tools in 3ds Max's Edit Poly/Mesh modes, or Blender's Sculpt mode for helping move the model around. In 3ds Max, you can right click on the Edit Mesh/Poly to convert between them. In Blender, one of Sculpt mode's tools is the Pose tool, which is quite good for moving limbs into place if you're modifying an armor.

Rename your objects to something close to the original's, so that you can easily figure out which of your objects corresponds to which original object. This will help both during this step and later, during the "Replace the Original Model with Yours" step. For example, if you have an object for hair, it's encouraged to name it <code>Hair_###__Mt_Hair_###</code>, where ### is the number of the armor you might be working with, and Mt_Hair_### is the name of the material you want to use with it. Including the name of the material in the object is helpful so that when you need to reassign materials in Switch Toolbox (which you may have to do often, depending on how much trouble you have) you will be able to tell, straight away, which object needs which material.

Note: If you need help with this step, there are many great tutorials on YouTube.

===Apply the Rig from the Original to Your Model===
[[File:ModelReplacement_copyRig.png|alt=Copy the Rig|thumb|Select the original object (1), right click on the Skin modifier and copy it (2), select your replacement object (3), and right click in the modifier area and paste the Skin modifier there (4).]]
<blockquote>Summary: Apply the rig from the original object(s) to your object(s). Set maximum limit for bones to affect vertices to the object's skin count.</blockquote>For 3ds Max: Select the original object's Skin modifier in the modifier list, then copy it. Select your object, then paste the rig onto it. If all has gone well, you're done with this step. 3ds Max uses one or more of a series of algorithms to map the rig of one object onto the rig of another object automatically, and it's generally pretty good about it.
For Blender:
* Click and drag the object on top of the original object's Armature (the one with the orange upside-down triangle next to it), while holding shift and alt. This will assign the object to that armature, instead. Then, select the object in Object mode, go to the Modifiers tab (which looks like a diagonal wrench, in the bottom right area), and in the box that says Armature at the top, click on the box next to Object, and select the armature of the original model. If there is no box that says Armature at the top, click on Add Modifier and select Armature. There is now a box that says Armature at the top.
* Select your object in Object mode. In the bottom right, click on the upside-down green triangle. If there is anything in the Vertex Groups tab, delete it all with the - button. Then, Ctrl+click the original object that most closely matches its location. Go into Weight Paint mode, click on the Weights button in the top left, and select Transfer Weights. In the bottom left, expand the new small tab there, if it is not already. For Vertex Mapping, select Nearest Face Interpolated. For Source Layers Selection, select By Name. For Destination Layers Matching, select All Layers.

After applying the rig onto an object, set the limit for the number of bones to affect each vertex to 4. In 3ds Max, you can do this by scrolling the modifier rollout on the right side down to the bottom, expanding Advanced Parameters, and setting the number in the Bone Affect Limit box. In Blender, you can do it with the Limit Total option, found right under the Transfer Weights option described earlier. Other programs will have different ways of setting this limit.

You also want your weights to be normalized. In 3ds Max, the weights are normalized by default. In Blender, in Weight Paint mode, you need to click on the screwdriver-and-wrench icon in the middle of the right side, expand Options, and select Auto Normalize.

If you get the model into the game and the animations deform the model in strange ways, you'll need to come back and manually adjust the rigging, which is a very time-consuming process, documented in a number of excellent tutorials on YouTube.

===Delete the Original Model's Objects===
[[File:ModelReplacement_deleteObjects.png|alt=Delete Original Objects|thumb|The workspace has been cleared of the painted object, leaving only the custom, unpainted one and the skeleton.]]
<blockquote>Summary: Delete the original model's objects and your model's skeleton (if any), leaving just your objects and the original skeleton. Rename your objects.</blockquote>Delete all the objects from your workspace that you don't want to be imported to the game. This includes any secondary objects not part of your final model, your model's skeleton (but not the original model's skeleton), and the original model's objects.
It's also a good idea to rename the your objects to names that describe what they are for. In Blender, renaming the upside-down orange triangle doesn't do it, you have to expand that and rename the upside-down green triangle. Though this isn't strictly necessary to get the replacement model to work, it can really help smooth things out later.

===Export the Model from Your Modeling Program===
[[File:ModelReplacement_exportModel.png|alt=Export Model|thumb|212x212px|Select the File menu (1), then click on export (2), or hover over it and click on Export (3).]]
<blockquote>Summary: Fairly simple, export your model. DAE is probably best.</blockquote>Using File -> Export, export your model as whatever type you wish. Switch Toolbox, as of writing this guide, only handles DAE properly. It has an option for FBX as well, and as it receives updates regularly, FBX or other formats may become properly handled at any time.
It also has an option for importing via CSV (which is not a model type) that is explained in the optional step, below. CSV is only recommended if your exporter cannot export DAE or FBX for whatever reason.

Switch Toolbox now handles DAE's from Blender just fine, so there is no longer any need to use Autodesk FBX Converter, as was originally described here.

====Export the Model using CsvExportRewrite====
<blockquote>Summary: In 3ds Max, use MAXScript -> Run Script... to run CsvExportRewrite.ms and save the model data as a CSV file.</blockquote>Some people - the author included - have trouble with 3ds Max crashing when it tries to export models. For us, there is a MAXScript that exports the model as text, which Switch Toolbox can also use. In the toolbar use the MAXScript menu and select Run Script. Select the CsvExportRewrite script. A small box will pop up with a list of all the objects in your workspace. It has options to "Copy UVs" and "Explicit Normals" for each object. Copy UVs is disabled by default, and Explicit Normals is enabled by default. These settings should suffice, though if you end up with strange textures in game, try re-exporting with Copy UVs checked.
When you select export, 3ds Max will stop responding for a little bit as it exports, then it will respond again. When it responds, check the csv file it created. If it is empty, go through all of your objects, collapse or delete any modifiers that aren't the Skin modifier, Edit Normals modifier, or Editable Mesh, then select the Skin modifier for every object so that the modifiers background is dark grey (not blue), and then export again to a different file. It will fail again if you try to export to an empty file it has previously created, unless you've restarted 3ds Max since it created that file.

===Import the Model Using Switch Toolbox===
[[File:ModelReplacement_importOptions.png|thumb|The list of import options Switch Toolbox displays.]]
<blockquote>Summary: Replace the original model in Switch Toolbox.</blockquote>If you didn't leave Switch Toolbox open, reopen it now, and reopen the SBFRES you got the original model from. Right-click on the model that you want to replace, select Replace, and select the file you exported from your modeling program.
A dialog window of import options will appear. The picture to the right contains settings for most armors, but you should generally match the formats you copied down in the first step of this tutorial.

Red box: Generally leave these unchecked. If your textures look all funky, try reimporting with Flip UVs. If you import and the model is not looking at you, but is instead face-down, reimport with Rotate -90 degrees checked. If you import and the model is face-up, use Rotate 90 degrees. If you modified the skeleton, use Import Bones. (It's possible that skeletons exported from Blender may not import correctly if you don't export as FBX.)

Orange box: Keep Original Skin Count will be disabled by default in order to help avoid model stretching issues, but if your weights did not change then you can check this box to help solve some issues. Always check Map Original Materials. If you are importing from DAE or FBX, then you should check Use Original Attributes and Use Original Attribute Formats. If you checked those boxes and changed the names of the objects from the original model, pay special attention to the teal box instructions below. If you check those two boxes, then you can ignore the green and yellow box instructions below.

Green box: Check all the boxes corresponding to the buffer types that you took note of in the first step of this process, "Obtaining a Rig." If any object has one of those buffer types, check the box.

Yellow box: Select formats from the dropdowns that correspond to the formats you took note of in the first step of this process, "Obtaining a Rig." If the UVs format was Format_16_16_UNorm and the dropdown does not have that option, Format_16_16_SNorm is fine.

Teal box: If you are importing from DAE or FBX, then the left side will have the objects you are importing, and the right side will have the objects you are replacing. This will let you know whether or not Map Original Materials from the orange box will actually do anything, and is one of the reasons why you renamed your objects to the same name as the originals. If you did not rename your objects to the same names as the originals in your modeling program, then you may rename them to the original object names here by selecting them on the left side and correcting their names in the text line above these two boxes. This will save you the trouble of having to set the attributes and formats manually (the green and yellow boxes). The CSV import option does not support Map Original Materials at the time of writing, though it may do so in the future.

Once you've set all your import options, switch back to the Model Settings tab and hit Save.

===Verify the Model Looks Good and Save===
[[File:ModelReplacement_verifyStage.png|alt=Verify|thumb|Verify that the model looks good in the viewer (2) and that the right material (3) is assigned to each object (1)]]
<blockquote>Summary: Check the model in the viewer for dropped weights, and check the material assignments. If it all looks good, save it.</blockquote>Double check the model in the viewer to ensure that it has imported correctly. If it is face-down on its front or face-up on its back, reimport it. If pieces of the model are stretching to the "origin" (the center of the viewer space), then some vertices weren't properly weighted and you need to find them and re-rig them. If the model is wavy, where it should be straight, then you probably imported with 16 bit or 32 bit weights, and need to reimport with Blend Weights format Format_8_8_8_8_UNorm.
Also verify that the material assigned is the correct one. If you imported from a CSV file, these will almost certainly be wrong. This step is another reason we renamed the objects to the original names: the original names have the material name at the end, so there isn't confusion as to what object owns what material. A single material may be assigned to multiple objects, but any object may only have a single material.

Lastly, verify that the vertex buffers list for each object contains all of the same entries as the original object did (you should still have the list from the beginning of this process). If any buffers are missing, reimport the model and check the boxes for those buffers. If they are still missing, your model format does not contain that information (OBJ) and you should use a different format. If there are buffers that the original object did not have, select them and click Remove, then click Yes when it asks if you're sure.

Once all that is done, you're all set. Hit save. Your SBFRES now has your custom model and is ready to be loaded into the game!

==Troubleshooting==

===General===

====Does this work for TitleBG.pack models?====
Yes. There's no functional difference between resident actors (those in TitleBG.pack, denoted by their presence in Bootup.pack's ResidentActors.sbyml file) and normal actors, save that resident actors are always loaded in memory, so they can be displayed without loading delays. This also means that if you've done something wrong, you'll notice the crashing at the title menu or first loading screen, instead of during gameplay.

====Why does the lighting on my model look weird?====
If you obtained your model - that is, the modded one that you are adding to the game - by extracting it using Switch toolbox as a DAE, then Blender and 3dsMax will both fail to read vertex normals on import, and instead generate new ones. This is almost always undesirable, and will result in weird, splotchy shadows on your model. To fix this, use the latest AutoDesk FBX Converter (available [https://aps.autodesk.com/developer/overview/fbx-converter-archives here], yes the latest version is from 2013) to convert the DAE to FBX first.

Not that it's not necessary to convert the rig model, because you delete it. You only need to convert the final model that you will be importing.

Note that once the vertex normals are messed up, converting to FBX won't fix anything. You have to convert it before the first time you transfer the working model from Switch Toolbox to your modeling program.

===Object Placement Issues===

====My eyes are in the model's head, but they aren't in game!====
Splitting the eyes into two different objects may help to fix this. If not...

Eyes are very strange. Link's original eyes are placed correctly, but exporting them will cause them to be placed incorrectly in any 3d modeling program, and reimporting unchanged eyes will cause them to appear in a different place. However, the game will load them as if they were in the correct place. It is generally not advised to move the eyes unless absolutely necessary, as there is no single way to make them work consistently.
[[Category:Guides]]

2024-11-12T18:11:04Z

Ginger: /* Known Issues */

Help:Replacing models

2024-11-11T18:00:02Z

Ginger: /* Apply the Rig from the Original to Your Model */ Adding the armature modifier

Model replacement is the process of changing the shape of an entity (weapon, character, etc) to a custom shape, either created by you or by someone else. Examples of model replacements include the [https://gamebanana.com/skins/163434 Zelda] and [https://gamebanana.com/skins/163132 Linkle] replacement mods.

This tutorial assumes you either have a model already, or will be editing one of the in-game models. It also assumes you will be replacing an in-game model, not making a new one. Pictures dealing with modeling programs are taken in 3ds Max, but similar options should be available in your program of choice.

==Required Tools==
Model replacement in Breath of the Wild requires a set of tools. These tools will vary somewhat, based upon your personal preference, but the tools below are currently the most effective for properly modding the game.

*[https://github.com/KillzXGaming/Switch-Toolbox/releases Switch Toolbox] (Yes, even if you are using WiiU or Cemu)
*A 3D modeling program of your choice (common choices are 3ds Max and Blender)
*(optional) If you are using 3ds Max, the [https://github.com/Aaaboy97/BotW-Tools/tree/master/CSV%20Exporting CSV export] script
*(optional) If you are using 3ds Max, the [https://www.vg-resource.com/thread-29836.html BFRES importer] MaxScript may be helpful. (expand the "Wii U & Nintendo Switch - BFRES importer (originally by ItsEasyActually)" to find it)
*(optional) [https://github.com/Shadsterwolf/BotWUnpacker/releases BotWUnpacker]

==Tutorial==

===Obtaining a Rig===
[[File:ModelReplacement_obtainRig.png|alt=Obtaining a rig|thumb|The red box shows what to click to extract a model.]]
[[File:ModelReplacement VertexBuffers.png|thumb|Select the object (left) and read the vertex buffers (right)]]
<blockquote>Summary: Export a model from the SBFRES you want to use, using Switch Toolbox. Take note of the skin count and the vertex buffers and formats.</blockquote>A "rig" or "skeleton" is a set of "bones" that animations use. Every model is made up of several pieces: objects (which tells the game how to make the model in 3D), materials (which tell the game what the model should look like), and the rig (which tells the game how the model moves during animations). If you were to consider a door, the objects would be the rectangle for the main door and sphere of the knob, the materials would be the wood grain and brown coloring of the door and silver reflective surface of the knob, and the rig would be what tells the game that the knob rotates and the door swings inward.
In order to obtain a rig, you should find the SBFRES archive for the model you wish to use a rig from. Most models are contained in the game files in the content\Model folder. Once you've chosen your SBFRES, copy it to a safe place away from the game files, so you don't accidentally modify any of the original game's files.

Open Switch Toolbox, select File -> Open from the toolbar, and select your SBFRES. On the left side, expand the only available option, and then expand Models. Right-click on the model you need and select Export. If there are multiple options, pick as many as you need. For example, if you are replacing an entire armor set, you would export all three models, but if you were only replacing one piece of the armor, you would export just that piece. Export it as a DAE file. Switch Toolbox will ask if you want to export textures. It's not needed, but it doesn't hurt.

Next, expand the model(s) you are exporting, expand the Objects folder, and select each object in turn. On the right side of Switch Toolbox, you'll see a collapsed section labeled Vertex Buffer. Expand it. In this section, you will see several important things: the skin count, the vertex buffers, and the buffer formats. It's not important to know what all of these things mean if you don't wish, but take note of what they are for every object that you'll be replacing. Screenshots or a text file work well for saving this info. It will be important later.

Note: if you wish to export all the models in an SBFRES quickly, right-click on the Models folder instead and select Export All.

===Import the Original to Your Workspace===
[[File:ModelReplacement_importModel.png|alt=Import the Original Model|thumb|Click on 1 to expand the menu, then click on 2 (or highlight 2 and click on 3) to import. Blender's layout for this step is almost identical.]]
<blockquote>Summary: Import the DAE into a shared workspace with your model, so that the object list has your objects, the original objects, and the original skeleton.</blockquote>Open your 3D modeling program of choice, and bring your replacement model into the workspace. Then, go to File -> Import, and import the DAE model you extracted from the SBFRES. If you exported multiple models, only import the model you are currently working with. For example, if you exported an entire armor, you should only import the legs (or whatever part you are working with). Once you have finished the "Export Your Rigged Model" step, return here to repeat the process for other models.
You may see errors when you import with 3ds Max - this is normal, you can ignore them. Blender suppresses these errors, so you won't see them.
Combine the original model's objects, roughly along the lines of how your objects are. For example, if the original model has separate fingers, hands, and arms, and your model has separate hands and arms, combine the fingers with the hands. Or if your model is only a single object, combine all the original model's objects into a single object. In 3ds Max, you can do this with Command Panel -> Modify -> Edit Geometry -> Attach, and selecting the object to attach the selected object to. In Blender, you can do this by selecting multiple objects with Ctrl+click in Object mode, then right-clicking and selecting Join.

In your object list, you will now see the original model's objects along with your objects. You will also see the original model's skeleton, which is important to have and you should generally not touch it.

===Align Your Model With the Original===
[[File:ModelReplacement_alignModel.png|alt=Align Your Model|thumb|Select your model (1), select the mesh (2), select the type of thing to modify (3), and select how to modify it (4).]]
<blockquote>Summary: Get your objects to match up with the original ones, as close as possible. Anything delicate is important: feet, hands/fingers, waists, necklines, handles of weapons, etc.</blockquote>In all likelihood, your model will differ greatly from the original you just imported. Using the Move, Rotate, and Scale tools, make sure your model lines up with the original's - the closer the better.
There are also plenty of tools in 3ds Max's Edit Poly/Mesh modes, or Blender's Sculpt mode for helping move the model around. In 3ds Max, you can right click on the Edit Mesh/Poly to convert between them. In Blender, one of Sculpt mode's tools is the Pose tool, which is quite good for moving limbs into place if you're modifying an armor.

Rename your objects to something close to the original's, so that you can easily figure out which of your objects corresponds to which original object. This will help both during this step and later, during the "Replace the Original Model with Yours" step. For example, if you have an object for hair, it's encouraged to name it <code>Hair_###__Mt_Hair_###</code>, where ### is the number of the armor you might be working with, and Mt_Hair_### is the name of the material you want to use with it. Including the name of the material in the object is helpful so that when you need to reassign materials in Switch Toolbox (which you may have to do often, depending on how much trouble you have) you will be able to tell, straight away, which object needs which material.

Note: If you need help with this step, there are many great tutorials on YouTube.

===Apply the Rig from the Original to Your Model===
[[File:ModelReplacement_copyRig.png|alt=Copy the Rig|thumb|Select the original object (1), right click on the Skin modifier and copy it (2), select your replacement object (3), and right click in the modifier area and paste the Skin modifier there (4).]]
<blockquote>Summary: Apply the rig from the original object(s) to your object(s). Set maximum limit for bones to affect vertices to the object's skin count.</blockquote>For 3ds Max: Select the original object's Skin modifier in the modifier list, then copy it. Select your object, then paste the rig onto it. If all has gone well, you're done with this step. 3ds Max uses one or more of a series of algorithms to map the rig of one object onto the rig of another object automatically, and it's generally pretty good about it.
For Blender:
* Click and drag the object on top of the original object's Armature (the one with the orange upside-down triangle next to it), while holding shift and alt. This will assign the object to that armature, instead. Then, select the object in Object mode, go to the Modifiers tab (which looks like a diagonal wrench, in the bottom right area), and in the box that says Armature at the top, click on the box next to Object, and select the armature of the original model. If there is no box that says Armature at the top, click on Add Modifier and select Armature. There is now a box that says Armature at the top.
* Select your object in Object mode. In the bottom right, click on the upside-down green triangle. If there is anything in the Vertex Groups tab, delete it all with the - button. Then, Ctrl+click the original object that most closely matches its location. Go into Weight Paint mode, click on the Weights button in the top left, and select Transfer Weights. In the bottom left, expand the new small tab there, if it is not already. For Vertex Mapping, select Nearest Face Interpolated. For Source Layers Selection, select By Name. For Destination Layers Matching, select All Layers.

After applying the rig onto an object, set the limit for the number of bones to affect each vertex to 4. In 3ds Max, you can do this by scrolling the modifier rollout on the right side down to the bottom, expanding Advanced Parameters, and setting the number in the Bone Affect Limit box. In Blender, you can do it with the Limit Total option, found right under the Transfer Weights option described earlier. Other programs will have different ways of setting this limit.

You also want your weights to be normalized. In 3ds Max, the weights are normalized by default. In Blender, in Weight Paint mode, you need to click on the screwdriver-and-wrench icon in the middle of the right side, expand Options, and select Auto Normalize.

If you get the model into the game and the animations deform the model in strange ways, you'll need to come back and manually adjust the rigging, which is a very time-consuming process, documented in a number of excellent tutorials on YouTube.

===Delete the Original Model's Objects===
[[File:ModelReplacement_deleteObjects.png|alt=Delete Original Objects|thumb|The workspace has been cleared of the painted object, leaving only the custom, unpainted one and the skeleton.]]
<blockquote>Summary: Delete the original model's objects and your model's skeleton (if any), leaving just your objects and the original skeleton. Rename your objects.</blockquote>Delete all the objects from your workspace that you don't want to be imported to the game. This includes any secondary objects not part of your final model, your model's skeleton (but not the original model's skeleton), and the original model's objects.
It's also a good idea to rename the your objects to names that describe what they are for. In Blender, renaming the upside-down orange triangle doesn't do it, you have to expand that and rename the upside-down green triangle. Though this isn't strictly necessary to get the replacement model to work, it can really help smooth things out later.

===Export the Model from Your Modeling Program===
[[File:ModelReplacement_exportModel.png|alt=Export Model|thumb|212x212px|Select the File menu (1), then click on export (2), or hover over it and click on Export (3).]]
<blockquote>Summary: Fairly simple, export your model. DAE is probably best.</blockquote>Using File -> Export, export your model as whatever type you wish. Switch Toolbox, as of writing this guide, only handles DAE properly. It has an option for FBX as well, and as it receives updates regularly, FBX or other formats may become properly handled at any time.
It also has an option for importing via CSV (which is not a model type) that is explained in the optional step, below. CSV is only recommended if your exporter cannot export DAE or FBX for whatever reason.

Switch Toolbox now handles DAE's from Blender just fine, so there is no longer any need to use Autodesk FBX Converter, as was originally described here.

====Export the Model using CsvExportRewrite====
<blockquote>Summary: In 3ds Max, use MAXScript -> Run Script... to run CsvExportRewrite.ms and save the model data as a CSV file.</blockquote>Some people - the author included - have trouble with 3ds Max crashing when it tries to export models. For us, there is a MAXScript that exports the model as text, which Switch Toolbox can also use. In the toolbar use the MAXScript menu and select Run Script. Select the CsvExportRewrite script. A small box will pop up with a list of all the objects in your workspace. It has options to "Copy UVs" and "Explicit Normals" for each object. Copy UVs is disabled by default, and Explicit Normals is enabled by default. These settings should suffice, though if you end up with strange textures in game, try re-exporting with Copy UVs checked.
When you select export, 3ds Max will stop responding for a little bit as it exports, then it will respond again. When it responds, check the csv file it created. If it is empty, go through all of your objects, collapse or delete any modifiers that aren't the Skin modifier, Edit Normals modifier, or Editable Mesh, then select the Skin modifier for every object so that the modifiers background is dark grey (not blue), and then export again to a different file. It will fail again if you try to export to an empty file it has previously created, unless you've restarted 3ds Max since it created that file.

===Import the Model Using Switch Toolbox===
[[File:ModelReplacement_importOptions.png|thumb|The list of import options Switch Toolbox displays.]]
<blockquote>Summary: Replace the original model in Switch Toolbox.</blockquote>If you didn't leave Switch Toolbox open, reopen it now, and reopen the SBFRES you got the original model from. Right-click on the model that you want to replace, select Replace, and select the file you exported from your modeling program.
A dialog window of import options will appear. The picture to the right contains settings for most armors, but you should generally match the formats you copied down in the first step of this tutorial.

Red box: Generally leave these unchecked. If your textures look all funky, try reimporting with Flip UVs. If you import and the model is not looking at you, but is instead face-down, reimport with Rotate -90 degrees checked. If you import and the model is face-up, use Rotate 90 degrees. If you modified the skeleton, use Import Bones. (It's possible that skeletons exported from Blender may not import correctly if you don't export as FBX.)

Orange box: Keep Original Skin Count will be disabled by default in order to help avoid model stretching issues, but if your weights did not change then you can check this box to help solve some issues. Always check Map Original Materials. If you are importing from DAE or FBX, then you should check Use Original Attributes and Use Original Attribute Formats. If you checked those boxes and changed the names of the objects from the original model, pay special attention to the teal box instructions below. If you check those two boxes, then you can ignore the green and yellow box instructions below.

Green box: Check all the boxes corresponding to the buffer types that you took note of in the first step of this process, "Obtaining a Rig." If any object has one of those buffer types, check the box.

Yellow box: Select formats from the dropdowns that correspond to the formats you took note of in the first step of this process, "Obtaining a Rig." If the UVs format was Format_16_16_UNorm and the dropdown does not have that option, Format_16_16_SNorm is fine.

Teal box: If you are importing from DAE or FBX, then the left side will have the objects you are importing, and the right side will have the objects you are replacing. This will let you know whether or not Map Original Materials from the orange box will actually do anything, and is one of the reasons why you renamed your objects to the same name as the originals. If you did not rename your objects to the same names as the originals in your modeling program, then you may rename them to the original object names here by selecting them on the left side and correcting their names in the text line above these two boxes. This will save you the trouble of having to set the attributes and formats manually (the green and yellow boxes). The CSV import option does not support Map Original Materials at the time of writing, though it may do so in the future.

Once you've set all your import options, switch back to the Model Settings tab and hit Save.

===Verify the Model Looks Good and Save===
[[File:ModelReplacement_verifyStage.png|alt=Verify|thumb|Verify that the model looks good in the viewer (2) and that the right material (3) is assigned to each object (1)]]
<blockquote>Summary: Check the model in the viewer for dropped weights, and check the material assignments. If it all looks good, save it.</blockquote>Double check the model in the viewer to ensure that it has imported correctly. If it is face-down on its front or face-up on its back, reimport it. If pieces of the model are stretching to the "origin" (the center of the viewer space), then some vertices weren't properly weighted and you need to find them and re-rig them. If the model is wavy, where it should be straight, then you probably imported with 16 bit or 32 bit weights, and need to reimport with Blend Weights format Format_8_8_8_8_UNorm.
Also verify that the material assigned is the correct one. If you imported from a CSV file, these will almost certainly be wrong. This step is another reason we renamed the objects to the original names: the original names have the material name at the end, so there isn't confusion as to what object owns what material. A single material may be assigned to multiple objects, but any object may only have a single material.

Lastly, verify that the vertex buffers list for each object contains all of the same entries as the original object did (you should still have the list from the beginning of this process). If any buffers are missing, reimport the model and check the boxes for those buffers. If they are still missing, your model format does not contain that information (OBJ) and you should use a different format. If there are buffers that the original object did not have, select them and click Remove, then click Yes when it asks if you're sure.

Once all that is done, you're all set. Hit save. Your SBFRES now has your custom model and is ready to be loaded into the game!

==Troubleshooting==

===General===

====Does this work for TitleBG.pack models?====
Yes. There's no functional difference between resident actors (those in TitleBG.pack, denoted by their presence in Bootup.pack's ResidentActors.sbyml file) and normal actors, save that resident actors are always loaded in memory, so they can be displayed without loading delays. This also means that if you've done something wrong, you'll notice the crashing at the title menu or first loading screen, instead of during gameplay.

===Object Placement Issues===

====My eyes are in the model's head, but they aren't in game!====
Splitting the eyes into two different objects may help to fix this. If not...

Eyes are very strange. Link's original eyes are placed correctly, but exporting them will cause them to be placed incorrectly in any 3d modeling program, and reimporting unchanged eyes will cause them to appear in a different place. However, the game will load them as if they were in the correct place. It is generally not advised to move the eyes unless absolutely necessary, as there is no single way to make them work consistently.
[[Category:Guides]]

Help:Tools/UKMM

2024-11-08T04:05:38Z

Ginger: Tool Infobox license acronym letter order

Help:Using mods

2024-11-08T00:17:08Z

Ginger: /* Installing mods using UKMM */

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