Merge pull request #10 from AtmaTek/1_1_0

1 1 0

Author: AtmaTek

args/arguments.py

@@ -4,7 +4,7 @@ def __init__(self):
         self.groups = [
             "settings",
             "objectives",
-            "starting_party", "characters", "swdtechs", "blitzes", "lores", "rages", "dances", "commands",
+            "starting_party", "characters", "swdtechs", "blitzes", "lores", "rages", "dances", "steal", "commands",  
             "xpmpgp", "scaling", "bosses", "encounters", "boss_ai",
             "espers", "natural_magic",
             "starting_gold_items", "items", "shops", "chests",

args/chests.py

@@ -10,6 +10,8 @@ def parse(parser):
                                  help = "Chest contents shuffled and given percent randomized")
     chests_contents.add_argument("-ccrt", "--chest-contents-random-tiered", action = "store_true",
                                  help = "Chest contents randomized by tier")
+    chests_contents.add_argument("-ccrs", "--chest-contents-random-scaled", action = "store_true",
+                                 help = "Chest contents randomized by tier. Probability of higher tiers begins low and increases as more chests are opened")
     chests_contents.add_argument("-cce", "--chest-contents-empty", action = "store_true",
                                  help = "Chest contents empty")
 
@@ -28,6 +30,8 @@ def flags(args):
         flags += f" -ccsr {args.chest_contents_shuffle_random_percent}"
     elif args.chest_contents_random_tiered:
         flags += " -ccrt"
+    elif args.chest_contents_random_scaled:
+        flags += " -ccrs"
     elif args.chest_contents_empty:
         flags += " -cce"
 
@@ -44,6 +48,8 @@ def options(args):
         contents_value = "Shuffle + Random"
     elif args.chest_contents_random_tiered:
         contents_value = "Random Tiered"
+    elif args.chest_contents_random_scaled:
+        contents_value = "Random Scaled"
     elif args.chest_contents_empty:
         contents_value = "Empty"
 

args/coliseum.py

@@ -2,7 +2,7 @@ def name():
     return "Coliseum"
 
 def parse(parser):
-    from data.items import Items
+    from constants.items import ITEM_COUNT
 
     coliseum = parser.add_argument_group("Coliseum")
 
@@ -19,7 +19,7 @@ def parse(parser):
                                    help = "Coliseum rewards randomized")
 
     coliseum.add_argument("-crvr", "--coliseum-rewards-visible-random", default = None, type = int,
-                          nargs = 2, metavar = ("MIN", "MAX"), choices = range(Items.ITEM_COUNT),
+                          nargs = 2, metavar = ("MIN", "MAX"), choices = range(ITEM_COUNT),
                           help = "Random number of rewards within given range visible before beginning the match. Remaining rewards will display as question marks")
     coliseum.add_argument("-crm", "--coliseum-rewards-menu", action = "store_true",
                           help = "Display rewards in item selection menu. Hidden rewards will display as question marks")

args/commands.py

@@ -12,6 +12,7 @@ def parse(parser):
     commands.add_argument("-rec3", "--random-exclude-command3", type = int, choices = RANDOM_EXCLUDE_COMMANDS, metavar = "VALUE", default = NONE_COMMAND, help = "Exclude selected command from random possibilities")
     commands.add_argument("-rec4", "--random-exclude-command4", type = int, choices = RANDOM_EXCLUDE_COMMANDS, metavar = "VALUE", default = NONE_COMMAND, help = "Exclude selected command from random possibilities")
     commands.add_argument("-rec5", "--random-exclude-command5", type = int, choices = RANDOM_EXCLUDE_COMMANDS, metavar = "VALUE", default = NONE_COMMAND, help = "Exclude selected command from random possibilities")
+    commands.add_argument("-rec6", "--random-exclude-command6", type = int, choices = RANDOM_EXCLUDE_COMMANDS, metavar = "VALUE", default = NONE_COMMAND, help = "Exclude selected command from random possibilities")
 
 def process(args):
     if not args.commands:
@@ -43,6 +44,8 @@ def process(args):
         args.random_exclude_commands.append(args.random_exclude_command4)
     if args.random_exclude_command5 != NONE_COMMAND:
         args.random_exclude_commands.append(args.random_exclude_command5)
+    if args.random_exclude_command6 != NONE_COMMAND:
+        args.random_exclude_commands.append(args.random_exclude_command6)
 
     random_exists = "Random" in args.command_strings or "Random Unique" in args.command_strings
     blitz_excluded = name_id["Blitz"] in args.random_exclude_commands
@@ -67,6 +70,8 @@ def flags(args):
         flags += f" -rec4 {args.random_exclude_command4}"
     if args.random_exclude_command5 != NONE_COMMAND:
         flags += f" -rec5 {args.random_exclude_command5}"
+    if args.random_exclude_command6 != NONE_COMMAND:
+        flags += f" -rec6 {args.random_exclude_command6}"
 
     return flags
 
@@ -89,6 +94,7 @@ def options(args):
     add_exclude_command(args.random_exclude_command3)
     add_exclude_command(args.random_exclude_command4)
     add_exclude_command(args.random_exclude_command5)
+    add_exclude_command(args.random_exclude_command6)
 
     return result
 

args/log.py

@@ -17,7 +17,7 @@ def _log_tab(tab_name, left_groups, right_groups):
 def log():
     _log_tab("Game", ["settings"], [])
     args.group_modules["objectives"].log(args)
-    _log_tab("Party", ["starting_party", "swdtechs", "blitzes", "lores", "rages", "dances"], ["characters", "commands"])
+    _log_tab("Party", ["starting_party", "swdtechs", "blitzes", "lores", "rages", "dances", "steal"], ["characters", "commands"])
     _log_tab("Battle", ["xpmpgp", "bosses", "boss_ai"], ["scaling", "encounters"])
     _log_tab("Magic", ["espers"], ["natural_magic"])
     _log_tab("Items", ["starting_gold_items", "items"], ["shops", "chests"])

args/misc.py

@@ -43,6 +43,12 @@ def parse(parser):
                        help = "Remove NPC")
     parser.y_npc_group = y_npc
 
+    remove_flashes = misc.add_mutually_exclusive_group()
+    remove_flashes.add_argument("-frw", "--flashes-remove-worst", action = "store_true",
+                              help = "Removes only the worst flashes from animations. Ex: Learning Bum Rush, Bum Rush, Quadra Slam/Slice, Flash, etc.")
+    remove_flashes.add_argument("-frm", "--flashes-remove-most", action = "store_true",
+                              help = "Removes most flashes from animations. Includes Kefka Death.")
+
 def process(args):
     args.y_npc = False # are any y_npc flags enabled?
 
@@ -92,6 +98,11 @@ def flags(args):
     elif args.y_npc_remove:
         flags += " -yremove"
 
+    if args.flashes_remove_worst:
+        flags += " -frw"
+    if args.flashes_remove_most:
+        flags += " -frm"
+
     return flags
 
 def options(args):
@@ -123,6 +134,12 @@ def options(args):
     elif args.y_npc_remove:
         y_npc = "Remove"
 
+    remove_flashes = "Original"
+    if args.flashes_remove_worst:
+        remove_flashes = "Worst"
+    elif args.flashes_remove_most:
+        remove_flashes = "Most"
+
     return [
         ("Auto Sprint", args.auto_sprint),
         ("Original Name Display", args.original_name_display),
@@ -131,6 +148,7 @@ def options(args):
         ("Scan All", args.scan_all),
         ("Event Timers", event_timers),
         ("Y NPC", y_npc),
+        ("Remove Flashes", remove_flashes)
     ]
 
 def menu(args):

args/objectives.py

@@ -8,10 +8,12 @@ def parse(parser):
 
 def process(args):
     from constants.objectives.results import types as result_types
+    from constants.objectives.results import id_type as result_id_type
     from constants.objectives.conditions import types as condition_types
 
     class Result:
-        def __init__(self, name, format_string, value_range, args):
+        def __init__(self, _id, name, format_string, value_range, args):
+            self.id = _id
             self.name = name
             self.format_string = format_string
             self.value_range = value_range
@@ -49,7 +51,7 @@ def __init__(self, letter, result, conditions, conditions_required_min, conditio
                     pass
             value_index = 0
 
-            result_type = result_types[values[value_index]]
+            result_type = result_id_type[values[value_index]]
             value_index += 1
 
             if result_type.value_range is not None:

args/steal.py

@@ -0,0 +1,48 @@
+def name():
+    return "Steal"
+
+def parse(parser):
+    steal = parser.add_argument_group("Steal")
+
+    steal_chances = steal.add_mutually_exclusive_group()
+    steal_chances.add_argument("-sch", "--steal-chances-higher", action = "store_true",
+                         help = "Steal Rate is improved and rare steals are more likely")
+    steal_chances.add_argument("-sca", "--steal-chances-always", action = "store_true",
+                         help = "Steal will always succeed if enemy has an item")
+
+def process(args):
+    pass
+
+def flags(args):
+    flags = ""
+
+    if args.steal_chances_higher:
+        flags += " -sch"
+    if args.steal_chances_always:
+        flags += " -sca"
+
+    return flags
+
+def options(args):
+    steal_chances = "Original"
+    if args.steal_chances_higher:
+        steal_chances = "Higher"
+    if args.steal_chances_always:
+        steal_chances = "Always"
+
+    return [
+        ("Chances", steal_chances),
+    ]
+
+def menu(args):
+    return (name(), options(args))
+
+def log(args):
+    from log import format_option
+    log = [name()]
+
+    entries = options(args)
+    for entry in entries:
+        log.append(format_option(*entry))
+
+    return log

battle/__init__.py

@@ -5,8 +5,10 @@
 import battle.suplex_train_check
 import battle.auto_status
 import battle.end_checks
+from battle.animations import Animations
 
 __all__ = ["Battle"]
 class Battle:
     def __init__(self):
         self.multipliers = Multipliers()
+        self.animations = Animations()

battle/animations.py

@@ -0,0 +1,67 @@
+from memory.space import Bank, Reserve, Read, Write
+import data.battle_animation_scripts as battle_animation_scripts
+import instruction.asm as asm
+import args
+
+class Animations:
+    def __init__(self):
+        self.health_animation_reflect_mod()
+
+        if args.flashes_remove_most:
+            flash_address_arrays = battle_animation_scripts.BATTLE_ANIMATION_FLASHES.values()
+            self.remove_battle_flashes_mod(flash_address_arrays)
+            self.remove_critical_flash()
+
+        if args.flashes_remove_worst:
+            flash_address_arrays = []
+            animation_names = ["Boss Death", "Ice 3", "Fire 3", "Bolt 3", "Schiller", "R.Polarity", "X-Zone",
+                               "Muddle", "Dispel", "Shock", "Bum Rush", "Quadra Slam", "Slash", "Flash", 
+                               "Step Mine", "Rippler", "WallChange", "Ultima", "ForceField"]
+            for name in animation_names:
+                flash_address_arrays.append(battle_animation_scripts.BATTLE_ANIMATION_FLASHES[name])
+            self.remove_battle_flashes_mod(flash_address_arrays)
+
+    def remove_critical_flash(self):
+        space = Reserve(0x23410, 0x23413, "Critical hit screen flash", asm.NOP())
+
+    def remove_battle_flashes_mod(self, flash_address_arrays):
+        ABSOLUTE_CHANGES = [0xb0, 0xaf]
+        RELATIVE_CHANGES = [0xb5, 0xb6]
+        # For each battle animation command
+        for flash_addresses in flash_address_arrays:
+            # For each address in its array
+            for flash_address in flash_addresses:
+                # Read the current animation command at the address
+                animation_cmd = Read(flash_address, flash_address+1)
+                if(animation_cmd[0] in ABSOLUTE_CHANGES):
+                    # This is an absolute color change. To remove flashing effects, set the value to E0 to cause no background change
+                    Write(flash_address+1, 0xE0, "Background color change (absolute)")
+                elif(animation_cmd[0] in RELATIVE_CHANGES):
+                    # This is a relative color change. To remove flash effects, set the value to F0 to cause no background change
+                    Write(flash_address+1, 0xF0, "Background color change (relative)")
+                else:
+                    # This is an error, reflecting a difference between the disassembly used to generate BATTLE_ANIMATION_FLASHES and the ROM
+                    raise ValueError(f"Battle Animation Script Command at 0x{flash_address:x} (0x{animation_cmd[0]:x}) did not match an expected value.")
+    
+    def health_animation_reflect_mod(self):
+        # Ref: https://www.ff6hacking.com/forums/thread-4145.html
+        # Banon's Health command casts Cure 2 on the party with a unique animation.
+        # Because the animation is unique, it has the step-forward component built into it.  
+        # And because Cure 2 can be reflected, if the command hits a mirrored target it will bounce and make Banon step forward again.  
+        # Note: this only occurs if the whole party doesn't have reflect, only a subset.
+        # Used over and over, Banon can be made to walk completely off-screen.
+        # 
+        # Fix:
+        # We tell the HEALTH animation to ignore block graphics, which prevents the reflect animation from playing.  
+        # When encountering a reflection, the regular green Cure 2 animation will follow on the reflect recipient.
+        src = [
+            asm.INC(0x62C0, asm.ABS), #Makes the animation ignore blocking graphics
+            asm.JSR(0xBC35, asm.ABS), #Call the subroutine that got displaced to inject the block override
+            asm.RTS()
+        ]
+        space = Write(Bank.C1, src, "Health animation fix")
+        jsrAddr = space.start_address
+
+        # Replace the existing jump with one to our new service routine
+        space = Reserve(0x1BB67, 0x1BB69, "Health animation JSR")
+        space.write(asm.JSR(jsrAddr, asm.ABS))