.github/workflows/validate.yml

@@ -9,7 +9,7 @@ on:
       N64RECOMP_COMMIT:
         type: string
         required: false
-        default: 'ba4aede49c9a5302ecfc1fa599f7acc3925042f9'
+        default: '388c16c13f7ab5f18ea41da9c58f5b6478498f57'
       DXC_CHECKSUM:
         type: string
         required: false

BUILDING.md

@@ -1,8 +1,13 @@
 # Building Guide
 
-This guide will help you build the project on your local machine. The process will require you to provide a decompressed ROM of the US version of the game.
+> [!NOTE]  
+> The need for an elf file from the Majora's Mask decompilation is temporary and will be removed in the future.
 
-These steps cover: decompressing the ROM, running the recompiler and finally building the project.
+This guide will help you build the project on your local machine. The process will require you to provide two items:
+- A decompressed ROM of the US version of the game.
+- An elf file created from [this commit](https://github.com/zeldaret/mm/tree/23beee0717364de43ca9a82957cc910cf818de90) of the Majora's Mask decompilation.
+
+These steps cover: acquiring these, running the required processes and finally building the project.
 
 ## 1. Clone the Zelda64Recomp Repository
 This project makes use of submodules so you will need to clone the repository with the `--recurse-submodules` flag.
@@ -35,14 +40,20 @@ The other tool necessary will be `make` which can be installe via [Chocolatey](h
 choco install make
 ```
 
-## 3. Decompressing the target ROM
+## 3. Creating the ELF file & decompressed ROM
-You will need to decompress the NTSC-U N64 Majora's Mask ROM (sha1: d6133ace5afaa0882cf214cf88daba39e266c078) before running the recompiler.
+You will need to build [this commit](https://github.com/zeldaret/mm/tree/23beee0717364de43ca9a82957cc910cf818de90) of the Majora's Mask decompilation. Follow their build instructions to generate the ELF file and decompressed ROM. However, while building you may get the following build error:
+```bash
+RuntimeError: 'jr' instruction does not have an 'jump label' field
+```
 
-There are a few tools that can do it:
+To fix this you will have to modify the problematic file `tools/disasm/disasm.py` at line 1115. This issue is due to a bug in this specific commit of the decomp project and will be resolved once Zelda64Recomp is updated to a more recent commit. To fix it, replace the line:
-* This python script from the Majora's Mask decompilation project: https://github.com/zeldaret/mm/blob/main/tools/buildtools/decompress_baserom.py
+```diff
-* https://github.com/z64tools/z64decompress
+- elif insn.isJump():
++ elif insn.isJumpWithAddress():
+```
 
-Regardless of which method you use, copy the decompressed ROM to the root of the Zelda64Recomp repository with this filename:
+Upon successful build it will generate the two required files. Copy them to the root of the Zelda64Recomp repository:
+- `mm.us.rev1.rom_uncompressed.elf`
 - `mm.us.rev1.rom_uncompressed.z64`
 
 ## 4. Generating the C code
@@ -60,9 +71,7 @@ After that, go back to the repository root, and run the following commands:
 
 Finally, you can build the project! :rocket:
 
-On Windows, you can open the repository folder with Visual Studio, and you'll be able to `[build / run / debug]` the project from there.
+On Windows, you can open the repository folder with Visual Studio, and you'll be able to `[build / run / debug]` the project from there. If you prefer the commandline or you're on a Unix platform you can build the project using CMake:
-
-If you prefer the command line or you're on a Unix platform you can build the project using CMake:
 
 ```bash
 cmake -S . -B build-cmake -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang -G Ninja -DCMAKE_BUILD_TYPE=Release # or Debug if you want to debug
@@ -71,7 +80,7 @@ cmake --build build-cmake --target Zelda64Recompiled -j$(nproc) --config Release
 
 ## 6. Success
 
-Voilà! You should now have a `Zelda64Recompiled` executable in the build directory! If you used Visual Studio this will be `out/build/x64-[Configuration]` and if you used the provided CMake commands then this will be `build-cmake`. You will need to run the executable out of the root folder of this project or copy the assets folder to the build folder to run it.
+Voilà! You should now have a `Zelda64Recompiled` file in the `build-cmake` directory!
 
 > [!IMPORTANT]  
 > In the game itself, you should be using a standard ROM, not the decompressed one.

patches.toml

@@ -12,5 +12,3 @@ func_reference_syms_file = "Zelda64RecompSyms/mm.us.rev1.syms.toml"
 data_reference_syms_files = [ "Zelda64RecompSyms/mm.us.rev1.datasyms.toml", "Zelda64RecompSyms/mm.us.rev1.datasyms_static.toml" ]
 # Tell the recompiler to write the output binary. Doing this instead of using objcopy allows the recompiler to patch MIPS32 relocs.
 output_binary_path = "patches/patches.bin"
-# Do not emit warnings for unpaired LO16 values, as clang produces many of them.
-unpaired_lo16_warnings = false