Help:Using mods: Difference between revisions

Jump to navigation Jump to search

Help:Using mods (view source)

Revision as of 20:55, 6 March 2020

3,104 bytes added ,  4 years ago
m
clarify telemetry patch location
VisualWikitext
imported>BravelyPeculiar
imported>Leoetlino
m (clarify telemetry patch location)
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play om:
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
* Wii U console
Line 5: Line 5:
* Switch console
* 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 the latest 1.5.0 version of BotW.
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).
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).
Line 27: Line 27:


== Cemu Emulator ==
== 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 ===
=== Setting up homebrew ===
Line 35: Line 38:


=== Installing the DLC ===
=== 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 Maximising Performance ===
Now that you have Cemu and your games files, it is recommended you use [http://compat.cemu.info/wiki/Serfrosts_Cemu_Setup_Guide Serfrosts Cemu Setup Guide] to maximise performance on your hardware before installing mods.
=== 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 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.


=== Installing mods with the graphicpack menu ===
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+
This method works as of Cemu 1.15.1.


# Create a new folder inside <code>Cemu/graphicPack/</code> named after the mod you want to use.
# 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.)
# 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). Inside it goes:
# 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]
  [Definition]
  titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
  titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
  name = Mod Name
  name = <Mod Name>
  path = "The Legend of Zelda: Breath of the Wild/Game Mods/Mod Packs/Mod Name"
  path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
  description = Mod description here.
  description = <Mod description here>
  version = 3
  version = 3
  fsPriority = 100
  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.
<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. Note that most mods should not be enabled or disabled while the game is running.


== Switch ==
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.
 
=== Installing mods using BCML ===
Mods that are already packaged as a graphic pack can also 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 the [[RSTB]], the same [[SARC]] files, or [[Message archives]] will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:
 
# Install BCML using the instructions [[Help:Tools/BCML#Setup|here]].
# '''Command line version''': Install a mod by running <code>bcml install path\to\mod.zip</code>.  {{CLI help}} BCML will ask you to specify the directory where Cemu is installed first.
# '''Graphical version''': Open the GUI by running <code>bcml-gui</code>. {{CLI help}} Select the directory where Cemu is intalled. Then click "Install" and select the mod you want to install.


=== Warning ===
BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and looking in the "BCML Mods" category.
When you boot custom firmware (CFW) on your Switch console, the console becomes permanently "online-unsafe". Turning off Airplane Mode while unsafe has a risk of gettinf the console banned from Nintendo's online services (including eShop and game updates). This risk is reduced if you are sensible and only use mods on offline games (don't install NSPs or pirate games!)


If you never went online while in "online-unsafe" mode, then by restoring a clean NAND backup that you made ''before'' you ever booted into CFW, you can make the console "online-safe" again. You can then safely go online until the next time you boot into CFW.
== Switch ==


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


This tutorial uses Atmosphere CFW. Using SXOS CFW is not recommended, as unlike Atmosphere, it costs money, uses stolen code (from Atmosphere!), and is closed source, making it impossible to check how safe it is to use.
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.
=== Installing mods ===


# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>, <code>sxos</code>, or <code>reinx</code>, depending on which CFW you are using.
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.
# Within that folder, there should be a folder named <code>titles</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>.
# 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.
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 ===
=== Disabling telemetry reports ===
Line 81: Line 96:
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.
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, download this [http://static.zeldamods.org/patch_switch150_no_telemetry.ips patch] and put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).
To disable problematic telemetry reports:
 
* For 1.5.0, download this [http://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 [http://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]]
Anonymous user
Retrieved from "https://zeldamods.org/wiki/Special:MobileDiff/6903...6920"

Navigation menu