Merge pull request #203 from shenef/main

Add pre-commit config
Closes #141

Author: shenef

Diff for: .pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id:   black
+        exclude: migrations
+-   repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+        name: isort (python)
+
+# uncomment once the repo complies with flake8
+#-   repo: https://github.com/pycqa/flake8
+#    rev: 5.0.4
+#    hooks:
+#    -   id: flake8
+#        args: ["--ignore=E501, W503"]

Diff for: config.py

@@ -9,6 +9,7 @@
 # TODO: Make this be set by an argument instead
 CONFIG_FILE_PATH = "config.yaml"
 
+
 # TODO: It's not ideal to open this file many times over, but also not a huge problem
 def open_config():
     # Open the config file and parse the yaml contents
@@ -20,5 +21,7 @@ def open_config():
                 print(f"Error: Failed to parse config file {CONFIG_FILE_PATH}: {E}")
                 return {}
     except Exception as E:
-        print(f"Didn't find config file {CONFIG_FILE_PATH}, using default values for run.")
+        print(
+            f"Didn't find config file {CONFIG_FILE_PATH}, using default values for run."
+        )
         return {}

Diff for: gamestate.py

@@ -1,10 +1,10 @@
-
 class GameState:
     def __init__(self):
         self.state = "none"
         self.step = 1
         self.rng_seed_num = 160
         self.start_time = 0
 
+
 # Global
 game = GameState()

Diff for: main.py

@@ -5,7 +5,7 @@
 
 # This needs to be before the other imports in case they decide to log things when imported
 import log_init
-import logging
+
 # This sets up console and file logging (should only be called once)
 log_init.initialize_logging()
 
@@ -49,6 +49,7 @@
 
 FFXC = xbox.controller_handle()
 
+
 def configuration_setup():
     game_vars = vars.vars_handle()
     # Open the config file and parse game configuration
@@ -118,6 +119,7 @@ def rng_seed_setup():
         logs.write_stats("RNG seed:")
         logs.write_stats(rng_seed)
 
+
 def load_game_state():
     # loading from a save file
     load_game.load_into_game(gamestate=game.state, step_counter=game.step)
@@ -137,7 +139,7 @@ def perform_TAS():
             # Blitzball testing logic
             if game.state == "Luca" and game.step == 3:
                 area.dream_zan.new_game(game.state)
-                load_game.load_save_num(37) # TODO: Magic number
+                load_game.load_save_num(37)  # TODO: Magic number
 
             if game.rng_seed_num >= 256:
                 game.state = "End"
@@ -780,6 +782,7 @@ def perform_TAS():
 
     logger.info("Time! The game is now over.")
 
+
 def write_final_logs():
     if memory.main.get_story_progress() > 3210:
         end_time = logs.time_stamp()
@@ -810,6 +813,7 @@ def write_final_logs():
 
     logger.info("Automation complete. Shutting down. Have a great day!")
 
+
 # Main entry point of TAS
 if __name__ == "__main__":
     # Load up vars.py

Diff for: save_sphere.py

@@ -1,17 +1,27 @@
 import memory
 import xbox
+
 FFXC = xbox.controller_handle()
-import math
 import json
+import math
+
 import pathing
 import vars
+
 game_vars = vars.vars_handle()
 
+
 def distance(save_index) -> int:
     tidus_coords = memory.main.get_coords()
     target_coords = memory.main.get_actor_coords(save_index)
-    
-    return int(math.sqrt((target_coords[1] - tidus_coords[1])**2 + (target_coords[0] - tidus_coords[0])**2))
+
+    return int(
+        math.sqrt(
+            (target_coords[1] - tidus_coords[1]) ** 2
+            + (target_coords[0] - tidus_coords[0]) ** 2
+        )
+    )
+
 
 def nearest_save_actor() -> int:
     save_actors = []
@@ -20,7 +30,7 @@ def nearest_save_actor() -> int:
         actorMem = memory.main.get_actor_id(x)
         if actorMem != 52685:
             print(actorMem, " | ", x)
-        if actorMem in [20481,20482,20651]:
+        if actorMem in [20481, 20482, 20651]:
             save_actors.append(x)
     print(save_actors)
     if len(save_actors) == 0:
@@ -39,6 +49,7 @@ def nearest_save_actor() -> int:
                 best_dist = distance(save_actors[j])
         return best_actor
 
+
 def approach_save_sphere():
     memory.main.clear_save_menu_cursor()
     memory.main.clear_save_menu_cursor_2()
@@ -48,8 +59,9 @@ def approach_save_sphere():
     print("Approaching actor: ", target_actor)
     FFXC.set_neutral()
     while not (
-        memory.main.diag_progress_flag() == target_details[2] and
-        memory.main.diag_skip_possible()):
+        memory.main.diag_progress_flag() == target_details[2]
+        and memory.main.diag_skip_possible()
+    ):
         if memory.main.user_control():
             pathing.set_movement([target_coords[0], target_coords[1]])
             xbox.tap_b()
@@ -68,7 +80,7 @@ def approach_save_sphere():
                     x_val=target_coords[0],
                     y_val=target_coords[1],
                     diag_prog=memory.main.diag_progress_flag(),
-                    actor=target_actor
+                    actor=target_actor,
                 )
                 while not memory.main.user_control():
                     xbox.tap_a()
@@ -91,31 +103,35 @@ def approach_save_sphere():
                     print("Mark 3", memory.main.diag_progress_flag())
                     xbox.tap_b()
 
+
 def disengage_save_sphere():
     while memory.main.save_menu_cursor() == 0 and memory.main.save_menu_cursor_2() == 0:
         print("Cursor")
         xbox.tap_a()
     while not memory.main.user_control():
         xbox.tap_b()
 
+
 def touch_and_go():
     approach_save_sphere()
     print("Now touching save sphere.")
     disengage_save_sphere()
 
-def touch_and_save(save_num:int=999):
+
+def touch_and_save(save_num: int = 999):
     if save_num >= 200:
         print("Cannot save number ", save_num, ", out of bounds error")
         save_num = 999
     save_pos = 999
     if save_num != 999:
         import loadGame
+
         saveFiles = loadGame.get_saved_files()
         testString = "ffx_" + str(save_num).zfill(3)
         for x in range(len(saveFiles)):
             if saveFiles[x] == testString:
                 save_pos = x
-    
+
     approach_save_sphere()
     memory.main.wait_frames(2)
     while not memory.main.save_menu_open():
@@ -138,37 +154,46 @@ def touch_and_save(save_num:int=999):
     xbox.tap_b()
     while not memory.main.user_control():
         xbox.tap_a()
-    
+
     if save_num != 999 and save_pos == 999:
         saveFiles = loadGame.get_saved_files()
-        print("File was expected as save number ", save_num, ", but could not find this file.")
+        print(
+            "File was expected as save number ",
+            save_num,
+            ", but could not find this file.",
+        )
         print("Actual save file: ", saveFiles[0])
         file_orig = game_vars.game_save_path() + saveFiles[0]
         print(file_orig)
         file_dest = game_vars.game_save_path() + "ffx_" + str(save_num).zfill(3)
         print(file_dest)
         import shutil
+
         shutil.move(src=file_orig, dst=file_dest)
 
-def get_save_sphere_settings(actor_index:int):
+
+def get_save_sphere_settings(actor_index: int):
     filepath = "json_ai_files\\save_sphere_details.json"
     with open(filepath, "r") as fp:
         results = json.load(fp)
-    
+
     map_num = str(memory.main.get_map())
     diag_num = str(memory.main.get_story_progress())
     actor_num = str(actor_index)
-    ret_array = [999,999,999]
+    ret_array = [999, 999, 999]
     if map_num in results:
         if diag_num in results[map_num]:
             if actor_num in results[map_num][diag_num]:
-                ret_array = [results[map_num][diag_num][actor_num]["x"],
+                ret_array = [
+                    results[map_num][diag_num][actor_num]["x"],
                     results[map_num][diag_num][actor_num]["y"],
-                    results[map_num][diag_num][actor_num]["diag"]]
-    
+                    results[map_num][diag_num][actor_num]["diag"],
+                ]
+
     return ret_array
 
-def record_save_sphere(x_val:int, y_val:int, diag_prog:int, actor:int):
+
+def record_save_sphere(x_val: int, y_val: int, diag_prog: int, actor: int):
     filepath = "json_ai_files\\save_sphere_details.json"
     with open(filepath, "r") as fp:
         records = json.load(fp)
@@ -177,32 +202,31 @@ def record_save_sphere(x_val:int, y_val:int, diag_prog:int, actor:int):
     actor_num = str(actor)
     print("========================")
     newVal = {
-        map_num: {
-            diag_num: {
-                actor_num: {
-                    "x": x_val,
-                    "y": y_val,
-                    "diag": diag_prog
-                }
-            }
-        }
+        map_num: {diag_num: {actor_num: {"x": x_val, "y": y_val, "diag": diag_prog}}}
     }
     if map_num in records.keys():
-        if diag_num in (
-            records[map_num].keys()
-        ):
+        if diag_num in (records[map_num].keys()):
             if actor_num in records[map_num][diag_num]:
-                if records[map_num][diag_num][actor_num]["diag"] != newVal[map_num][diag_num][actor_num]["diag"]:
-                    
-                    records[map_num][diag_num][actor_num]["x"] = newVal[map_num][diag_num][actor_num]["x"]
-                    records[map_num][diag_num][actor_num]["y"] = newVal[map_num][diag_num][actor_num]["y"]
-                    records[map_num][diag_num][actor_num]["diag"] = newVal[map_num][diag_num][actor_num]["diag"]
+                if (
+                    records[map_num][diag_num][actor_num]["diag"]
+                    != newVal[map_num][diag_num][actor_num]["diag"]
+                ):
+
+                    records[map_num][diag_num][actor_num]["x"] = newVal[map_num][
+                        diag_num
+                    ][actor_num]["x"]
+                    records[map_num][diag_num][actor_num]["y"] = newVal[map_num][
+                        diag_num
+                    ][actor_num]["y"]
+                    records[map_num][diag_num][actor_num]["diag"] = newVal[map_num][
+                        diag_num
+                    ][actor_num]["diag"]
             else:
                 records[map_num][diag_num].update(newVal[map_num][diag_num])
         else:
             records[map_num].update(newVal[map_num])
     else:
         records.update(newVal)
-    
+
     with open(filepath, "w") as fp:
         json.dump(records, fp, indent=4)

Diff for: tools/move_saves.py

@@ -1,16 +1,27 @@
-from absl import app
-from absl import flags
 import os
 import shutil
 import sys
 import time
 
+from absl import app, flags
+
 FLAGS = flags.FLAGS
 
-flags.DEFINE_bool("setup_saves", False, "Will set up the TAS saves and store your saves in a new folder called 'Save Backups'")
-flags.DEFINE_bool("restore_saves", False, "Will restore your saves and remove the TAS saves.")
+flags.DEFINE_bool(
+    "setup_saves",
+    False,
+    "Will set up the TAS saves and store your saves in a new folder called 'Save Backups'",
+)
+flags.DEFINE_bool(
+    "restore_saves", False, "Will restore your saves and remove the TAS saves."
+)
+
+flags.DEFINE_string(
+    "user_path",
+    "",
+    "Set this if your Documents folder, and thus your 'SQUARE ENIX\\FINAL FANTASY X&X-2 HD Remaster folder' is in a different location.",
+)
 
-flags.DEFINE_string("user_path", "", "Set this if your Documents folder, and thus your 'SQUARE ENIX\\FINAL FANTASY X&X-2 HD Remaster folder' is in a different location.")
 
 def _move_file(name, src_dir, dest_dir, mod_time):
     src_full_path = os.path.join(src_dir, name)
@@ -33,14 +44,24 @@ def setup_saves():
     tas_saves = ".\\tas_saves"
     print(f"Copying save files from '{square_saves}' to '.\\Save Backups'")
     shutil.copytree(square_saves, ".\\Save Backups")
-    print(f"Copying TAS save files from '.\\tas_saves' to {square_saves}' and modifying timestamps.")
+    print(
+        f"Copying TAS save files from '.\\tas_saves' to {square_saves}' and modifying timestamps."
+    )
     shutil.rmtree(square_saves)
     os.mkdir(square_saves)
     current_time = time.time()
-    for cur_file in sorted([f for f in os.listdir(tas_saves) if os.path.isfile(os.path.join(tas_saves, f))], reverse=True):
+    for cur_file in sorted(
+        [
+            f
+            for f in os.listdir(tas_saves)
+            if os.path.isfile(os.path.join(tas_saves, f))
+        ],
+        reverse=True,
+    ):
         _move_file(cur_file, tas_saves, square_saves, current_time)
         current_time += 60
 
+
 def restore_saves():
     """Restores the backed up saves."""
     square_saves = f"{FLAGS.user_path or os.path.expanduser('~')}\\Documents\\SQUARE ENIX\\FINAL FANTASY X&X-2 HD Remaster\\FINAL FANTASY X\\"
@@ -50,7 +71,9 @@ def restore_saves():
 
 
 def main(argv):
-    print("TAS Save fixer utility. Ensure that the script is run from the main folder of the repo.")
+    print(
+        "TAS Save fixer utility. Ensure that the script is run from the main folder of the repo."
+    )
     check_flags()
     if FLAGS.setup_saves:
         print("Setting TAS Saves Up.")
@@ -61,6 +84,5 @@ def main(argv):
     print("Done")
 
 
-
 if __name__ == "__main__":
     app.run(main)