Fox Prince

README.md

@@ -125,6 +125,10 @@ With the exception of the Logic settings (which are determined in your Archipela
   - Pairs each entrance up with one that matches the expected direction on the other side (i.e. North/South, East/West, Teleporters, Ladders Up/Down)
 - Entrance Randomizer: Decoupled Entrances
   - Turns every entrance into a one-way. Leaving from where you came will take you somewhere else.
+- Entrance Randomizer: Fox Prince
+  - When using an entrance, you get 3 choices of entrances to choose from so you can decide where to go.
+    - Inspired by the [Hollow Knight Bug Prince mod](https://github.com/dplochcoder/HollowKnight.BugPrince/releases/latest), created by Purenail.
+    - Also inspired by [Blue Prince](https://store.steampowered.com/app/1569580/Blue_Prince/), by Dogubomb.
 - Fool Traps
   - Enables fool traps, which replace low-value money rewards when enabled and apply damage/other negative effects to the player. Turning the setting up increases the amount of traps in the item pool.
   - For Single Player seeds, this option can be changed mid-run by changing the value and reloading the save file. For Archipelago games, this is a yaml option and cannot be changed after the game starts.
@@ -263,3 +267,4 @@ With the exception of the Logic settings (which are determined in your Archipela
 - RadRingtail, Glace, RisingStar111, kingsamps0n, Landie, JimTheEternal, Jabberrocky, Ekkosangen, FletchIsAFurry, and many others for playtesting and helping to improve the mod.
 - SapphireSapphic, ScoutJD, and Br00ty for creating/maintaining the emo/poptracker maps.
 - Andrew Shouldice, Kevin Regamey, Finji, and everyone else involved in making this wonderful game.
+

TunicRandomizer.csproj

@@ -35,8 +35,8 @@
       <HintPath>..\..\..\..\..\Program Files (x86)\Steam\steamapps\common\TUNIC\BepInEx\core\0Harmony.dll</HintPath>
       <Private>False</Private>
     </Reference>
-    <Reference Include="Archipelago.MultiClient.Net, Version=6.6.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <HintPath>packages\Archipelago.MultiClient.Net.6.6.0\lib\net45\Archipelago.MultiClient.Net.dll</HintPath>
+    <Reference Include="Archipelago.MultiClient.Net, Version=6.6.1.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>packages\Archipelago.MultiClient.Net.6.6.1\lib\net45\Archipelago.MultiClient.Net.dll</HintPath>
     </Reference>
     <Reference Include="Assembly-CSharp">
       <HintPath>..\..\..\..\..\Program Files (x86)\Steam\steamapps\common\TUNIC\BepInEx\unhollowed\Assembly-CSharp.dll</HintPath>
@@ -92,7 +92,7 @@
       <Private>False</Private>
     </Reference>
     <Reference Include="Newtonsoft.Json, Version=11.0.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <HintPath>packages\Archipelago.MultiClient.Net.6.6.0\lib\net45\Newtonsoft.Json.dll</HintPath>
+      <HintPath>packages\Archipelago.MultiClient.Net.6.6.1\lib\net45\Newtonsoft.Json.dll</HintPath>
     </Reference>
     <Reference Include="RTLTMPro">
       <HintPath>..\..\..\..\..\Program Files (x86)\Steam\steamapps\common\TUNIC\BepInEx\unhollowed\RTLTMPro.dll</HintPath>
@@ -193,13 +193,15 @@
     <Compile Include="src\Data\PortalCombo.cs" />
     <Compile Include="src\Data\RandomizerSettings.cs" />
     <Compile Include="src\Data\SaveFlags.cs" />
+    <Compile Include="src\Data\SceneImageData.cs" />
     <Compile Include="src\Data\Tooltips.cs" />
     <Compile Include="src\Data\Translations.cs" />
     <Compile Include="src\Data\TrickLogic.cs" />
     <Compile Include="src\Patches\ArachnophobiaMode.cs" />
     <Compile Include="src\Patches\BellShuffle.cs" />
     <Compile Include="src\Patches\BreakableShuffle.cs" />
     <Compile Include="src\Patches\EnemyRandomizer.cs" />
+    <Compile Include="src\Patches\FoxPrince.cs" />
     <Compile Include="src\Patches\FuseRandomizer.cs" />
     <Compile Include="src\Patches\GhostHints.cs" />
     <Compile Include="src\Patches\GrassRandomizer.cs" />
@@ -232,8 +234,10 @@
     <Compile Include="src\TunicRandomizer.cs" />
     <Compile Include="src\Util\CreditsSkipper.cs" />
     <Compile Include="src\Util\DDRSpell.cs" />
+    <Compile Include="src\Util\EntranceSelector.cs" />
     <Compile Include="src\Util\FoolTrap.cs" />
     <Compile Include="src\Util\HeroGraveToggle.cs" />
+    <Compile Include="src\Util\SceneSelectionButton.cs" />
     <Compile Include="src\Util\LadderManager.cs" />
     <Compile Include="src\Util\LogicChecker.cs" />
     <Compile Include="src\Util\MailboxFlag.cs" />
@@ -247,9 +251,10 @@
     <Compile Include="src\Util\UnderConstruction.cs" />
     <Compile Include="src\Util\VisibleByNotHavingItem.cs" />
   </ItemGroup>
-  <ItemGroup />
   <ItemGroup>
     <None Include="packages.config" />
+  </ItemGroup>
+  <ItemGroup>
     <EmbeddedResource Include="src\Data\Grass.json" />
     <EmbeddedResource Include="src\Data\GrassReqs.json" />
     <EmbeddedResource Include="src\Data\Fuses.json" />

packages.config

@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Archipelago.MultiClient.Net" version="6.6.0" targetFramework="net48" />
-  <package id="Newtonsoft.Json" version="13.0.3" targetFramework="net48" />
+  <package id="Archipelago.MultiClient.Net" version="6.6.1" targetFramework="net48" />
 </packages>

src/Data/Hints.cs

@@ -235,36 +235,57 @@ public static void PopulateHints() {
             SaveFile.SetInt($"randomizer hint found 0, Server", 1);
 
             // make the in-game signs tell you what area they're pointing to
-            if (SaveFile.GetInt(EntranceRando) == 1) {
-                foreach (PortalCombo portalCombo in ERData.RandomizedPortals.Values) {
-                    if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Forest Belltower_") {
-                        HintMessages.Add("East Forest Sign", $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_right]");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Archipelagos Redux_lower") {
-                        HintMessages.Add("West Garden Sign", $"[arrow_left] {Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Fortress Courtyard_") {
-                        HintMessages.Add("Fortress Sign", $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}  [arrow_right]");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Darkwoods Tunnel_") {
-                        HintMessages.Add("Quarry Sign", $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_up]");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Ruins Passage_west") {
-                        HintMessages.Add("Ruined Hall Sign", $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_right]");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Overworld Interiors_house") {
-                        HintMessages.Add("Town Sign", $"[arrow_left]  {Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "East Forest Redux, Sword Access_lower") {
-                        HintMessages.Add("East East Forest Sign", $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_right]");
-                    }
-                    if (portalCombo.Portal1.SceneDestinationTag == "East Forest Redux, East Forest Redux Laddercave_lower") {
-                        HintMessages.Add("West East Forest Sign", $"[arrow_left] {Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}");
-                    }
+            if (GetBool(EntranceRando)) {
+                CreateSignHints();
+            }
+        }
+
+        public static Dictionary<string, string> PortalToSignName = new Dictionary<string, string> {
+            {"Overworld Redux, Forest Belltower_", "East Forest Sign"},
+            {"Overworld Redux, Archipelagos Redux_lower", "West Garden Sign"},
+            {"Overworld Redux, Fortress Courtyard_", "Fortress Sign"},
+            {"Overworld Redux, Darkwoods Tunnel_", "Quarry Sign"},
+            {"Overworld Redux, Ruins Passage_west", "Ruined Hall Sign"},
+            {"Overworld Redux, Overworld Interiors_house", "Town Sign"},
+            {"East Forest Redux, Sword Access_lower", "East East Forest Sign"},
+            {"East Forest Redux, East Forest Redux Laddercave_lower", "West East Forest Sign"}
+        };
+
+        public static void CreateSignHints() {
+            foreach (PortalCombo portalCombo in ERData.RandomizedPortals) {
+                if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Forest Belltower_") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_right]";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Archipelagos Redux_lower") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"[arrow_left] {Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Fortress Courtyard_") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}  [arrow_right]";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Darkwoods Tunnel_") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_up]";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Ruins Passage_west") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_right]";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "Overworld Redux, Overworld Interiors_house") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"[arrow_left]  {Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "East Forest Redux, Sword Access_lower") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"{Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])} [arrow_right]";
+                }
+                if (portalCombo.Portal1.SceneDestinationTag == "East Forest Redux, East Forest Redux Laddercave_lower") {
+                    HintMessages[PortalToSignName[portalCombo.Portal1.SceneDestinationTag]] = $"[arrow_left] {Translations.TranslateDefaultQuotes(Locations.SimplifiedSceneNames[portalCombo.Portal2.Scene])}";
+                }
+            }
+            foreach (string sign in PortalToSignName.Values) {
+                if (!HintMessages.ContainsKey(sign)) {
+                    HintMessages[sign] = "???";
                 }
             }
         }
 
+
         private static List<(string, string)> CreateHeroRelicHints() {
             List<ItemData> Relics = ItemLookup.Items.Values.Where(item => item.Type == ItemTypes.RELIC).ToList();
             List<(string, string)> RelicHints = new List<(string, string)>();
@@ -354,7 +375,16 @@ public static string CreateSinglePlayerMailboxHint(System.Random random) {
             if (HintItem == null) {
                 n = 0;
                 while (HintItem == null && n < mailboxHintables.Count) {
-                    if (mailboxHintables[n].Location.SceneName == "Trinket Well") {
+                    if (GetBool(FoxPrinceEnabled)) {
+                        string mailbox = SaveFile.GetString("randomizer mailbox hint location");
+                        if (mailbox != "") {
+                            foreach (Check itemData in TunicUtils.GetAllInUseChecks()) {
+                                if (itemData.CheckId == mailbox) {
+                                    HintItem = itemData;
+                                }
+                            }
+                        }
+                    } else if (mailboxHintables[n].Location.SceneName == "Trinket Well") {
                         foreach (Check itemData in ItemRandomizer.FindAllRandomizedItemsByName("Trinket Coin")) {
                             if (itemData.Location.reachable(ItemRandomizer.SphereZero)) {
                                 HintItem = itemData;