Majora's Mask: Recompiled Mods Collection

This repository contains a collection of mods for Majora's Mask: Recompiled. Each mod is organized under the packages directory, making it easy to maintain and build multiple mods in one place.

Available Mods

• Demo Mod: The demo mod from the template. Located in packages/demo.

Project Structure

packages/           # Directory containing all mods
├── demo/           # Demo mod from the template

deps/              # External dependencies
├── mm-decomp/    # Majora's Mask decompilation project
└── Zelda64RecompSyms/ # Symbol files for the game

include/           # Recomp include files used by all mods

Tools Required

You'll need to install clang and make to build the mods.

• On Windows, using chocolatey to install both is recommended. The packages are llvm and make respectively.
  • The LLVM 19.1.0 llvm-project release binary, which is also what chocolatey provides, does not support MIPS correctly. The solution is to install 18.1.8 instead, which can be done in chocolatey by specifying --version 18.1.8 or by downloading the 18.1.8 release directly.
• On Linux, these can both be installed using your distro's package manager.
• On MacOS, these can both be installed using Homebrew. Apple clang won't work, as you need a mips target for building the mod code.
  • When building on MacOS, you'll need to specify the path to clang and ld.lld using the CC and LD environment variables respectively.

On Linux and MacOS, you'll also need to ensure that you have the zip utility installed.

Building

Simply run make in the root directory to build all mods. This will:

1. Compile each mod's source code
2. Generate the .nrm files using RecompModTool
3. Place the output files in each mod's build directory

The resulting .nrm files can be found in each mod's build directory (e.g. packages/demo/build/mm_recomp_mod_template.nrm).