From 87b36468dcac3e457f2f77bce3380c7ecddc501b Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Sat, 4 Jun 2022 16:45:51 -0600 Subject: fixed readme and script comments --- README.md | 8 +++++--- patch_iso.sh | 16 ++++++++-------- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4d84797..626f5b4 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,13 @@ You need three things before starting: * Linux/BSD with `bash` installed * macOS * ~~Windows with [Cygwin](https://www.cygwin.com/)~~ (Not Implemented) or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) -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) +2. A Mario Kart Wii image in ISO, WBFS, WDF, WIA, CISO, WBI, or GCZ format. (Obtained legally, of course) +3. The Riibalanced Patch Archive (This can be downloaded via the Riibalanced Discord Server) -After that, run the following command: +After that, clone the repository and run the script: ``` +git clone https://github.com/brysonsteck/riibalanced-patcher.git +cd riibalanced-patcher ./patch_iso.sh ``` The script will guide you on what you need to do in order for the pather to work correctly. diff --git a/patch_iso.sh b/patch_iso.sh index 6fe8f0c..b46c9ca 100755 --- a/patch_iso.sh +++ b/patch_iso.sh @@ -27,7 +27,7 @@ if [[ ! -d "./V5/" ]]; then exit 3; fi -# check if correct programs are installed ---------------------------------------- +# check if correct programs are installed --------------------------------------- # curl ------ type curl @@ -93,7 +93,7 @@ if [[ ERROR -ne 0 ]]; then fi fi -# check for image ------------------------------------------------ +# check for image --------------------------------------------------------------- if [[ ! $1 ]]; then echo "ERROR: Please start this script with the path to the Mario Kart Wii ISO image to start the patch." @@ -101,7 +101,7 @@ if [[ ! $1 ]]; then exit 0 fi -# check for previous image extraction ----------------------------------- +# check for previous image extraction ------------------------------------------- if [[ -d "./RMCE01/" ]]; then echo "The output directory for the image extraction exists (./RMCE01) and will be DELETED to get a fresh extraction." @@ -110,7 +110,7 @@ if [[ -d "./RMCE01/" ]]; then rm -rf ./RMCE01 fi -# start extract ----------------------------------------------------------- +# start extract ----------------------------------------------------------------- wit extract $1 RMCE01 ERROR="$?" @@ -120,9 +120,9 @@ if [[ ERROR -ne 0 ]]; then exit $ERROR fi -# start patch ------------------------------------------------------------- +# start patch ------------------------------------------------------------------- -echo "Extraction seems to be complete. Starting patch." +echo "Extraction seems to be complete. Patching..." #set -x cp V5/Riibalanced/Core/StaticRU.rel RMCE01/DATA/files/rel/StaticR.rel @@ -267,7 +267,7 @@ cp V5/Riibalanced/Music/STRM_N_FACTORY_N.brstm RMCE01/DATA/files/sound/strm/ echo echo "Patch complete. wit will now compile the resulting disc image." -# overwrite check ------------------------------------------------------ +# overwrite check --------------------------------------------------------------- if [[ -f "./riibalanced.wbfs" ]]; then echo "The file 'riibalanced.wbfs' exists in this directory." @@ -282,7 +282,7 @@ if [[ -f "./riibalanced.wbfs" ]]; then done fi -# build ---------------------------------------------------------------- +# build ------------------------------------------------------------------------- wit mix RMCE01/ -B --dest riibalanced.wbfs wit edit riibalanced.wbfs --name MarioKartRiibalanced -- cgit v1.2.3