aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f648ecc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Riibalanced ISO Patcher
+
+A simple shell script that takes the Riibalanced Patch Files and builds a WBFS image that can be used in Dolphin for Netplay or simply enjoyment.
+
+## How to use
+
+You need two things before starting:
+
+1. A Mario Kart Wii image in ISO, WBFS, WDF, WIA, CISO, WBI, or GCZ format. (Obtained legally, of course)
+1. The Riibalanced Patch Archive (This can be downloaded via the Riibalanced Discord Server)
+
+After that, the script will guide you on what you need to do in order for the pather to work correctly.
+
+## Current Issues with the Patcher
+
+* Main Menu button videos do not appear
+ * This could be because there is a file referenced in the patch's Riivolution XML, but doesn't exist.
+* Running the resulting image in Dolphin on Windows has the issue above, however, running the resulting image in Dolphin on Linux and macOS(?) does not have this issue for some reason.
+* The resulting image does not work on original hardware.
+ * For whatever reason, the game does not make it past any selection made on the Main Menu before crashing at the black loading screen.
+ * The game also crashes if you try to wait for the trailer at the "Press the A button" screen, showing a white screen before crashing.