Merge pull request #2955 from UmedMuzl/dev-copy1

Tooltip

Author: UmedMuzl

archipelago/Options.py

@@ -37,7 +37,7 @@ class Goal(Choice):
     - pearls: Find a certain number of Pearls to win. See goal_quantity option for more info.
     - bosses: Defeat a certain number of bosses to win. See goal_quantity option for more info.
     - bonuses: Complete a certain number of Bonus Barrels to win. Automatically disables auto_complete_bonus_barrels if set. See goal_quantity option for more info.
-    - treasure_hurry: Run down the timer by collecting treasure! You win when the timer reaches 0.
+    - treasure_hurry: Run down the timer by collecting treasure! You win when the timer reaches 0. If you beat Helm, the wincon automatically changes to beating K. Rool.
     - krools_challenge: K. Rool's ship does not spawn until you collect All keys, Defeat All bosses, Play all Bonus Barrels, and collect All Blueprints.
     - kill_the_rabbit: Kill the rabbit in Chunky's igloo in Caves. Turn it to Ash. Simple as that.
     """

base-hack/assets/displays/treasurechest.png

@@ -1706,7 +1706,7 @@ def patchAssembly(ROM_COPY, spoiler):
     # Fix Null Lag Boost
     writeHook(ROM_COPY, 0x806CCA90, Overlay.Static, "fixNullLagBoost", offset_dict)
 
-    if settings.win_condition_spawns_ship:
+    if settings.win_condition_spawns_ship and not (settings.helm_hurry and settings.archipelago):
         writeValue(ROM_COPY, 0x80029706, Overlay.Menu, getHiSym("k_rool_text"), offset_dict)
         writeValue(ROM_COPY, 0x8002970A, Overlay.Menu, getLoSym("k_rool_text"), offset_dict)
         writeFloatUpper(ROM_COPY, 0x800296D2, Overlay.Menu, 280, offset_dict)

randomizer/Patching/ASMPatcher.py

@@ -705,9 +705,8 @@ def writeWinConImage(settings: Settings, image: Image, ROM_COPY: LocalROM):
 def showWinCondition(settings: Settings, ROM_COPY: LocalROM):
     """Alter the image that's shown on the main menu to display the win condition."""
     win_con = settings.win_condition_item
-    if win_con == WinConditionComplex.beat_krool:
-        # Default, don't alter image
-        return
+    helmhurry = settings.helm_hurry and settings.archipelago
+
     if win_con == WinConditionComplex.krools_challenge:
         images = [
             (0x903, 0, 1),
@@ -728,6 +727,11 @@ def showWinCondition(settings: Settings, ROM_COPY: LocalROM):
             output_image.paste(local_img, (pos_x, pos_y), local_img)
         output_image = output_image.resize((32, 32)).transpose(Image.FLIP_TOP_BOTTOM)
         writeWinConImage(settings, output_image, ROM_COPY)
+    if helmhurry:
+        output_image = Image.open(BytesIO(js.getFile("base-hack/assets/displays/treasurechest.png")))
+        output_image = output_image.resize((32, 32))
+        writeWinConImage(settings, output_image, ROM_COPY)
+        return
     if win_con == WinConditionComplex.get_key8:
         output_image = Image.open(BytesIO(js.getFile("base-hack/assets/displays/key8.png")))
         output_image = output_image.resize((32, 32))

randomizer/Patching/CosmeticColors.py

@@ -1510,6 +1510,35 @@ function update_win_con_num_access() {
       }
     }
   }
+
+  // Update tooltip for special win conditions
+  const TOOLTIP_WIN_CONS = {
+    "krools_challenge": "Beat K. Rool and collect all Keys, Blueprints, Bosses, and Bonus Barrels",
+    "dk_rap_items": "Acquire all items referenced in each verse of the DK Rap:<br><br><strong>Donkey verse</strong> : Coconuts, Strong Kong<br><strong>Diddy verse</strong> : Rocketbarrel, Peanuts, Guitar<br><strong>Lanky verse</strong> : Orangstand, Baboon Balloon, Trombone<br><strong>Tiny verse</strong> : Mini Monkey, Ponytail Twirl, Climbing<br><strong>Chunky verse</strong> : Barrel Throwing<br><strong>The Fridge</strong> : Cranky, Peanuts, Pineapple, Grape, Orange Throwing, Coconuts",
+    "kill_the_rabbit": "Kill the rabbit in Chunky's igloo in Caves. Turn it to Ash. Simple as that."
+  };
+
+  const infoIcon = document.getElementById("win_condition_info_icon");
+
+  // Always dispose existing tooltip first
+  $(infoIcon).tooltip('dispose');
+
+  if (TOOLTIP_WIN_CONS[winConSelection.value]) {
+    infoIcon.setAttribute("title", TOOLTIP_WIN_CONS[winConSelection.value]);
+    infoIcon.setAttribute("data-bs-original-title", TOOLTIP_WIN_CONS[winConSelection.value]);
+    infoIcon.classList.remove("hidden");
+    // Initialize Bootstrap tooltip
+    $(infoIcon).tooltip({
+      trigger: 'hover',
+      html: true,
+      placement: 'right',
+      customClass: 'win-condition-tooltip'
+    });
+  } else {
+    infoIcon.setAttribute("title", "");
+    infoIcon.setAttribute("data-bs-original-title", "");
+    infoIcon.classList.add("hidden");
+  }
 }
 
 document

static/js/rando_options.js

@@ -804,6 +804,41 @@ td.directional_divider {
   min-width: 125px;
 }
 
+#win_condition_container {
+  position: relative;
+}
+
+#win_condition_info_icon {
+  display: inline-block;
+  position: absolute;
+  right: -48px;
+  top: 50%;
+  transform: translateY(-50%) scale(0.7);
+  transform-origin: center center;
+}
+
+#win_condition_info_icon.hidden {
+  display: none !important;
+}
+
+.win-condition-tooltip {
+  opacity: 1 !important;
+}
+
+.win-condition-tooltip .tooltip-inner {
+  background-color: rgb(4, 130, 67, 0.95) !important;
+  border-left: 3px solid var(--donk-green);
+  color: #e3e3e3;
+  text-align: left;
+  line-height: 1.6;
+  max-width: 500px;
+  opacity: 1 !important;
+}
+
+.win-condition-tooltip.bs-tooltip-right .tooltip-arrow::before {
+  border-right-color: rgb(4, 130, 67, 0.95) !important;
+}
+
 #fairy-container {
   text-align: left;
   display: flex;

static/styles/gui.css

@@ -93,6 +93,9 @@ <h2 class="title">ENDGAME OPTIONS</h2>
                                 title="Amount of the item specified to beat the game."
                                 default="1"
                                 placeholder="1"/>
+                        <span id="win_condition_info_icon" class="hidden" style="cursor: help; color: var(--donk-green);" data-toggle="tooltip" data-placement="right" data-html="true" title="">
+                            <i class="fa fa-info-circle"></i>
+                        </span>
                     </div>
                     <div class="form-check form-switch item-switch" style="padding-left: 0;">
                         <label data-toggle="tooltip"