Help:Tools/UKMM: Difference between revisions

Help:Tools/UKMM (view source)

Revision as of 22:26, 1 December 2024

695 bytes removed , 3 days ago

Update links and directions to new official releases page

VisualWikitext

Ginger

autopatrol, editnews

204

edits

@@ Line 36: / Line 36: @@
 ==Installation==
-=== On Windows and Linux ===
+=== Prebuilt program ===
 Unlike BCML, installing UKMM is simple
@@ Line 43: / Line 43: @@
 # Run the executable
-If you're on Linux and receive an error when trying to run it, perform a system upgrade and try again. If you can't perform a system upgrade, you're using a static distro of Linux like steamOS and need to use the instructions for Steam Deck
+=== Building from source ===
+If for some reason the prebuilt binaries don't work for you, or you just want to build it for your own personal reasons, here are the exhaustive directions for doing so
-=== On Steam Deck and macOS ===
+# Install Rust: you can do this on Linux and macOS by opening a terminal and running the command <code>curl –proto ‘=https’ –tlsv1.2 -sSf https://sh.rustup.rs | sh</code> - what this does is download the <code>rustup</code> tool for managing and building Rust applications. It will ask you to enter a number, 1-3. You want to type 1 and then hit enter. You can do this on Windows by using the setup exe located [https://www.rust-lang.org/tools/install here]
-Due to reasons outside the developers' control, the Linux For Steam Deck and macOS versions currently cannot be built by them. They must be built on the system that it going to be using them. The following directions detail how to do this
+# Install CMake: you can do this on macOS by installing the dmg for your system, on Linux by running the sh for your system, and on Windows by installing the msi for your system, all available from [https://cmake.org/download/ here]. On macOS, you may also need to run the terminal command <code>sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install</code> to allow Rust to use CMake.
+# Download the source code (either zip or tar.gz) from the latest release on [https://github.com/GingerAvalanche/ukmm/releases the releases page]
-# Install Rust: you can do this by opening a terminal and running the command <code>curl –proto ‘=https’ –tlsv1.2 -sSf https://sh.rustup.rs | sh</code> - what this does is download the <code>rustup</code> tool for managing and building Rust applications. It will ask you to enter a number, 1-3. You want to type 1 and then hit enter.
+# Extract the source code somewhere. It doesn't matter where. It could be on your desktop, if you want
-# Install CMake: you can do this on macOS by installing the dmg for your system, or on Linux by running the sh for your system, both available from [https://cmake.org/download/ here]. On macOS, you may also need to run the terminal command <code>sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install</code> to allow Rust to use CMake
+# Go into the folder. You know you're in the folder when you see things like <code>assets</code>, <code>book</code>, <code>crates</code>, <code>src</code>, etc in your finder window
-# Download [https://github.com/GingerAvalanche/ukmm/archive/242eeaa2d570258bf7a9f49a4bdbbe9ce3b69a99.zip this version of ukmm] (There is a more up-to-date version, but it contains things you don't want, because functionality was removed in order to implement it a different way, later)
+# - On macOS, control-click the folder name in the path bar, and select Open in Terminal (If the path bar isn't visible, select View -> Show Path Bar). On Steam Deck, open Konsole and then use the <code>cd [path]</code> command (replace <code>[path]</code> with whatever is in the path/address bar in step 5). On Windows, shift-click in empty space inside the folder and select Open PowerShell window here.
-# Extract that zip somewhere. It doesn't matter where. It could be on your desktop, if you want
-# Go into the folder. You know you're in the folder when you see things like <code>assets</code>, <code>book</code>, <code>crates</code>, <code>src</code>, etc in your finder window.
-# On macOS, control-click the folder name in the path bar, and select Open in Terminal (If the path bar isn't visible, select View -> Show Path Bar). On Steam Deck, open Konsole and then use the <code>cd [path]</code> command (replace <code>[path]</code> with whatever is in the path/address bar in step 5)
 # Enter the command <code>cargo build --release</code> - wait for it to finish. This might take a while
 # Go into the <code>target</code> folder
@@ Line 60: / Line 58: @@
 ==Setup==
-There are two methods of setup, depending on whether you are coming from BCML or are just starting out
+There are three methods of setup, depending on whether you are coming from BCML or not, and if not, if you are using Cemu and have set it up already
 ===Importing from BCML===
 If you previously used BCML and it worked for you, congratulations! Your job is easy. Go to the Settings tab, click '''Migrate from BCML'''. Wait for it to finish. There you go! All done!
+===Not importing from BCML, using Cemu===
+If you're using Cemu and you've previously seen the 1.5.0 version number in the bottom right of the BotW main menu, just click '''Import Cemu Settings''' inside the Wii U Config section, and select the folder that contains Cemu.exe. There you go! All done!
 ===Manual Setup===
-If you've never used mods before, or are installing mods for the first time on a new computer, or wiped BCML, or whatever other reason, you will need to set your settings manually
+If neither of the two previous sections applied to you, then you'll need to set UKMM up manually.
 ====General====
@@ Line 97: / Line 98: @@
 ====Game Dump====
-If you're using Cemu and you installed your game/update/DLC with it, click '''Import Cemu Settings''', and select the folder that contains Cemu.exe. You're done.
-Otherwise, consult the following table.
 {| class="wikitable"
 !Setting
@@ Line 186: / Line 184: @@
 * Certain mods distributed as BNPs are incompatible with UKMM, due to how they were made. A fix is currently being worked on.
-* In rare cases, installing a mod from a 7z file causes any custom text it adds to not get added. The cause of this is unknown. It can be worked around by extracting the 7z and installing the rules.txt file directly.
-* In rare cases, installing a mod that does not edit the language you have set in your settings causes your entire game to change languages. The cause of this is unknown. It can be worked around by extracting the mod and deleting the language packs (located in <code>content/Pack</code> for WiiU or <code>romfs/Pack</code> for Switch) you are not going to use.
 If you can provide in-depth support to the developers on how to cause any of these issues, please [https://discord.gg/vPzgy5S contact Ginger on the discord]. This would go a long way toward fixing them.