Merge pull request #2942 from UmedMuzl/ship-spawning-method

Win Condition Gates Krool Ship

Author: UmedMuzl

archipelago.json

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

archipelago/FillSettings.py

@@ -189,7 +189,7 @@ 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,
@@ -437,7 +437,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 +680,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)

archipelago/Goals.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/Logic.py

@@ -1448,7 +1448,75 @@ def AnyKongCanBuy(self, location, buy_empty=True):
         return AnyKongCanBuy(self.spoiler, location, self, buy_empty)
 
     def CanAccessKRool(self):
-        """Make sure that each required key has been turned in."""
+        """Make sure that each required key has been turned in, or if ship spawn method is win condition-based, check if win condition items are obtained."""
+        # If using win condition-based ship spawning, check if win condition item requirements are met
+        if self.settings.win_condition_spawns_ship:
+            condition = self.settings.win_condition_item
+            if condition == WinConditionComplex.krem_kapture:
+                for subject in self.spoiler.valid_photo_items:
+                    if subject in (
+                        Items.PhotoKasplatDK,
+                        Items.PhotoKasplatDiddy,
+                        Items.PhotoKasplatLanky,
+                        Items.PhotoKasplatTiny,
+                        Items.PhotoKasplatChunky,
+                    ):
+                        continue
+                    if self.Photos.get(subject, 0) == 0:
+                        return False
+                return self.camera
+            elif condition == WinConditionComplex.get_key8:
+                return self.HelmKey
+            elif condition == WinConditionComplex.dk_rap_items:
+                dk_rap_items = [
+                    self.donkey,
+                    self.diddy,
+                    self.lanky,
+                    self.tiny,
+                    self.chunky,
+                    self.coconut,
+                    self.peanut,
+                    self.grape,
+                    self.pineapple,
+                    self.guitar,
+                    self.trombone,
+                    self.strongKong,
+                    self.jetpack,
+                    self.handstand,
+                    self.balloon,
+                    self.mini,
+                    self.twirl,
+                    self.barrels,
+                    self.oranges,
+                    self.climbing,
+                    self.crankyAccess,
+                ]
+                return all(dk_rap_items)
+            elif condition == WinConditionComplex.kill_the_rabbit:
+                return Events.KilledRabbit in self.Events
+            elif condition == WinConditionComplex.req_bonuses:
+                return self.bonuses_beaten >= self.settings.win_condition_count
+            elif condition == WinConditionComplex.req_bosses:
+                return self.bosses_beaten >= self.settings.win_condition_count
+            else:
+                # Item-based win conditions
+                win_con_table = {
+                    WinConditionComplex.req_bean: BarrierItems.Bean,
+                    WinConditionComplex.req_bp: BarrierItems.Blueprint,
+                    WinConditionComplex.req_companycoins: BarrierItems.CompanyCoin,
+                    WinConditionComplex.req_crown: BarrierItems.Crown,
+                    WinConditionComplex.req_fairy: BarrierItems.Fairy,
+                    WinConditionComplex.req_key: BarrierItems.Key,
+                    WinConditionComplex.req_gb: BarrierItems.GoldenBanana,
+                    WinConditionComplex.req_medal: BarrierItems.Medal,
+                    WinConditionComplex.req_pearl: BarrierItems.Pearl,
+                    WinConditionComplex.req_rainbowcoin: BarrierItems.RainbowCoin,
+                }
+                if condition in win_con_table:
+                    return self.ItemCheck(win_con_table[condition], self.settings.win_condition_count)
+                return True
+
+        # Otherwise use key-based access
         required_base_keys = [
             Events.JapesKeyTurnedIn,
             Events.AztecKeyTurnedIn,
@@ -1662,10 +1730,14 @@ def IsLevelEnterable(self, level):
 
     def WinConditionMet(self):
         """Check if the current game state has met the win condition."""
+        condition = self.settings.win_condition_item
+        # When using win condition-based ship spawning, always require K. Rool defeat in addition to win condition items
+        krool_complete = not self.settings.win_condition_spawns_ship or Events.KRoolDefeated in self.Events
+
         # Special Win Cons
-        if self.settings.win_condition_item == WinConditionComplex.beat_krool:
+        if condition == WinConditionComplex.beat_krool:
             return Events.KRoolDefeated in self.Events
-        elif self.settings.win_condition_item == WinConditionComplex.krem_kapture:
+        elif condition == WinConditionComplex.krem_kapture:
             for subject in self.spoiler.valid_photo_items:
                 if subject in (
                     Items.PhotoKasplatDK,
@@ -1676,11 +1748,17 @@ def WinConditionMet(self):
                 ):
                     continue
                 if self.Photos.get(subject, 0) == 0:
+                    # print(f"Could not reach {subject.name}")
                     return False
-            return self.camera
-        elif self.settings.win_condition_item == WinConditionComplex.get_key8:
-            return self.HelmKey
-        elif self.settings.win_condition_item == WinConditionComplex.dk_rap_items:
+            result = self.camera
+            return result and krool_complete
+        elif condition == WinConditionComplex.get_key8:
+            result = self.HelmKey
+            return result and krool_complete
+        elif condition == WinConditionComplex.get_keys_3_and_8:
+            result = self.FactoryKey and self.HelmKey
+            return result and krool_complete
+        elif condition == WinConditionComplex.dk_rap_items:
             dk_rap_items = [
                 self.donkey,
                 self.diddy,
@@ -1711,16 +1789,20 @@ def WinConditionMet(self):
             for k in dk_rap_items:
                 if not k:
                     return False
-            return True
-        elif self.settings.win_condition_item == WinConditionComplex.krools_challenge:
+            result = True
+            return result and krool_complete
+        elif condition == WinConditionComplex.krools_challenge:
             # Krool's Challenge: Beat K. Rool + collect all Keys, Blueprints, Bosses, and Bonus Barrels
             return Events.KRoolDefeated in self.Events and self.ItemCheck(BarrierItems.Key, 8) and self.ItemCheck(BarrierItems.Blueprint, 40) and self.bosses_beaten >= 7 and self.bonuses_beaten >= 43
-        elif self.settings.win_condition_item == WinConditionComplex.kill_the_rabbit:
-            return Events.KilledRabbit in self.Events
-        elif self.settings.win_condition_item == WinConditionComplex.req_bosses:
-            return self.bosses_beaten >= self.settings.win_condition_count
-        elif self.settings.win_condition_item == WinConditionComplex.req_bonuses:
-            return self.bonuses_beaten >= self.settings.win_condition_count
+        elif condition == WinConditionComplex.kill_the_rabbit:
+            result = Events.KilledRabbit in self.Events
+            return result and krool_complete
+        elif condition == WinConditionComplex.req_bonuses:
+            result = self.bonuses_beaten >= self.settings.win_condition_count
+            return result and krool_complete
+        elif condition == WinConditionComplex.req_bosses:
+            result = self.bosses_beaten >= self.settings.win_condition_count
+            return result and krool_complete
         # Get X amount of Y item win cons
         win_con_table = {
             WinConditionComplex.req_bean: BarrierItems.Bean,
@@ -1734,9 +1816,10 @@ def WinConditionMet(self):
             WinConditionComplex.req_pearl: BarrierItems.Pearl,
             WinConditionComplex.req_rainbowcoin: BarrierItems.RainbowCoin,
         }
-        if self.settings.win_condition_item not in win_con_table:
+        if condition not in win_con_table:
             raise Exception(f"Invalid Win Condition {self.settings.win_condition_item.name}")
-        return self.ItemCheck(win_con_table[self.settings.win_condition_item], self.settings.win_condition_count)
+        result = self.ItemCheck(win_con_table[condition], self.settings.win_condition_count)
+        return result and krool_complete
 
     def CanGetRarewareCoin(self):
         """Check if you meet the logical requirements to obtain the Rareware Coin."""

archipelago/Options.py

@@ -43,7 +43,7 @@ class Goal(Choice):
     """
 
     display_name = "Goal"
-    option_beat_k_rool = 0
+    option_acquire_keys_3_and_8 = 0
     option_acquire_key_8 = 1
     option_kremling_kapture = 2
     option_dk_rap = 3
@@ -62,7 +62,7 @@ class Goal(Choice):
     option_treasure_hurry = 16
     option_krools_challenge = 17
     option_kill_the_rabbit = 18
-    default = 0
+    default = 7
 
 
 class GoalQuantity(OptionDict):
@@ -362,16 +362,26 @@ class MermaidRequirement(Range):
 
 
 class KeysRequiredToBeatKrool(Range):
-    """Determines how many keys are needed to spawn Krool's Ship.
+    """Determines how many keys are pregiven.
 
-    Choosing a value of 0 means you start with all 8 keys.
-    Choosing a value of 8 means you start with no keys.
+    Choosing a value of 0 means you start with 0 keys.
+    Choosing a value of 8 means you start with all 8 keys.
     """
 
-    display_name = "Keys Required to Beat Krool"
+    display_name = "Amount of Pregiven Keys"
     range_start = 0
     range_end = 8
-    default = 8
+    default = 0
+
+
+class RequireBeatingKrool(DefaultOnToggle):
+    """Require defeating K. Rool in addition to the win condition requirements.
+
+    K. Rool's ship will not spawn until you meet your win condition requirements, and you must defeat K. Rool to win.
+    Automatically enabled for Krool's Challenge. Automatically disabled for Kill the Rabbit.
+    """
+
+    display_name = "Require Beating K. Rool"
 
 
 class SwitchSanity(Choice):
@@ -1173,7 +1183,8 @@ class DK64Options(PerGameCommonOptions):
     tag_link: TagLink
     trap_link: TrapLink
     goal: Goal
-    krool_key_count: KeysRequiredToBeatKrool
+    pregiven_keys: KeysRequiredToBeatKrool
+    require_beating_krool: RequireBeatingKrool
     helm_key_lock: HelmKeyLock
     shuffle_helm_level_order: ShuffleHelmLevel
     krool_phase_count: KroolPhaseCount
@@ -1264,6 +1275,7 @@ class DK64Options(PerGameCommonOptions):
         "Victory Conditions",
         [
             Goal,
+            RequireBeatingKrool,
             GoalQuantity,
             KeysRequiredToBeatKrool,
             HelmPhaseCount,

base-hack/include/common_enums.h

@@ -314,6 +314,7 @@ typedef enum win_conditions {
 	/* 0x004 */ GOAL_DKRAP,
 	/* 0x005 */ GOAL_KROOLS_CHALLENGE,
 	/* 0x006 */ GOAL_KILL_THE_RABBIT,
+	/* 0x007 */ GOAL_KEYS_3_AND_8,
 } win_conditions;
 
 typedef enum master_types_list {

base-hack/include/global.h

@@ -237,6 +237,7 @@ extern void checkVictory_flaghook(int flag);
 extern void winRabbitSeed(int song, float volume);
 extern void safeguardRabbitReward(void);
 extern int canAccessKroolsChallenge(void);
+extern int canAccessWinCondition(void);
 extern void FileProgressInitSub(int file, int shuffle);
 extern void handleFileSelectSprites(void* paad, void* sprite, int x, int y, float scale, int unk0, int control);
 extern void checkSkippableCutscene(void);

base-hack/include/variable_space_structs.h

@@ -131,7 +131,7 @@ typedef struct varspace {
 	/* 0x1B0 */ int password;
 	/* 0x1B4 */ char song_speed_near_win;
 	/* 0x1B5 */ unsigned char pppanic_fairy_model; // 0 = Vanilla
-	/* 0x1B6 */ unsigned char krool_ship_spawn_method; // 0 = Key Bases, 1 = Collectible Based
+	/* 0x1B6 */ unsigned char win_condition_spawns_ship; // 0 = Key Bases, 1 = Collectible Based
 	/* 0x1B7 */ DisabledMusicStruct disabled_music;
 	/* 0x1B8 */ unsigned char kong_models[5];
 	/* 0x1BD */ char unk_1bd[0x1C6 - 0x1BD];

base-hack/src/instances/instances.c

@@ -495,9 +495,9 @@ int change_object_scripts(behaviour_data* behaviour_pointer, int id, int index,
 					}
 				} else if (param2 == K_ROOL_SHIP) {
 					// Check access requirements based on ship spawn method
-					if (Rando.krool_ship_spawn_method == 1) {
-						// Collectible-based access
-						if (!canAccessKroolsChallenge()) {
+					if (Rando.win_condition_spawns_ship == 1) {
+						// Win condition-based access
+						if (!canAccessWinCondition()) {
 							return 0;
 						}
 					} else {