Merge branch 'dev' into bump-py-and-such

Author: GreenestBeen

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = True
 tag = False
-current_version = 5.7.39
+current_version = 5.7.50
 
 [bumpversion:file:version.py]
 search = version = "{current_version}"

__init__.py

@@ -1,6 +1,6 @@
 {
-    "minimum_ap_version": "0.6.5", 
-    "world_version": "1.4.16",
+    "minimum_ap_version": "0.6.4", 
+    "world_version": "1.4.19",
     "authors": ["2dos", "AlmostSeagull", "Ballaam", "Green Bean", "Killklli", "Lrauq", "PoryGone", "Umed"],
     "version": 7,
     "compatible_version": 7,

archipelago.json

@@ -56,7 +56,7 @@
 from randomizer.Enums.SwitchTypes import SwitchType
 from randomizer.Enums.Switches import Switches
 from randomizer.Lists.Switches import SwitchInfo
-from archipelago.Options import Goal, SwitchSanity, SelectStartingKong
+from archipelago.Options import Goal, SwitchSanity, SelectStartingKong, GalleonWaterLevel
 from archipelago.Goals import GOAL_MAPPING, QUANTITY_GOALS, calculate_quantity
 from archipelago.Logic import logic_item_name_to_id
 
@@ -128,7 +128,6 @@ def get_default_settings() -> dict:
         "filler_items_selected": [ItemRandoFiller.junkitem],
         "free_trade_setting": True,
         "fungi_time": FungiTimeSetting.dusk,
-        "galleon_water": GalleonWaterSetting.raised,
         "generate_spoilerlog": True,
         "hard_bosses_selected": [],
         "hard_mode_selected": [],
@@ -189,12 +188,11 @@ def get_default_settings() -> dict:
         "kong_model_tiny": KongModels.default,
         "krool_access": False,
         "krool_in_boss_pool": False,
-        "krool_key_count": 8,
+        "krool_key_count": 0,
         "krool_phase_count": 3,
         "krool_phase_order_rando": True,
         "krool_random": False,
         "less_fragile_boulders": True,
-        "level_randomization": LevelRandomization.level_order_complex,
         "logic_type": LogicType.glitchless,
         "maximize_helm_blocker": True,
         "medal_cb_req": 40,
@@ -317,6 +315,7 @@ def apply_archipelago_settings(settings_dict: dict, options, multiworld) -> None
     settings_dict["krool_in_boss_pool"] = options.krool_in_boss_pool.value
     settings_dict["helm_phase_count"] = options.helm_phase_count.value
     settings_dict["krool_phase_count"] = options.krool_phase_count.value
+    settings_dict["level_randomization"] = LevelRandomization.loadingzone if options.loading_zone_rando.value else LevelRandomization.level_order_complex
 
     # Medal distribution settings
     if options.medal_distribution.value == 0:  # pre_selected
@@ -337,6 +336,12 @@ def apply_archipelago_settings(settings_dict: dict, options, multiworld) -> None
     if options.enable_cutscenes.value:
         settings_dict["more_cutscene_skips"] = ExtraCutsceneSkips.press
     settings_dict["alt_minecart_mayhem"] = options.alternate_minecart_mayhem.value
+    if options.galleon_water_level == GalleonWaterLevel.option_lowered:
+        settings_dict["galleon_water"] = GalleonWaterSetting.lowered
+    elif options.galleon_water_level == GalleonWaterLevel.option_raised:
+        settings_dict["galleon_water"] = GalleonWaterSetting.raised
+    else:
+        settings_dict["galleon_water"] = GalleonWaterSetting.vanilla
 
 
 def apply_blocker_settings(settings_dict: dict, options) -> None:
@@ -437,7 +442,8 @@ def apply_hard_mode_settings(settings_dict: dict, options) -> None:
 def apply_kong_settings(settings_dict: dict, options) -> None:
     """Apply Kong settings."""
     # Key settings
-    settings_dict["krool_key_count"] = options.krool_key_count.value
+    settings_dict["krool_key_count"] = options.pregiven_keys.value
+    settings_dict["win_condition_spawns_ship"] = 1 if options.require_beating_krool.value else 0
 
     # Kong mapping
     kong_mapping = {
@@ -679,6 +685,13 @@ def apply_goal_settings(settings_dict: dict, options, random_obj) -> None:
     """Apply goal and win condition settings."""
     settings_dict["win_condition_item"] = GOAL_MAPPING[options.goal]
 
+    # Krool's Challenge always requires beating K. Rool otherwise wheres the challenge
+    if options.goal == Goal.option_krools_challenge:
+        settings_dict["win_condition_spawns_ship"] = True
+    # The rabbit is too powerful to allow this
+    elif options.goal == Goal.option_kill_the_rabbit:
+        settings_dict["win_condition_spawns_ship"] = False
+
     if options.goal in QUANTITY_GOALS.keys():
         goal_name = QUANTITY_GOALS[options.goal]
         settings_dict["win_condition_count"] = calculate_quantity(goal_name, options.goal_quantity.value, random_obj)
@@ -733,6 +746,66 @@ def apply_minigame_settings(settings_dict: dict, options, multiworld) -> None:
     settings_dict["bonus_barrel_auto_complete"] = options.auto_complete_bonus_barrels.value and options.goal.value != Goal.option_bonuses
     settings_dict["helm_room_bonus_count"] = HelmBonuses(options.helm_room_bonus_count.value)
 
+    # Map crown door and coin door settings
+    crown_door_mapping = {
+        0: HelmDoorItem.vanilla,
+        1: HelmDoorItem.opened,
+        2: HelmDoorItem.medium_random,
+        3: HelmDoorItem.req_gb,
+        4: HelmDoorItem.req_bp,
+        5: HelmDoorItem.req_companycoins,
+        6: HelmDoorItem.req_key,
+        7: HelmDoorItem.req_medal,
+        8: HelmDoorItem.req_crown,
+        9: HelmDoorItem.req_fairy,
+        10: HelmDoorItem.req_rainbowcoin,
+        11: HelmDoorItem.req_bean,
+        12: HelmDoorItem.req_pearl,
+        13: HelmDoorItem.easy_random,
+        14: HelmDoorItem.hard_random,
+    }
+
+    coin_door_mapping = {
+        0: HelmDoorItem.vanilla,
+        1: HelmDoorItem.opened,
+        2: HelmDoorItem.medium_random,
+        3: HelmDoorItem.req_gb,
+        4: HelmDoorItem.req_bp,
+        6: HelmDoorItem.req_key,
+        7: HelmDoorItem.req_medal,
+        8: HelmDoorItem.req_crown,
+        9: HelmDoorItem.req_fairy,
+        10: HelmDoorItem.req_rainbowcoin,
+        11: HelmDoorItem.req_bean,
+        12: HelmDoorItem.req_pearl,
+        13: HelmDoorItem.easy_random,
+        14: HelmDoorItem.hard_random,
+    }
+
+    # Map door item type to the key name in helm_door_item_count dict
+    door_item_to_key = {
+        3: "golden_bananas",  # req_gb
+        4: "blueprints",  # req_bp
+        5: "company_coins",  # req_companycoins
+        6: "keys",  # req_key
+        7: "medals",  # req_medal
+        8: "crowns",  # req_crown
+        9: "fairies",  # req_fairy
+        10: "rainbow_coins",  # req_rainbowcoin
+        11: "bean",  # req_bean
+        12: "pearls",  # req_pearl
+    }
+
+    settings_dict["crown_door_item"] = crown_door_mapping.get(options.crown_door_item.value, HelmDoorItem.opened)
+    # Get count from dict based on selected item, default to 1 if not found
+    crown_item_key = door_item_to_key.get(options.crown_door_item.value)
+    settings_dict["crown_door_item_count"] = options.helm_door_item_count.value.get(crown_item_key, 1) if crown_item_key else 1
+
+    settings_dict["coin_door_item"] = coin_door_mapping.get(options.coin_door_item.value, HelmDoorItem.opened)
+    # Get count from dict based on selected item, default to 1 if not found
+    coin_item_key = door_item_to_key.get(options.coin_door_item.value)
+    settings_dict["coin_door_item_count"] = options.helm_door_item_count.value.get(coin_item_key, 1) if coin_item_key else 1
+
     if hasattr(multiworld, "generation_is_fake"):
         if hasattr(multiworld, "re_gen_passthrough"):
             if "Donkey Kong 64" in multiworld.re_gen_passthrough:
@@ -751,10 +824,8 @@ def handle_fake_generation_settings(settings: Settings, multiworld) -> None:
 
                 # Switch logic lifted out of level shuffle due to static levels for UT
                 if settings.alter_switch_allocation:
-                    allocation = [1, 1, 1, 1, 2, 2, 3, 3]
                     for x in range(8):
-                        level = settings.level_order[x + 1]
-                        settings.switch_allocation[level] = allocation[x]
+                        settings.switch_allocation[x] = passthrough["SlamLevels"][x]
 
                 settings.starting_kong_list = passthrough["StartingKongs"]
                 settings.starting_kong = settings.starting_kong_list[0]  # fake a starting kong so that we don't force a different kong

archipelago/FillSettings.py

@@ -9,7 +9,7 @@
 
 # Goal mapping for wincon determination
 GOAL_MAPPING = {
-    Goal.option_beat_k_rool: WinConditionComplex.beat_krool,
+    Goal.option_acquire_keys_3_and_8: WinConditionComplex.get_keys_3_and_8,
     Goal.option_acquire_key_8: WinConditionComplex.get_key8,
     Goal.option_kremling_kapture: WinConditionComplex.krem_kapture,
     Goal.option_dk_rap: WinConditionComplex.dk_rap_items,
@@ -70,6 +70,7 @@ def pp_wincon(win_condition_item, wc_count=0):
     win_con_name_table = {
         WinConditionComplex.beat_krool: "Beat K. Rool",
         WinConditionComplex.get_key8: "Acquire Key 8",
+        WinConditionComplex.get_keys_3_and_8: "Acquire Keys 3 and 8",
         WinConditionComplex.krem_kapture: "Kremling Kapture",
         WinConditionComplex.dk_rap_items: "Complete the Rap",
         WinConditionComplex.req_bean: "Acquire the Bean",

archipelago/Goals.py

@@ -5,6 +5,9 @@
 from randomizer.Enums.Maps import Maps
 from randomizer.Enums.Kongs import Kongs
 from randomizer.Enums.Levels import Levels
+from randomizer.Enums.Transitions import Transitions
+from randomizer.Enums.Types import BarrierItems
+from randomizer.Lists.ShufflableExit import ShufflableExits
 from randomizer.Lists.WrinklyHints import UpdateHint
 
 boss_names = {
@@ -139,6 +142,21 @@ def CompileArchipelagoHints(world, hint_data: list):
     hint_location_pairs.append((krool_hint, None))  # K. Rool hints don't have a specific location
     hints_remaining -= 1
 
+    # Isles to Helm transition hint (only if loading zone rando is enabled and Helm is shuffled)
+    if world.options.loading_zone_rando != 0 and world.options.shuffle_helm_level_order:
+        isles_to_helm_hint = parseIslesToHelmHint(world)
+        compiled_hints.append(isles_to_helm_hint)
+        hint_location_pairs.append((isles_to_helm_hint, None))  # Transition hints don't have a specific location
+        hints_remaining -= 1
+
+    # Helm Door hints (only if one or both doors were set to random)
+    if world.options.crown_door_item.value in [13, 2, 14] or world.options.coin_door_item.value in [13, 2, 14]:
+        helm_door_hints = parseHelmDoorHint(world)
+        for helm_door_hint in helm_door_hints:
+            compiled_hints.append(helm_door_hint)
+            hint_location_pairs.append((helm_door_hint, None))  # Helm door hints don't have a specific location
+            hints_remaining -= 1
+
     # Kong hints
     for kong_loc in kong_locations:
         kong_hint = parseKongHint(world, kong_loc)
@@ -194,7 +212,6 @@ def CompileArchipelagoHints(world, hint_data: list):
     # Sanity check that 35 hints were placed
     if hints_remaining > 0:
         # This part of the code should not be reached.
-        print("Not enough hints. Please wait. stage_generate_output might be crashing.")
         while hints_remaining > 0:
             filler_hint = "no hint, sorry...".upper()
             compiled_hints.append(filler_hint)
@@ -319,3 +336,90 @@ def parseKRoolHint(world):
         if letter not in "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.,!?:;'S-()% \x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d":
             text = text.replace(letter, " ")
     return text
+
+
+def parseIslesToHelmHint(world):
+    """Write a hint for finding the transition that leads to Hideout Helm."""
+    text = ""
+    # Check if entrance randomization is enabled
+    if hasattr(world.spoiler, "shuffled_exit_data") and world.spoiler.shuffled_exit_data:
+        # Find which transition leads to Hideout Helm
+        source_transition = None
+        for transition, shuffled_back in world.spoiler.shuffled_exit_data.items():
+            # Check if this transition's destination is Hideout Helm
+            if shuffled_back.reverse == Transitions.HelmToIsles:
+                source_transition = transition
+                break
+
+        if source_transition and source_transition in ShufflableExits:
+            pathToHint = source_transition
+            # Don't hint entrances from connector rooms, follow the reverse pathway back until finding a non-connector
+            while ShufflableExits[pathToHint].category is None:
+                originPaths = [x for x, back in world.spoiler.shuffled_exit_data.items() if back.reverse == pathToHint]
+                # In a few cases, there is no reverse loading zone. In this case we must keep the original path to hint
+                if len(originPaths) == 0:
+                    break
+                pathToHint = originPaths[0]
+
+            source_name = ShufflableExits[pathToHint].name
+            text = f"Looking for \x04Hideout Helm\x04? Try going from \x08{source_name}\x08.".upper()
+
+    for letter in text:
+        if letter not in "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.,!?:;'S-()% \x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d":
+            text = text.replace(letter, " ")
+    return text
+
+
+def parseHelmDoorHint(world):
+    """Write hints for the Helm door requirements if they're randomized."""
+    # Map BarrierItems to display names (singular)
+    item_names_singular = {
+        BarrierItems.GoldenBanana: "Golden Banana",
+        BarrierItems.Blueprint: "Blueprint",
+        BarrierItems.CompanyCoin: "Special Coin",
+        BarrierItems.Key: "Key",
+        BarrierItems.Medal: "Medal",
+        BarrierItems.Crown: "Crown",
+        BarrierItems.Fairy: "Fairy",
+        BarrierItems.RainbowCoin: "Rainbow Coin",
+        BarrierItems.Bean: "Bean",
+        BarrierItems.Pearl: "Pearl",
+    }
+
+    crown_door_item = world.spoiler.settings.crown_door_item
+    crown_door_count = world.spoiler.settings.crown_door_item_count
+    coin_door_item = world.spoiler.settings.coin_door_item
+    coin_door_count = world.spoiler.settings.coin_door_item_count
+
+    crown_door_randomized = world.options.crown_door_item.value in [13, 2, 14]  # easy, medium, hard random
+    coin_door_randomized = world.options.coin_door_item.value in [13, 2, 14]
+
+    hints = []
+
+    if crown_door_randomized:
+        crown_name = item_names_singular.get(crown_door_item, "item")
+        if crown_door_count > 1:
+            if crown_door_item == BarrierItems.Fairy:
+                crown_name = "Fairies"
+            else:
+                crown_name = crown_name + "s"
+        text = f"There lies a \x05gate in Hideout Helm\x05 that requires \x04{crown_door_count} {crown_name}\x04.".upper()
+        for letter in text:
+            if letter not in "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.,!?:;'S-()% \x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d":
+                text = text.replace(letter, " ")
+        hints.append(text)
+
+    if coin_door_randomized:
+        coin_name = item_names_singular.get(coin_door_item, "item")
+        if coin_door_count > 1:
+            if coin_door_item == BarrierItems.Fairy:
+                coin_name = "Fairies"
+            else:
+                coin_name = coin_name + "s"
+        coin_text = f"There lies a \x05gate in Hideout Helm\x05 that requires \x04{coin_door_count} {coin_name}\x04.".upper()
+        for letter in coin_text:
+            if letter not in "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.,!?:;'S-()% \x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d":
+                coin_text = coin_text.replace(letter, " ")
+        hints.append(coin_text)
+
+    return hints