Help:Using mods: Difference between revisions
NiceneNerd (talk | contribs) (Update information on using BCML) |
m (updated the link for the Cemu Optimize guide, as the link provided would send you to this one anyway, also fixed a couple typos) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 15: | Line 15: | ||
=== Setting up WUPS SDCafiine === | === 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 | 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]. | # Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here]. | ||
Line 46: | Line 46: | ||
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. | 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 | === Setting up and Maximizing Performance === | ||
Now that you have Cemu and your games files, it is recommended you use [ | 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. | ||
Line 53: | Line 53: | ||
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: | 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= | # 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. | # Open BCML. | ||
# Click the floating action button to install mods. | # Click the floating action button to install mods. | ||
Line 60: | Line 60: | ||
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. | 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 === | === Installing mods with the graphic pack menu === | ||
Line 107: | Line 106: | ||
To disable problematic telemetry reports: | To disable problematic telemetry reports: | ||
* For 1.5.0, download this [ | * 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 [ | * 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 === | === Installing mods === |
Revision as of 13:06, 31 December 2022
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 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 here.
- Extract the contents of the .zip into the root of your SD card.
- Download the latest WUPS nightly of SDCafiine from 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
sdcafiine
. - 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
00050000101C9300
, the US version uses00050000101C9400
, and the EU version uses00050000101C9500
. - 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
content
. Your mod files will go in here. (Mods will often include acontent
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 Official Cemu Website
Setting up homebrew
Follow 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 dump the game files from the console to your computer. Then run the U-King.rpx
file from Cemu to boot the game.
Installing the DLC
If you dumped the game's add-on content (aoc) files, follow 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 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 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 Resource system, 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 here or in this video tutorial.
- Open BCML.
- Click the floating action button to install mods.
For more information on using BCML, see the 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 The Legend of Zelda: Breath of the Wild/Mods/BCML
is enabled.
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 Cemu/graphicPacks/
. 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 Cemu/graphicPacks/
. A graphic pack will have a file called rules.txt
next to the content
and/or aoc
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
Cemu/graphicPacks/
named after the mod you want to use. - Inside that folder, create a folder named
content
. Your mod files will go in here. (Mods will often include acontent
folder already to make things clear.) - Create a file named
rules.txt
next to thecontent
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
version
must be set to 3 to work correctly. fsPriority
determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an fsPriority
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 Options > Graphic Packs
or by right-clicking a game and selecting Edit Graphic Packs
.
Note that most mods should not be enabled or disabled while the game is running.
Switch
Setting up homebrew
Follow 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.
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 patch, put it in
/atmosphere/exefs_patches/botw_no_telemetry/
(create new folders if required) and rename the file to16A91992BBA71201E98756F3BC8F5D2F.ips
. This patch works for the Switch 1.5.0 executable only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).
- For 1.6.0, download this patch, put it at
/atmosphere/exefs_patches/botw_no_telemetry/
(create new folders if required) and rename the file to8E9978D50BDD20B4C8395A106C27FFDE.ips
. 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
atmosphere
. - Within that folder, there should be a folder named
contents
. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is01007EF00011E000
. (In versions of Atmosphere prior to v0.10.0, thecontents
folder was instead calledtitles
.) - Inside that, make a folder called
romfs
. 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 /atmosphere/contents/01007EF00011E000
.