Rando: Master Sword Shuffle

soh/include/z64save.h

@@ -303,7 +303,7 @@ typedef struct {
     /*        */ char childAltarText[250];
     /*        */ char adultAltarText[750];
     /*        */ RandomizerCheck rewardCheck[9];
-    /*        */ char ganonHintText[150];
+    /*        */ char ganonHintText[300];
     /*        */ char gregHintText[250];
     /*        */ char ganonText[250];
     /*        */ char dampeText[150];
@@ -313,11 +313,12 @@ typedef struct {
     /*        */ char warpRequiemText[100];
     /*        */ char warpNocturneText[100];
     /*        */ char warpPreludeText[100];
-    /*        */ RandomizerCheck ganonHintCheck;
+    /*        */ RandomizerCheck LAHintCheck;
+    /*        */ RandomizerCheck MSHintCheck;
     /*        */ RandomizerCheck gregCheck;
     /*        */ RandomizerCheck dampeCheck;
     /*        */ u8 seedIcons[5];
-    /*        */ u16 randomizerInf[9];
+    /*        */ u16 randomizerInf[10];
     /*        */ u16 adultTradeItems;
     // #endregion
 } SaveContext; // size = 0x1428

soh/soh/Enhancements/debugger/debugSaveEditor.h

@@ -348,7 +348,7 @@ const std::vector<FlagTable> flagTables = {
         { 0x24, "Market Crowd Text Randomizer" },
         { 0x30, "Entered the Market" },
     } },
-   { "Randomizer Inf Flags", RANDOMIZER_INF, 0x08, {
+   { "Randomizer Inf Flags", RANDOMIZER_INF, 0x09, {
         { RAND_INF_DUNGEONS_DONE_DEKU_TREE, "DUNGEONS_DONE_DEKU_TREE" },
         { RAND_INF_DUNGEONS_DONE_DODONGOS_CAVERN, "DUNGEONS_DONE_DODONGOS_CAVERN" },
         { RAND_INF_DUNGEONS_DONE_JABU_JABUS_BELLY, "DUNGEONS_DONE_JABU_JABUS_BELLY" },
@@ -500,6 +500,7 @@ const std::vector<FlagTable> flagTables = {
 
         { RAND_INF_KAK_100_GOLD_SKULLTULA_REWARD, "KAK_100_GOLD_SKULLTULA_REWARD" },
         { RAND_INF_GREG_FOUND, "RAND_INF_GREG_FOUND" },
+        { RAND_INF_TOT_MASTER_SWORD, "RAND_INF_TOT_MASTER_SWORD"},
     } },
 };
 

soh/soh/Enhancements/randomizer/3drando/hint_list.cpp

@@ -2958,6 +2958,20 @@ void HintTable_Init() {
             "Ja, ja, ja... Nunca me derrotarás reflejando mis esferas de energía y desplegando la flecha de luz de " },
     });
 
+
+    /*--------------------------
+    |MASTER SWORD LOCATION TEXT|
+    ---------------------------*/
+
+    hintTable[MASTER_SWORD_LOCATION_HINT] = HintText::MasterSword({
+        // obscure text
+        Text{"And even if you do, you'll never find the legendary blade hidden in ",
+            /*french*/
+            "Et même si tu les trouves, tu ne touveras jamais l'épée de légende cachée dans ",
+            /*spanish*/
+            "E incluso si lo haces, nunca encontrarás la espada legendaria escondida en " },
+    });
+
     hintTable[YOUR_POCKET] = HintText::Exclude({
         // obscure text
         Text{ "your pocket", /*french*/ "tes poches", /*spanish*/ "tu bolsillo" },

soh/soh/Enhancements/randomizer/3drando/hint_list/hint_list_exclude_overworld.cpp

@@ -131,6 +131,10 @@ void HintTable_Init_Exclude_Overworld() {
                        Text{"a #hole in a volcano# holds", /*french*/"la #grotte dans le volcan# contient", /*spanish*/"bajo el #hoyo de un volcán# yace"},
   });
 
+    hintTable[TOT_MASTER_SWORD] = HintText::Exclude({
+                       //obscure text
+                       Text{"a #pedestal in a temple# holds", /*french*/"un #piédestal dans un temple# contient", /*spanish*/"un #pedestal en un templo# sostiene"},
+  });
 
     hintTable[TOT_LIGHT_ARROWS_CUTSCENE] = HintText::Exclude({
                        //obscure text

soh/soh/Enhancements/randomizer/3drando/hints.cpp

@@ -6,6 +6,7 @@
 #include "item_pool.hpp"
 #include "logic.hpp"
 #include "random.hpp"
+#include "settings.hpp"
 #include "spoiler_log.hpp"
 #include "fill.hpp"
 #include "hint_list.hpp"
@@ -141,7 +142,8 @@ Text warpRequiemText;
 Text warpNocturneText;
 Text warpPreludeText;
 
-std::string ganonHintLoc;
+std::string LAHintLoc;
+std::string MSHintLoc;
 std::string dampeHintLoc;
 
 Text& GetChildAltarText() {
@@ -192,8 +194,12 @@ Text& GetWarpPreludeText() {
   return warpPreludeText;
 }
 
-std::string GetGanonHintLoc() {
-    return ganonHintLoc;
+std::string GetLAHintLoc() {
+    return LAHintLoc;
+}
+
+std::string GetMSHintLoc() {
+    return MSHintLoc;
 }
 
 std::string GetDampeHintLoc() {
@@ -589,13 +595,29 @@ void CreateGanonText() {
   auto hint = Hint(LIGHT_ARROW_LOCATION_HINT);
   if (lightArrowLocation.empty()) {
     ganonHintText = hint.GetText()+Hint(YOUR_POCKET).GetText();
-    ganonHintLoc = "Link's Pocket";
+    LAHintLoc = "Link's Pocket";
   } else {
     ganonHintText = hint.GetText()+GetHintRegion(Location(lightArrowLocation[0])->GetParentRegionKey())->GetHint().GetText();
-    ganonHintLoc = Location(lightArrowLocation[0])->GetName();
+    LAHintLoc = Location(lightArrowLocation[0])->GetName();
   }
   ganonHintText = ganonHintText + "!";
 
+  if (ShuffleMasterSword) {
+    //Get the location of the master sword
+    auto masterSwordLocation = FilterFromPool(allLocations, [](const LocationKey loc){return Location(loc)->GetPlacedItemKey() == MASTER_SWORD;});
+
+    // Add second text box
+    ganonHintText = ganonHintText + "^";
+    if (masterSwordLocation.empty()) {
+      ganonHintText = ganonHintText+Hint(MASTER_SWORD_LOCATION_HINT).GetText()+Hint(YOUR_POCKET).GetText();
+      MSHintLoc = "Link's Pocket";
+    } else {
+      ganonHintText = ganonHintText+Hint(MASTER_SWORD_LOCATION_HINT).GetText()+GetHintRegion(Location(masterSwordLocation[0])->GetParentRegionKey())->GetHint().GetText();
+      MSHintLoc = Location(masterSwordLocation[0])->GetName();
+    }
+    ganonHintText = ganonHintText + "!";
+  }
+
   CreateMessageFromTextObject(0x70CC, 0, 2, 3, AddColorsAndFormat(ganonHintText));
 }
 

soh/soh/Enhancements/randomizer/3drando/hints.hpp

@@ -43,6 +43,7 @@ enum class HintCategory {
   Altar,
   Validation,
   LightArrow,
+  MasterSword,
   GanonLine,
   MerchantsDialogs,
 };
@@ -116,6 +117,10 @@ class HintText {
         return HintText{std::move(obscureText), std::move(ambiguousText), std::move(clearText), HintCategory::LightArrow};
     }
 
+    static auto MasterSword(std::vector<Text>&& obscureText, std::vector<Text>&& ambiguousText = {}, Text&& clearText = {}) {
+        return HintText{std::move(obscureText), std::move(ambiguousText), std::move(clearText), HintCategory::MasterSword};
+    }
+
     static auto GanonLine(std::vector<Text>&& obscureText, std::vector<Text>&& ambiguousText = {}, Text&& clearText = {}) {
         return HintText{std::move(obscureText), std::move(ambiguousText), std::move(clearText), HintCategory::GanonLine};
     }
@@ -224,4 +229,5 @@ Text& GetWarpNocturneText();
 Text& GetWarpPreludeText();
 
 std::string GetDampeHintLoc();
-std::string GetGanonHintLoc();
+std::string GetLAHintLoc();
+std::string GetMSHintLoc();

soh/soh/Enhancements/randomizer/3drando/item_list.cpp

@@ -12,7 +12,7 @@ static std::array<Item, KEY_ENUM_MAX> itemTable;
 void ItemTable_Init() {                              // RandomizerGet                              English name                       French                              Spanish                                     Item Type       getItemID       advancement    logic           hint key
     itemTable[NONE]                              = Item(RG_NONE,                              Text{"No Item",                         "Rien",                             "Sin Objeto"},                              ITEMTYPE_EVENT, GI_RUPEE_GREEN,    false,      &noVariable,    NONE);
     itemTable[KOKIRI_SWORD]                      = Item(RG_KOKIRI_SWORD,                      Text{"Kokiri Sword",                    "Épée Kokiri",                      "Espada Kokiri"},                           ITEMTYPE_ITEM,  GI_SWORD_KOKIRI,   true,       &KokiriSword,   KOKIRI_SWORD);
-  //[MASTER_SWORD]
+    itemTable[MASTER_SWORD]                      = Item(RG_MASTER_SWORD,                      Text{"Master Sword",                    "Épée de Legende",                  "Espada Master"},                           ITEMTYPE_ITEM,  0x73,              true,       &MasterSword,   MASTER_SWORD);
     itemTable[GIANTS_KNIFE]                      = Item(RG_GIANTS_KNIFE,                      Text{"Giant's Knife",                   "Lame des Géants",                  "Espada de Biggoron"},                      ITEMTYPE_ITEM,  GI_SWORD_KNIFE,    false,      &noVariable,    GIANTS_KNIFE);
     itemTable[BIGGORON_SWORD]                    = Item(RG_BIGGORON_SWORD,                    Text{"Biggoron's Sword",                "Épée de Biggoron",                 "Espada de Biggoron"},                      ITEMTYPE_ITEM,  GI_SWORD_BGS,      true,       &BiggoronSword, BIGGORON_SWORD);
     itemTable[DEKU_SHIELD]                       = Item(RG_DEKU_SHIELD,                       Text{"Deku Shield",                     "Bouclier Mojo",                    "Escudo deku"},                             ITEMTYPE_ITEM,  GI_SHIELD_DEKU,    false,      &noVariable,    DEKU_SHIELD);

soh/soh/Enhancements/randomizer/3drando/item_location.cpp

@@ -756,6 +756,7 @@ void LocationTable_Init() {
             --- CUTSCENES ---
       -------------------------------*/
 
+    locationTable[TOT_MASTER_SWORD]                              = ItemLocation::Delayed(RC_TOT_MASTER_SWORD,                   0xFF, 0x00, "ToT Master Sword",                               TOT_MASTER_SWORD,            MASTER_SWORD,              {Category::cTempleOfTime, Category::cMarket},                                                                     SpoilerCollectionCheck::MasterSword(),                   SpoilerCollectionCheckGroup::GROUP_HYRULE_CASTLE);
     locationTable[TOT_LIGHT_ARROWS_CUTSCENE]                     = ItemLocation::Delayed(RC_TOT_LIGHT_ARROWS_CUTSCENE,          0xFF, 0x01, "ToT Light Arrow Cutscene",                       TOT_LIGHT_ARROWS_CUTSCENE,   LIGHT_ARROWS,              {Category::cTempleOfTime, Category::cMarket},                                                                     SpoilerCollectionCheck::Chest(0x43, 0x1E),               SpoilerCollectionCheckGroup::GROUP_HYRULE_CASTLE);
     locationTable[LW_GIFT_FROM_SARIA]                            = ItemLocation::Delayed(RC_LW_GIFT_FROM_SARIA,                 0xFF, 0x02, "LW Gift From Saria",                             LW_GIFT_FROM_SARIA,          PROGRESSIVE_OCARINA,       {Category::cLostWoods, Category::cForest},                                                                        SpoilerCollectionCheck::EventChkInf(0xC1),               SpoilerCollectionCheckGroup::GROUP_LOST_WOODS);
     locationTable[ZF_GREAT_FAIRY_REWARD]                         = ItemLocation::Delayed(RC_ZF_GREAT_FAIRY_REWARD,              0xFF, 0x10, "ZF Great Fairy Reward",                          ZF_GREAT_FAIRY_REWARD,       FARORES_WIND,              {Category::cZorasFountain, Category::cFairies},                                                                   SpoilerCollectionCheck::Chest(0x3D, 0x01),               SpoilerCollectionCheckGroup::GROUP_ZORAS_DOMAIN);
@@ -1266,6 +1267,7 @@ std::vector<uint32_t> overworldLocations = {
   OGC_GREAT_FAIRY_REWARD,
 
   //Temple of Time
+  TOT_MASTER_SWORD,
   SHEIK_AT_TEMPLE,
   TOT_LIGHT_ARROWS_CUTSCENE,
 

soh/soh/Enhancements/randomizer/3drando/item_location.hpp

@@ -155,6 +155,10 @@ class SpoilerCollectionCheck {
         return SpoilerCollectionCheck(SpoilerCollectionCheckType::SPOILER_CHK_MAGIC_BEANS, scene, flag);
     }
 
+    static auto MasterSword() {
+      return SpoilerCollectionCheck(SpoilerCollectionCheckType::SPOILER_CHK_MASTER_SWORD, 0x00, 0x00);
+    }
+
     static auto Merchant(int8_t scene, uint8_t flag) {
         return SpoilerCollectionCheck(SpoilerCollectionCheckType::SPOILER_CHK_MERCHANT, scene, flag);
     }

soh/soh/Enhancements/randomizer/3drando/item_pool.cpp

@@ -108,9 +108,10 @@ const std::array<uint32_t, 59> alwaysItems = {
   ARROWS_10,
   TREASURE_GAME_HEART,
 };
-const std::array<uint32_t, 43> easyItems = {
+const std::array<uint32_t, 44> easyItems = {
   BIGGORON_SWORD,
   KOKIRI_SWORD,
+  MASTER_SWORD,
   BOOMERANG,
   LENS_OF_TRUTH,
   MEGATON_HAMMER,
@@ -674,6 +675,13 @@ void GenerateItemPool() {
     PlaceItemInLocation(KF_KOKIRI_SWORD_CHEST, KOKIRI_SWORD, false, true);
   }
 
+  if (ShuffleMasterSword) {
+    AddItemToMainPool(MASTER_SWORD);
+    IceTrapModels.push_back(0x73); //Master Sword without the GI enum
+  } else {
+    PlaceItemInLocation(TOT_MASTER_SWORD, MASTER_SWORD, false, true);
+  }
+
   if (ShuffleWeirdEgg) {
     AddItemToMainPool(WEIRD_EGG);
     IceTrapModels.push_back(GI_WEIRD_EGG);
@@ -1153,6 +1161,10 @@ void GenerateItemPool() {
     ReplaceMaxItem(KOKIRI_SWORD, 0);
   }
 
+  if (!ShuffleMasterSword) {
+    ReplaceMaxItem(MASTER_SWORD, 0);
+  }
+
   if (ProgressiveGoronSword) {
     ReplaceMaxItem(BIGGORON_SWORD, 0);
     AddItemToMainPool(PROGRESSIVE_GORONSWORD, 2);

soh/soh/Enhancements/randomizer/3drando/keys.hpp

@@ -356,6 +356,7 @@ typedef enum {
   MARKET_BOMBCHU_SHOP_ITEM_6,
   MARKET_BOMBCHU_SHOP_ITEM_7,
   MARKET_BOMBCHU_SHOP_ITEM_8,
+  TOT_MASTER_SWORD,
   TOT_LIGHT_ARROWS_CUTSCENE,
 //HYRULE_CASTLE
   HC_MALON_EGG,
@@ -1803,6 +1804,7 @@ typedef enum {
 
   VALIDATION_LINE,
   LIGHT_ARROW_LOCATION_HINT,
+  MASTER_SWORD_LOCATION_HINT,
   DAMPE_DIARY,
   YOUR_POCKET,
 

soh/soh/Enhancements/randomizer/3drando/location_access/locacc_castle_town.cpp

@@ -52,6 +52,7 @@ void AreaTable_Init_CastleTown() {
 
   areaTable[TEMPLE_OF_TIME] = Area("Temple of Time", "Temple of Time", TEMPLE_OF_TIME, NO_DAY_NIGHT_CYCLE, {}, {
                   //Locations
+                  LocationAccess(TOT_MASTER_SWORD, {[]{return IsAdult;}}),
                   LocationAccess(TOT_LIGHT_ARROWS_CUTSCENE, {[]{return IsAdult && CanTriggerLACS;}}),
                 }, {
                   //Exits

soh/soh/Enhancements/randomizer/3drando/location_access/locacc_death_mountain.cpp

@@ -95,7 +95,7 @@ void AreaTable_Init_DeathMountain() {
                   LocationAccess(GC_ROLLING_GORON_AS_CHILD, {[]{return IsChild && (HasExplosives || (GoronBracelet && LogicChildRollingWithStrength));}}),
                   LocationAccess(GC_ROLLING_GORON_AS_ADULT, {[]{return StopGCRollingGoronAsAdult;}}),
                   LocationAccess(GC_GS_BOULDER_MAZE,        {[]{return IsChild && CanBlastOrSmash;}}),
-                  LocationAccess(GC_GS_CENTER_PLATFORM,     {[]{return IsAdult;}}),
+                  LocationAccess(GC_GS_CENTER_PLATFORM,     {[]{return CanAdultAttack;}}),
                   LocationAccess(GC_MEDIGORON,              {[]{return IsAdult && AdultsWallet && (CanBlastOrSmash || GoronBracelet);}}),
                   LocationAccess(GC_MAZE_GOSSIP_STONE,      {[]{return CanBlastOrSmash || CanUse(SILVER_GAUNTLETS);}}),
                   LocationAccess(GC_MEDIGORON_GOSSIP_STONE, {[]{return CanBlastOrSmash || GoronBracelet;}}),