Feature: Add alternative way to take on Kefka's Tower - "The KT Gauntlet"

args/bosses.py

@@ -1,3 +1,8 @@
+from data.bosses import BossLocations
+
+
+DEFAULT_DRAGON_PROTOCOL = BossLocations.SHUFFLE
+DEFAULT_STATUE_PROTOCOL = BossLocations.MIX
 def name():
     return "Bosses"
 
@@ -9,8 +14,17 @@ def parse(parser):
                         help = "Boss battles shuffled")
     bosses_battles.add_argument("-bbr", "--boss-battles-random", action = "store_true",
                         help = "Boss battles randomized")
-    bosses.add_argument("-bmbd", "--mix-bosses-dragons", action = "store_true",
+
+    dragons = bosses.add_mutually_exclusive_group()
+    dragons.add_argument("-drloc", "--dragon-boss-location", default = DEFAULT_DRAGON_PROTOCOL, type = str.lower, choices = BossLocations.ALL,
+                        help = "Decides which locations the eight dragon encounters can be fought")
+    dragons.add_argument("-bmbd", "--mix-bosses-dragons", action = "store_true",
                         help = "Shuffle/randomize bosses and dragons together")
+
+    statues = bosses.add_mutually_exclusive_group()
+    statues.add_argument("-stloc", "--statue-boss-location", default = DEFAULT_STATUE_PROTOCOL, type = str.lower, choices = BossLocations.ALL,
+                        help = "Decides which locations the three statue encounters can be fought")
+
     bosses.add_argument("-srp3", "--shuffle-random-phunbaba3", action = "store_true",
                         help = "Apply Shuffle/Random to Phunbaba 3 (otherwise he will only appear in Mobliz WOR)")
     bosses.add_argument("-bnds", "--boss-normalize-distort-stats", action = "store_true",
@@ -21,7 +35,15 @@ def parse(parser):
                         help = "Undead status removed from bosses")
 
 def process(args):
-    pass
+    if args.mix_bosses_dragons:
+        args.dragon_boss_location = BossLocations.MIX
+        args.mix_bosses_dragons = None
+    # if neither shuffling or randomizing bosses, and we try to mix the dragons/statues, simply shuffle them instead
+    vanilla_locations = not (args.boss_battles_shuffle or args.boss_battles_random)
+    if vanilla_locations and args.dragon_boss_location == BossLocations.MIX:
+        args.dragon_boss_location = BossLocations.SHUFFLE
+    if vanilla_locations and args.statue_boss_location == BossLocations.MIX:
+        args.statue_boss_location = BossLocations.SHUFFLE
 
 def flags(args):
     flags = ""
@@ -31,8 +53,14 @@ def flags(args):
     elif args.boss_battles_random:
         flags += " -bbr"
 
-    if args.mix_bosses_dragons:
-        flags += " -bmbd"
+    if args.dragon_boss_location:
+        flags += f" -drloc {args.dragon_boss_location}"
+    elif args.mix_bosses_dragons:
+        flags += f" -drloc {BossLocations.MIX}"
+
+    if args.statue_boss_location:
+        flags += f" -stloc {args.statue_boss_location}"
+
     if args.shuffle_random_phunbaba3:
         flags += " -srp3"
     if args.boss_normalize_distort_stats:
@@ -51,9 +79,18 @@ def options(args):
     elif args.boss_battles_random:
         boss_battles = "Random"
 
+    dragon_battles = DEFAULT_DRAGON_PROTOCOL
+    if args.dragon_boss_location:
+        dragon_battles = args.dragon_boss_location.capitalize()
+
+    statue_battles = DEFAULT_DRAGON_PROTOCOL
+    if args.statue_boss_location:
+        statue_battles = args.statue_boss_location.capitalize()
+
     return [
         ("Boss Battles", boss_battles),
-        ("Mix Bosses & Dragons", args.mix_bosses_dragons),
+        ("Dragons", dragon_battles),
+        ("Statues", statue_battles),
         ("Shuffle/Random Phunbaba 3", args.shuffle_random_phunbaba3),
         ("Normalize & Distort Stats", args.boss_normalize_distort_stats),
         ("Boss Experience", args.boss_experience),

constants/maps.py

@@ -0,0 +1,12 @@
+
+
+id_name = {
+    0x123   : "Guardian Room",       # 291
+    0x14e   : "Poltergeist Room",    # 334
+    0x162   : "Goddess Room",        # 354
+    0x163   : "Doom Room",           # 355
+    0x19a   : "Inferno Room",        # 410
+    0x19b   : "KT Final Switch Room" # 411
+}
+
+name_id = {v: k for k, v in id_name.items()}

constants/objectives/condition_bits.py

@@ -68,6 +68,14 @@
     NameBit("Zozo Tower", event_bit.GOT_ZOZO_REWARD),
 ]
 
+check_bit += [                                                          # Index
+    NameBit("Kefka's Tower Ambush", event_bit.DEFEATED_INFERNO),        # 59
+    NameBit("Kefka's Tower Guardian", event_bit.DEFEATED_GUARDIAN),     # 60
+    NameBit("KT Left Triad Statue", event_bit.DEFEATED_DOOM),           # 61
+    NameBit("KT Mid Triad Statue", event_bit.DEFEATED_POLTERGEIST),      # 62
+    NameBit("KT Right Triad Statue", event_bit.DEFEATED_GODDESS),       # 63
+]
+
 quest_bit = [
     NameBit("Defeat Sealed Cave Ninja", event_bit.DEFEATED_NINJA_CAVE_TO_SEALED_GATE),
     NameBit("Help Injured Lad", event_bit.HELPED_INJURED_LAD),
@@ -79,6 +87,7 @@
     NameBit("Suplex A Train", event_bit.SUPLEXED_TRAIN),
     NameBit("Win An Auction", event_bit.WON_AN_AUCTION),
     NameBit("Win A Coliseum Match", event_bit.WON_A_COLISEUM_MATCH),
+    NameBit("Complete the KT Gauntlet", event_bit.COMPLETED_KT_GAUNTLET)
 ]
 
 boss_bit = []

constants/objectives/results.py

@@ -85,6 +85,9 @@
     ],
 }
 
+category_types["Kefka's Tower"] += [ResultType(90, "Unlock KT Gauntlet", "Unlock KT Gauntlet", None)]
+
+
 categories = list(category_types.keys())
 
 id_type = {}

constants/songs.py

@@ -0,0 +1,5 @@
+id_name = {
+    0x33   : "FierceBattle",     # "Battle to the Death" - Atma/Statue battle theme
+}
+
+name_id = {v: k for k, v in id_name.items()}

constants/sound_effects.py

@@ -0,0 +1,11 @@
+
+
+id_name = {
+    0x9a   : "Ground Breaking",     # 154
+    0xa6   : "Chest/Switch",        # 166
+    0xa9   : "Umaro Body Slam",     # 169
+    0xb5   : "Landing On Floor",    # 181
+    0xba   : "Falling",             # 186
+}
+
+name_id = {v: k for k, v in id_name.items()}

data/bosses.py

@@ -92,6 +92,25 @@
     396 : "Guardian", # defeatable guardian in kefka's tower
     401 : "MagiMaster",
 }
+
+#  These ids are repeated in normal_pack_name as well
+#  This is intentional as they are used to iterate over ALL bosses for things like objective conditions
+statue_pack_name = {
+    354 : "Doom",
+    355 : "Goddess",
+    356 : "Poltrgeist",
+}
+statue_formation_name = {
+    468 : "Doom",
+    469 : "Goddess",
+    470 : "Poltrgeist",
+}
+statue_enemy_name = {
+    295 : "Doom",
+    296 : "Goddess",
+    297 : "Poltrgeist",
+}
+
 normal_formation_name = {
     79  : "Rizopas",
     354 : "MagiMaster",
@@ -255,3 +274,10 @@
 enemy_name.update(removed_enemy_name)
 
 name_enemy = {v: k for k, v in enemy_name.items()}
+
+class BossLocations:
+    MIX = "mix"
+    ORIGINAL = "original"
+    SHUFFLE = "shuffle"
+
+    ALL = [MIX, ORIGINAL, SHUFFLE]

data/dialogs/dialogs.py

@@ -106,10 +106,10 @@ def read_multi_line_battle_dialogs(self):
             self.multi_line_battle_dialogs.append(dialog)
 
     def free(self):
-        import data.dialogs.free as free
+        from data.dialogs.free import multi_line_battle_dialogs
 
         self.free_multi_line_battle_dialogs = []
-        for dialog_id in free.multi_line_battle_dialogs:
+        for dialog_id in multi_line_battle_dialogs:
             self.multi_line_battle_dialogs[dialog_id].text = ""
             self.free_multi_line_battle_dialogs.append(dialog_id)
 
@@ -179,6 +179,12 @@ def objectives_mod(self):
             mlid = self.allocate_multi_line_battle(line1 + "<line>" + line2 + "<wait for key><end>")
             self.multi_line_battle_objectives.append(mlid)
 
+    def create_dialog(self, text):
+        from data.dialogs.free import dialogs
+        id = dialogs.pop()
+        self.set_text(id, text)
+        return id
+
     def mod(self):
         self.move_battle_messages()
         self.objectives_mod()

data/dialogs/free.py

@@ -1,3 +1,9 @@
+
+dialogs = []
+dialogs += range(515, 528)   # kefka assaulting thamasa
+dialogs += range(550, 598)   # sabin scenario, cyan kefka doma event
+dialogs +=range(1767, 1878)  # BANQUET
+
 multi_line_battle_dialogs = [
     0,  # WEDGE:<line>Hey! What's the matter?<wait for key><line>Do you know something we<line>don't……? ...
     1,  # GIRL:<line>……<wait for key><end>

data/enemy_formations.py

@@ -11,8 +11,10 @@ class EnemyFormations():
     ENEMIES_END = 0xf83bf
     ENEMIES_SIZE = 15
 
-    PHUNBABA3 = 422
-    DOOM_GAZE = 463
+    PHUNBABA3 = bosses.name_formation["Phunbaba 3"]
+    DOOM_GAZE = bosses.name_formation["Doom Gaze"]
+    ALL_STATUES = list(bosses.statue_formation_name)
+    ALL_DRAGONS = list(bosses.dragon_formation_name)
     PRESENTER = 433
     COLISEUM = 575