autopatrol, editnews
204
edits
Help:Tools/UKMM: Difference between revisions
Jump to navigation
Jump to search
Update links and directions to new official releases page
(→FAQ: Couple questions about errors) |
(Update links and directions to new official releases page) |
||
| Line 36: | Line 36: | ||
==Installation== | ==Installation== | ||
=== | === Prebuilt program === | ||
Unlike BCML, installing UKMM is simple | Unlike BCML, installing UKMM is simple | ||
| Line 43: | Line 43: | ||
# Run the executable | # Run the executable | ||
If | === 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 | |||
# 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] | |||
# 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, | # 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/ | # - 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 | |||
# 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 | # 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 | # Go into the <code>target</code> folder | ||
| Line 60: | Line 58: | ||
==Setup== | ==Setup== | ||
There are | 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=== | ===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! | 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=== | ===Manual Setup=== | ||
If you | If neither of the two previous sections applied to you, then you'll need to set UKMM up manually. | ||
====General==== | ====General==== | ||
| Line 97: | Line 98: | ||
====Game Dump==== | ====Game Dump==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Setting | !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. | * Certain mods distributed as BNPs are incompatible with UKMM, due to how they were made. A fix is currently being worked on. | ||
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. | 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. | ||