Merge branch 'main' into dev/logging

Author: orkaboy

Diff for: battle/boss.py

@@ -1,6 +1,6 @@
 # Main gamestate and step to load
 # "none", "Baaj", "Besaid", "Boat1", "Kilika", "Luca", "Miihen", "MRR"
-# "Djose", "Moonflow", "Guadosalam", "Macalania", "Home", "rescueYuna"
+# "Djose", "Moonflow", "Guadosalam", "Macalania", "Home", "rescue_yuna"
 # "Gagazet", "Zanarkand", "Sin", "Nem_Farm"
 gamestate     : "none" # valid values listed above
 step_counter  : 1      # valid step_counter values are dependent on gamestate
@@ -10,23 +10,23 @@ verbosity     : DEBUG  # Verbosity of log messages in the console.
                        # These are the valid levels: DEBUG, INFO, WARNING, ERROR, CRITICAL
                        # Full log will always be available in a file.
 
-# RNG Seed (requires setting vars.setSeed: True)
-rngSeedNum    : 160    # If starting a new run and using setSeed, use this RNG seed
-useFavoredSeed: False  # If starting a new run and not using setSeed, use a curated array of seeds
+# RNG Seed (requires setting vars.set_seed: True)
+rng_seed_num    : 160    # If starting a new run and using set_seed, use this RNG seed
+use_favored_seed: False  # If starting a new run and not using set_seed, use a curated array of seeds
 
 # Run configuration variables in vars.py
 vars:
   # Important Values
-  artificialPauses    : False  # Set depending on hardware. True == less powerful hardware.
-  csrValue            : True   # Set automatically on new game. For testing (loading a save file) set for your environment.
-  nemesisValue        : False  # Set based on if you're doing any% (False) or Nemesis% (True)
-  forceLoop           : False  # After game is finished, start again on next seed.
-  setSeed             : False  # If you are using Rossy's patch, set to True. Otherwise set to False
-  kilikaSkip          : True   # True == Tidus OD on Evrae instead of Seymour. New strat.
-  perfectAeonKills    : False  # Before YuYevon, True is slower but more swag.
-  attemptDjose        : False  # Try Djose skip? (not likely to succeed)
-  legacySoundtrack    : True   # use the original Soundtrack instead of arranged
-  doNotSkipCutscenes  : False  #            - Missing documentation -
+  artificial_pauses    : False  # Set depending on hardware. True == less powerful hardware.
+  csr_value            : True   # Set automatically on new game. For testing (loading a save file) set for your environment.
+  nemesis_value        : False  # Set based on if you're doing any% (False) or Nemesis% (True)
+  force_loop           : False  # After game is finished, start again on next seed.
+  set_seed             : False  # If you are using Rossy's patch, set to True. Otherwise set to False
+  kilika_skip          : True   # True == Tidus OD on Evrae instead of Seymour. New strat.
+  perfect_aeon_kills    : False  # Before YuYevon, True is slower but more swag.
+  attempt_djose        : False  # Try Djose skip? (not likely to succeed)
+  legacy_soundtrack    : True   # use the original Soundtrack instead of arranged
+  do_not_skip_cutscenes  : False  #            - Missing documentation -
   battle_speedup      : False  # Use 4x speed when doing battles.
 
   # Accessibility for blind
@@ -37,45 +37,45 @@ vars:
   rails_egg_hunt      : True   #            - Missing documentation -
 
   # Blitzball
-  forceBlitzWin       : False  #            - Missing documentation -
-  blitzLoop           : False  # Loop on the same seed immediately after Blitzball.
-  blitzLossForceReset : True   # True == reset after blitz loss
-  blitzWinValue       : True   # No default value required
-  blitzOvertime       : False  # Set to False, no need to change ever.
-  blitzFirstShotVal   : False  #            - Missing documentation -
-  oblitzAttackVal     : "255"  # Used for RNG manip tracking
+  force_blitz_win       : False  #            - Missing documentation -
+  blitz_loop           : False  # Loop on the same seed immediately after Blitzball.
+  blitz_loss_force_reset : True   # True == reset after blitz loss
+  blitz_win_value       : True   # No default value required
+  blitz_overtime       : False  # Set to False, no need to change ever.
+  blitz_first_shot_val   : False  #            - Missing documentation -
+  oblitz_attack_val     : "255"  # Used for RNG manip tracking
 
   # Sphere grid
-  fullKilikMenu       : False  # Default to False
-  earlyTidusGridVal   : False  # Default False
-  earlyHasteVal       : 1      # Default -1
-  wakkaLateMenuVal    : False  # Default False
-  endGameVersionVal   : 1      # Default 0
+  full_kilik_menu       : False  # Default to False
+  early_tidus_grid_val   : False  # Default False
+  early_haste_val       : 1      # Default -1
+  wakka_late_menu_val    : False  # Default False
+  end_game_version_val   : 1      # Default 0
 
   # Equipment
-  zombieWeaponVal     : 255    # Default 255
+  zombie_weapon_val     : 255    # Default 255
   l_strike_count        : 1      # Default 0
 
   # RNG Manip
   yellows             : 0      #            - Missing documentation -
-  confirmedSeedNum    : 999    #            - Missing documentation -
-  skipZanLuck         : False  #            - Missing documentation -
+  confirmed_seed_num    : 999    #            - Missing documentation -
+  skip_zan_luck         : False  #            - Missing documentation -
 
   # Other
-  newGame             : False  #            - Missing documentation -
+  new_game             : False  #            - Missing documentation -
   self_destruct        : False  # Default False
-  YTKFarm             : 0      # Default to 0
-  rescueCount         : 0      # Default to 0
-  fluxOverkillVar     : False  # Default to False
-  tryNEVal            : True   # Based on
-  # firstHits is still in vars.py
-  neArmorVal          : 255    # Default 255
-  neBattles           : 0      # Default to 0
-  neaZone             : 0      # Decides in which zone we charge Rikku OD after reaching Zanarkand.
+  ytk_farm             : 0      # Default to 0
+  rescue_count         : 0      # Default to 0
+  flux_overkill_var     : False  # Default to False
+  try_ne_val            : True   # Based on
+  # first_hits is still in vars.py
+  ne_armor_val          : 255    # Default 255
+  ne_battles           : 0      # Default to 0
+  nea_zone             : 0      # Decides in which zone we charge Rikku OD after reaching Zanarkand.
 
   # Nemesis variables, unused in any%
-  nemAPVal            : 1      # Default to 1
-  # areaResults is still in vars.py
-  # speciesResults is still in vars.py
-  # originalResults is still in vars.py
-  yojimboIndex        : 1  #            - Missing documentation -
+  nem_ap_val            : 1      # Default to 1
+  # area_results is still in vars.py
+  # species_results is still in vars.py
+  # original_results is still in vars.py
+  yojimbo_index        : 1  #            - Missing documentation -

Diff for: battle/main.py

@@ -3,15 +3,15 @@
 import os
 from pathlib import Path
 
+import area.dream_zan
+import logs
 import memory.main
 import pathing
 import screen
 import vars
-from gamestate import game
 import xbox
 import zz_airship_path
-import area.dream_zan
-import logs
+from gamestate import game
 
 # This file is intended to load the game to a saved file.
 # This assumes that the save is the first non-auto-save in the list of saves.
@@ -21,7 +21,7 @@
 game_vars = vars.vars_handle()
 
 
-def load_into_game(gamestate:str, step_counter:str):
+def load_into_game(gamestate: str, step_counter: str):
     if not (gamestate == "Luca" and step_counter == 3):
         area.dream_zan.new_game(gamestate)
         game.start_time = logs.time_stamp()
@@ -67,7 +67,7 @@ def load_into_game(gamestate:str, step_counter:str):
         load_miihen_start_laugh()
     if gamestate == "Miihen" and step_counter == 2:  # Agency
         load_save_num(28)
-        returnArray = [False, 0, 0, False]
+        return_array = [False, 0, 0, False]
     if gamestate == "MRR" and step_counter == 1:  # Mi'ihen North after meeting Seymour
         load_save_num(38)
         memory.main.set_gil_value(4000)  # Fixes a low gil state for this save file.
@@ -100,17 +100,17 @@ def load_into_game(gamestate:str, step_counter:str):
         load_save_num(60)
     if gamestate == "Home" and step_counter == 2:
         load_save_num(11)
-    if gamestate == "rescueYuna" and step_counter == 1:  # Airship, first movement.
+    if gamestate == "rescue_yuna" and step_counter == 1:  # Airship, first movement.
         # Blitz Win, save less speed/power spheres
         load_save_num(56)
-    if gamestate == "rescueYuna" and step_counter == 2:  # Bevelle trials
+    if gamestate == "rescue_yuna" and step_counter == 2:  # Bevelle trials
         load_save_num(15)
-    if gamestate == "rescueYuna" and step_counter == 4:  # Altana
+    if gamestate == "rescue_yuna" and step_counter == 4:  # Altana
         load_save_num(12)
         # memory.main.setEncounterRate(setVal=0)
         # memory.main.setGameSpeed(setVal=1)
     # Highbridge before Seymour Natus
-    if gamestate == "rescueYuna" and step_counter == 5:
+    if gamestate == "rescue_yuna" and step_counter == 5:
         load_save_num(42)  # Regular
         # loadGame.loadSaveNum(67) #Nemesis
     if gamestate == "Gagazet" and step_counter == 1:  # Just before Calm Lands
@@ -200,14 +200,14 @@ def load_into_game(gamestate:str, step_counter:str):
     if gamestate == "Nem_Farm" and step_counter == 8:
         load_save_num(73)
     if gamestate == "Nem_Farm" and step_counter == 9:
-        #Start of Nemesis farm
-        #import nemesis.menu
-        #import memory.main
+        # Start of Nemesis farm
+        # import nemesis.menu
+        # import memory.main
         load_save_num(19)
         game_vars.set_nem_checkpoint_ap(27)  # See nemesis.menu
         game_vars.end_game_version_set(4)
-        #memory.main.arena_array_nines()
-        #while not memory.main.get_tidus_slvl() >= 70:
+        # memory.main.arena_array_nines()
+        # while not memory.main.get_tidus_slvl() >= 70:
         #    nemesis.menu.perform_next_grid()
         #    memory.main.set_tidus_slvl(memory.main.get_tidus_slvl()+1)
     if gamestate == "Nem_Farm" and step_counter == 11:
@@ -255,6 +255,7 @@ def load_into_game(gamestate:str, step_counter:str):
         memory.main.check_nea_armor()
     memory.main.check_nea_armor()
 
+
 def get_saved_files():
     saveFilesFull = sorted(
         Path(game_vars.game_save_path()).iterdir(), key=os.path.getmtime

Diff for: blitz.py

@@ -3,9 +3,9 @@
 import memory.main
 
 try:
-    from memory.main import baseValue
+    from memory.main import base_value
 except Exception:
-    baseValue = 0x0
+    base_value = 0x0
 game = "FFX_"
 ext = ".txt"
 fileName = "none"
@@ -177,7 +177,7 @@ def __init__(
         if self.isPointer:
             self.ptrOffset = ptrOffsetRef
         self.varType = typeRef
-        self.key = baseValue + 0x003988A5
+        self.key = base_value + 0x003988A5
 
         self.set_last_value()
 
@@ -323,15 +323,15 @@ def mem_change_list():
 
 
 def mem_change_handle():
-    retArray = [0]
+    ret_array = [0]
     firstEle = True
     memRefList = mem_change_list()
 
     while len(baseArray) != 0:
         if firstEle:
             firstEle = False
             variables = memRefList.pop()
-            retArray[0] = MemChangeMonitor(
+            ret_array[0] = MemChangeMonitor(
                 baseOffsetRef=variables[0],
                 isPointerRef=variables[1],
                 ptrOffsetRef=variables[2],
@@ -340,7 +340,7 @@ def mem_change_handle():
             )
         else:
             variables = memRefList.pop()
-            retArray.append(
+            ret_array.append(
                 MemChangeMonitor(
                     baseOffsetRef=variables[0],
                     isPointerRef=variables[1],
@@ -349,7 +349,7 @@ def mem_change_handle():
                     childReport=variables[4],
                 )
             )
-    return retArray
+    return ret_array
 
 
 def time_stamp():