MMRecompRando

This is an Archipelago randomizer mod for Majora's Mask: Recompiled with both Singleplayer and Multiworld support.

Disclaimer

This randomizer is still under development in the beta phase but is considered stable for playing. You may encounter features that are not finished yet or errors. Be sure to check the Issues page and report anything you encounter there.

Setup

Prerequesites

In order to be able to play the randomizer, you'll first need the following:

• Download Zelda64Recomp and unzip its contents anywhere except in any folder related to OneDrive, such as Documents or Pictures;
• Downlaod Visual Studio C++ Redist;
• A legal ROM of The Legend of Zelda: Majora's Mask - US.

Mod Installation

1. Download the mod: MMRecompRando.zip;
2. Launch Zelda 64: Recompiled;
3. Install the mod using one of the following methods:
   1. Click on Mods to open the mod menu, click Install Mods, then select MMRecompRando.zip;
   2. Click and drag the MMRecompRando.zip file on top of the Zelda 64: Recompiled window.

Important

Do not unzip the MMRecompRando.zip file.

Optional Setup

• Thunderstore to download additional mods or texture packs;
  • The installation process for any mod/texture pack is the same as instructed above in the Mod Installation section.
• PopTracker along with the pack for auto-tracking.

Solo Setup

1. With the MMRecompRando mod enabled, click Start Game;
2. Select Solo in the randomizer menu;
3. Create a new session and choose which settings you'd like;
4. Click Generate and select your seed.

Multiworld Setup

YAML Creation

Every player wishing to play Majora's Mask: Recompiled Randomizer requires a YAML file. A YAML file is the file used to configure each player's world. To obtain and configure such a file, you must follow these steps:

1. Download and install the Archipelago software (install directory defaults to C:\ProgramData\Archipelago);
2. Download mm_recomp.apworld found in the latest release page;
3. Move the mm_recomp.apworld file in Archipelago\custom_worlds;
4. Launch the Archipelago launcher;
5. Follow one of these two steps:
   1. Search for and click Generate Template Options. This will open a window with YAMLs of every world installed (if not, they can be found in Archipelago\Players\Templates). Search for and open Majora's Mask Recompiled.yaml and edit your options as desired with the use of a text editor, such as Notepad++;
   2. Search for and click Options Creator and edit your options. Once it's done, click the Export Options and save it somewhere.

Seed Creation

Only the host needs to follow the following steps in order to create a seed:

1. Collect each player's YAML files and move them all to Archipelago\Players;
   • If there are players playing other games, make sure to collect the corresponding APWorlds as well and move them to Archipelago\custom_worlds.
2. Launch the Archipelago launcher;
3. Search for and click Generate. If the generation was successful, the output .zip file is in Archipelago\output;
4. Go to the Archipelago website, click on Get Started → Host Game, then upload the .zip file you generated in the previous step.

Connecting to a Multiworld

1. Launch Zelda 64: Recompiled and make sure the randomizer mod is enabled;
2. Click Start Game;
3. Select Multiworld in the randomizer menu;
4. Input your Server Address (usually archipelago.gg), Player/Slot Name, and Password (if applicable);
5. Click Connect. At this point, you are ready to play the randomizer.

FAQ

I launched this mod and my save is gone? Did rando delete my save?

Don't worry, your vanilla saves are intact. When playing this mod, a per-session savefile will be created. Your normal save file will not be touched.

I got a trade item that occupies the same slot of another in the inventory. Is it just gone?

Move your cursor to that slot and press the L or A button. It will cycle through all available trade items in that slot.

I turned on "Intro Checks", but the door to go back through Clock Tower is closed. What am I supposed to do?

Approach the door and press the A button. It will open the door.

I approached a Great Fairy fountain, but nothing happened. Am I not supposed to get a reward from it?

If nothing happened, then "Shuffle Great Fairy Rewards" is set to "Disabled". These locations are not shuffled in the pool. Therefore, you do not need to do them.

Why can't I buy Magic Beans?

To ensure players don't go out of logic, finding the Magic Beans item in the pool will unlock the ability to buy more from the swamp Scrub Merchant and the bean seller in the Deku Palace grotto.

Universal Tracker/PopTracker is telling me that I can do "Twin Islands Ramp Grotto", but I don't have Goron Mask. Is that a logic error?

It is not a logic error. There is a scarecrow that can be spawned at the top of the ramp. Stand on the first island and pull out the ocarina. You will then be able to hookshot the scarecrow.

Universal Tracker/PopTracker is telling me that I can do "Romani Ranch Doggy Racetrack Rooftop Chest", but I don't have access to Magic Beans and don't have Hookshot. Is that a logic error?

It is not a logic error. You can transform into Zora to climb on the fence, then jump on the rooftop.

I opened a chest/got a check and it always shows a grey Archipelago item, what's wrong with you?

The phantom AP item means either something went wrong with your connection or the check is not yet implemented. Please use a text client or the PopTracker pack (see Optional Setup) to see checks that you can definitely get.

If you picked up a phantom on a check that should be implemented, you can open an issue on this repo letting us know!

Known Issues

• Kotake sometimes does not show the price of her shopsanity item in the second dialogue.
• When using mod version 0.9.5, the game will crash when connecting to a seed generated on version 0.9.4 or below. Until this is properly addressed, a temporary solution is to downgrade the mod to 0.9.4.

Credit for additional mods included

Thank you to the original authors of some of the other recomp mods used!

• ThatHypedPerson (Color Mods)
• danielryb (Better SoDT, Z-Target Fix, Song Utils)

Contributing

Warning

The developers and maintainers of this randomizer, along with the N64 Recompiled community as a whole, disallow any "vibe-coded" contributions to this repository. Any contributions or extra features for this randomizer which are primarily AI generated are not endorsed by us.

For more information see CONTRIBUTING.md.

Writing mods

See this document for an explanation of the modding framework, including how to write function patches and perform interop between different mods.

Tools

You'll need to install clang and make to build rando.

• On Windows, using chocolatey to install both is recommended. The packages are llvm and make respectively.
• On MacOS, these can both be installed using Homebrew, as well as zip. Apple clang won't work, as you need a mips target for building the mod code.
• On Linux, install the above packages, and some additional ones: clang, make, llvm, lld, zip, using your distro's package manager.

You'll also need to build N64Recomp for the RecompModTool utility, and copy it into your clone of rando (or put it on your PATH).

Building

• First, make sure you've cloned the repo recursively git clone https://github.com/RecompRando/MMRecompRando --recurse-submodules or you can update the submodules afterwards git submodule update --init --recursive.
• Then, run make (with an optional job count) to build the mod code itself.