Options QoL: Mod

README.md

@@ -8,56 +8,74 @@ This randomizer is still under development in the beta phase but is considered s
 
 ## Setup
 
-> [!IMPORTANT]
-> To install mods (including MMRecompRando), drag and drop the downloaded mod zip onto the Zelda64Recomp window before you press "Start Game" and the game will handle extracting and installing the mods for you.
+
+### Prerequesites
+In order to be able to play the randomizer, you'll first need the following:
+- Download [Zelda64Recomp](https://github.com/Zelda64Recomp/Zelda64Recomp/releases/latest) and unzip its contents anywhere except in any folder related to OneDrive, such as `Documents` or `Pictures`;
+- Downlaod [Visual Studio C++ Redist](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-microsoft-visual-c-redistributable-version);
+- A legal ROM of The Legend of Zelda: Majora's Mask - US.
 
 ### Mod Installation
-1. Download the latest [Visual Studio C++ Redist](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-microsoft-visual-c-redistributable-version).
-2. Download [Zelda64Recomp](https://github.com/Zelda64Recomp/Zelda64Recomp/releases/latest).
-3. Download [MMRecompRando.zip](https://github.com/RecompRando/MMRecompRando/releases/latest).
-4. Optionally download any additional mods or texture packs you'd like from [Thunderstore](https://thunderstore.io/c/zelda-64-recompiled/).
-    - You only need to drag and drop mod zips from GitHub or Thunderstore onto the game window to install them.
-5. You can also download [poptracker](https://github.com/black-sliver/PopTracker/releases/latest) along with [G4M3RL1F3's fork of Seto's pack](https://github.com/G4M3RL1F3/Majoras-Mask-AP-PopTracker-Pack/releases/latest)
-6. Open `Zelda64Recompiled`.
-    1. Select your ROM file.
-    2. Install MMRecompRando and any additional mods.
-    3. Select Start Game.
-7. Go nuts.
+1. Download the mod: [MMRecompRando.zip](https://github.com/RecompRando/MMRecompRando/releases/latest);
+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](https://thunderstore.io/c/zelda-64-recompiled/) 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](#mod-installation) section.
+- [PopTracker](https://github.com/black-sliver/PopTracker/releases/latest) along with the [pack](https://github.com/G4M3RL1F3/Majoras-Mask-AP-PopTracker-Pack/releases/latest) for auto-tracking.
 
 ### Solo Setup
-1. Launch the game with the randomizer mod enabled.
-2. Select `Solo` in the randomizer menu.
-3. Create a new session and choose which settings you'd like.
-    - Details about these settings are currently not available through the mod only, you will have to look at the [multiworld's example YAML](https://github.com/RecompRando/MMRecompRando/releases/download/v0.9.5/EXAMPLE_YAML.yaml) for more information on what each setting does.
-4. Hit `Generate` and select your seed.
+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
-1. Launch the game with the randomizer mod enabled.
-2. Select `Multiworld` in the randomizer menu.
-3. Input your Server Address, Player/Slot Name, and optionally a Password.
-4. Hit `Connect`.
-5. Profit.
-
-### Multiworld Archipelago Setup
-1. Know [Archipelago](https://archipelago.gg/tutorial/Archipelago/setup/en).
-2. Download the [apworld](https://github.com/RecompRando/MMRecompRando/releases/latest).
-3. **MAKE SURE** to clear out _any_ apworlds named `mm-recomp.apworld` or `mm_recomp.apworld` from your `Archipelago/lib/worlds` folder and your `Archipelago/custom_worlds` folder.
-4. Place the apworld into `Archipelago/custom_worlds/`.
-5. Generate a multiworld, and host the game either locally or on the website.
+
+#### 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](https://github.com/ArchipelagoMW/Archipelago/releases/latest) (install directory defaults to `C:\ProgramData\Archipelago`);
+2. Download `mm_recomp.apworld` found in the [latest release page](https://github.com/RecompRando/MMRecompRando/releases/latest);
+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](https://archipelago.gg/) 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;
+3. Input your Server Address (usually `archipelago.gg`), Player/Slot Name, and Password (if applicable);
+4. 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 Letter to Kafei and now I can't use the Pendant of Memories! Is it just gone?
+### I got a trade item that occupies the same slot of another in the inventory. Is it just gone?
 
-Try moving your cursor to the Letter to Kafei and pressing the N64's L or A button. That should cycle through all quest items in that slot. That's true for the Moon's Tear item slot and the Room Key item slot as well.
+Move your cursor to that slot and press the `L` or `A` button, however they're bound on your controller/keyboard. It will cycle through all available trade items in that slot.
 
 ### 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 Seto's/G4M3RL1F3's amazing poptracker pack from step 5 to see checks that you can definitely get (though some implemented checks may be missing until the tracker is updated).
+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](#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!
 

include/apcommon.h

@@ -110,6 +110,7 @@
 #define LOCATION_SWAMP_GALLERY_PERFECT 0x08011D
 #define LOCATION_BEAN_DADDY 0x0800A5
 #define LOCATION_EVAN_SONG 0x070241
+#define LOCATION_SWAMP_GUIDE_WINNER 0x0701C5
 #define LOCATION_SWAMP_GUIDE_GOOD 0x071C54
 #define LOCATION_SWAMP_GUIDE_OKAY 0x071C52
 
@@ -121,7 +122,6 @@ RECOMP_IMPORT(".", bool rando_get_death_link_pending());
 RECOMP_IMPORT(".", void rando_reset_death_link_pending());
 RECOMP_IMPORT(".", bool rando_get_death_link_enabled());
 RECOMP_IMPORT(".", void rando_send_death_link());
-RECOMP_IMPORT(".", u32 rando_damage_multiplier());
 RECOMP_IMPORT(".", u32 rando_death_behavior());
 RECOMP_IMPORT(".", u32 rando_get_moon_remains_required());
 RECOMP_IMPORT(".", u32 rando_get_majora_remains_required());