Help:Using mods: Difference between revisions

← Older edit

Help:Using mods (view source)

Revision as of 17:27, 12 December 2024

3,389 bytes added , 7 months ago

→‎Wii U Console

Nebroc

8

edits

@@ Line 12: / Line 12: @@
 === Setting up homebrew ===
-Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software.
+Follow [https://web.archive.org/web/20240101140009/https://wiiu.hacks.guide/#/ this guide] to set up your Wii U console to use homebrew software.
-=== Setting up SDCafiine ===
+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.
-SDCafiine is a Wii U homebrew program that will load modded game files from your SD card.
-# Download the latest stable release of SDCafiine (not a "nightly" version) from [https://github.com/Maschell/SDCafiine/releases here].
+=== 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.)
+# 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, you just need to select the SDCafiine option from the Homebrew Launcher, then boot your game immediately afterwards.
+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 ===
@@ Line 32: / Line 43: @@
 === Dumping the game files ===
-To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.
+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.
-=== Installing the DLC ===
+Note: On older versions (before Cemu 2.1), you have to install the update and 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.
+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.
-=== Installing mods with the graphicpack menu ===
+=== Setting up and Maximizing Performance ===
-This method works as of Cemu 1.15.1.
+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.
-# Create a new folder inside <code>Cemu/graphicPack/</code> named after the mod you want to use.
+=== 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). 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]
   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
   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. Note that most mods should not be enabled or disabled while the game is running.
+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 ===
+== Switch ==
-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.
-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.
-== Switch ==
 === Setting up homebrew ===
-Follow [https://guide.sdsetup.com this guide] to set up your Switch console to use homebrew software.
+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.
@@ Line 83: / Line 116: @@
 To disable problematic telemetry reports:
-* For 1.5.0, 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).
+* 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 [http://static.zeldamods.org/patch_switch160_no_telemetry.ips patch] and put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).
+* 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>, <code>sxos</code>, or <code>reinx</code>, depending on which CFW you are using.
+# 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>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>.
+# 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/titles/01007EF00011E000</code>.
+Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
+[[Category:Guides]]