bcsfe 3.3.0__tar.gz → 3.4.0__tar.gz

{bcsfe-3.3.0/src/bcsfe.egg-info → bcsfe-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bcsfe
-Version: 3.3.0
+Version: 3.4.0
 Summary: A save file editor for The Battle Cats
 Author: fieryhenry
 License-Expression: GPL-3.0-or-later
@@ -56,6 +56,8 @@ test/develop new features
 
 - HungJoesifer for Vietnamese localization
 
+- LinYuAn for Traditional Chinese localization
+
 ### Themes
 
 - HungJoesifer for the `discord` inspired theme
@@ -330,7 +332,7 @@ Once you have installed and ran the editor, you can now begin to edit your save
 
 1. In `The Battle Cats` enter the `Change Account / Device` menu in the `Settings` on the main menu.
 
-2. Then enter the `Begin Data Transfer` menu.
+2. Then enter the `Change Device` -> `Retrieve Data from Old Device` menu.
 
 3. Then click / tap `Save Data to Server`, this should give you a transfer code and a confirmation
 code.
@@ -359,8 +361,8 @@ may also fail, if it does then try again.
 11. Back in-game, tap the `Close Game` button, then tap `Cancel Data Transfer` (and also possibly
 `Start Game From Beginning`)
 
-12. Go back into the `Change Account / Device` menu and then go into the `Resume Data Transfer`
-menu
+12. Go back into the `Change Account / Device` menu and then go into the `Resume Data Transfer` ->
+`Transfer Data to New Device` menu
 
 13. Enter the new codes, and tap `Resume Transfer`
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/README.md

@@ -27,6 +27,8 @@ test/develop new features
 
 - HungJoesifer for Vietnamese localization
 
+- LinYuAn for Traditional Chinese localization
+
 ### Themes
 
 - HungJoesifer for the `discord` inspired theme
@@ -301,7 +303,7 @@ Once you have installed and ran the editor, you can now begin to edit your save
 
 1. In `The Battle Cats` enter the `Change Account / Device` menu in the `Settings` on the main menu.
 
-2. Then enter the `Begin Data Transfer` menu.
+2. Then enter the `Change Device` -> `Retrieve Data from Old Device` menu.
 
 3. Then click / tap `Save Data to Server`, this should give you a transfer code and a confirmation
 code.
@@ -330,8 +332,8 @@ may also fail, if it does then try again.
 11. Back in-game, tap the `Close Game` button, then tap `Cancel Data Transfer` (and also possibly
 `Start Game From Beginning`)
 
-12. Go back into the `Change Account / Device` menu and then go into the `Resume Data Transfer`
-menu
+12. Go back into the `Change Account / Device` menu and then go into the `Resume Data Transfer` ->
+`Transfer Data to New Device` menu
 
 13. Enter the new codes, and tap `Resume Transfer`
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.3.0"
+__version__ = "3.4.0"
 
 from bcsfe import core, cli
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/__main__.py

@@ -18,19 +18,27 @@ def main():
     parser.add_argument(
         "--input-path", "-i", type=str, help="input path to save file to edit"
     )
+    parser.add_argument(
+        "--game-data-dir", "-g", type=str, help="path to store the game data to"
+    )
+    parser.add_argument(
+        "--transfer-backup-path",
+        type=str,
+        help="path to save the backup SAVE_DATA after transfering to",
+    )
     parser.add_argument(
         "--config-path",
         "-c",
         type=str,
         default=None,
-        help="path to the config file. If unspecified defaults to Documents/bcsfe/config.yaml",
+        help=f"path to the config file. If unspecified defaults to {core.Config.get_config_path()}",
     )
     parser.add_argument(
         "--log-path",
         "-l",
         type=str,
         default=None,
-        help="path to the log file. If unspecified defaults to Documents/bcsfe/bcsfe.log",
+        help=f"path to the log file. If unspecified defaults to {core.Logger.get_log_path()}",
     )
 
     args = parser.parse_args()
@@ -44,6 +52,12 @@ def main():
     if args.log_path is not None:
         core.set_log_path(core.Path(args.log_path))
 
+    if args.transfer_backup_path is not None:
+        core.set_transfer_backup_path(core.Path(args.transfer_backup_path))
+
+    if args.game_data_dir is not None:
+        core.set_game_data_path(core.Path(args.game_data_dir))
+
     core.core_data.init_data()
 
     try:

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/edits/cat_editor.py

@@ -413,8 +413,9 @@ class CatEditor:
                 if should_exit:
                     return
                 if upgrade is not None:
-                    power_up.reset_upgrade()
-                    power_up.upgrade_by(upgrade.base)
+                    if upgrade.base != -1:
+                        power_up.reset_upgrade()
+                        power_up.upgrade_by(upgrade.base)
                     cat.set_upgrade(self.save_file, upgrade, True)
                     color.ColoredText.localize(
                         "selected_cat_upgraded",
@@ -435,8 +436,9 @@ class CatEditor:
             success = True
             for cat in cats:
                 power_up = core.PowerUpHelper(cat, self.save_file)
-                power_up.reset_upgrade()
-                power_up.upgrade_by(upgrade.base)
+                if upgrade.base != -1:
+                    power_up.reset_upgrade()
+                    power_up.upgrade_by(upgrade.base)
                 cat.set_upgrade(self.save_file, upgrade, True)
         if success:
             color.ColoredText.localize("upgrade_success")

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/edits/storage.py

@@ -128,6 +128,23 @@ def edit_loop(save_file: core.SaveFile) -> bool:
         if editor is None:
             return False
 
+        new_cats: list[core.Cat] = []
+        for cat in cats:
+            names = cat.get_names_cls(save_file)
+            if names is None or not names:
+                name = core.localize("unknown")
+            else:
+                name = names[0]
+            quantity, _ = dialog_creator.IntInput(default=1).get_input_locale(
+                "cat_quantity", {"name": name, "id": cat.id}
+            )
+            if quantity is None:
+                return False
+            for _ in range(quantity):
+                new_cats.append(cat)
+
+        cats = new_cats
+
         space = get_storage_space(storage)
         if len(cats) > len(storage):
             color.ColoredText.localize(
@@ -164,6 +181,19 @@ def edit_loop(save_file: core.SaveFile) -> bool:
         if options is None:
             return False
 
+        items: list[core.StorageItem] = []
+
+        for id in options:
+            item = core.StorageItem.from_special_skill(id)
+
+            quantity, _ = dialog_creator.IntInput(default=1).get_input_locale(
+                "skill_quantity", {"name": skill_names[id]}
+            )
+            if quantity is None:
+                return False
+            for _ in range(quantity):
+                items.append(item)
+
         space = get_storage_space(storage)
         if len(options) > len(storage):
             color.ColoredText.localize(
@@ -177,8 +207,7 @@ def edit_loop(save_file: core.SaveFile) -> bool:
             return False
 
         color.ColoredText.localize("added_special_skills")
-        for choice in options:
-            item = core.StorageItem.from_special_skill(choice)
+        for item in items:
             add_item(storage, item)
             display_item(item, save_file)
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/feature_handler.py

@@ -8,7 +8,7 @@ class FeatureHandler:
     def __init__(self, save_file: core.SaveFile):
         self.save_file = save_file
 
-    def get_features(self):
+    def get_features(self) -> dict[str, Any]:
         cat_features = {"cats": edits.cat_editor.CatEditor.edit_cats}
         if core.core_data.config.get_bool(core.ConfigKey.SEPARATE_CAT_EDIT_OPTIONS):
             cat_features = {
@@ -33,7 +33,9 @@ class FeatureHandler:
                 "save_save": save_management.SaveManagement.save_save,
                 "save_upload": save_management.SaveManagement.save_upload,
                 "save_save_file": save_management.SaveManagement.save_save_dialog,
-                "save_save_documents": save_management.SaveManagement.save_save_documents,
+                core.localize(
+                    "save_save_documents", path=core.SaveFile.get_save_path()
+                ): save_management.SaveManagement.save_save_data_dir,
                 "waydroid_push": save_management.SaveManagement.waydroid_push,
                 "waydroid_push_rerun": save_management.SaveManagement.waydroid_push_rerun,
                 "adb_push": save_management.SaveManagement.adb_push,
@@ -142,8 +144,7 @@ class FeatureHandler:
         }
         return features
 
-    def get_feature(self, feature_name: str):
-        feature_path = feature_name.split(".")
+    def get_feature(self, feature_path: list[str]):
         feature_dict = self.get_features()
         feature = feature_dict
         for path in feature_path:
@@ -154,10 +155,10 @@ class FeatureHandler:
     def search_features(
         self,
         name: str,
-        parent_path: str = "",
+        current_path: list[str],
         features: dict[str, Any] | None = None,
-        found_features: dict[str, int] | None = None,
-    ) -> dict[str, int]:
+        found_features: dict[tuple[str, ...], int] | None = None,
+    ) -> dict[tuple[str, ...], int]:
         name = name.lower()
         if features is None:
             features = self.get_features()
@@ -166,9 +167,8 @@ class FeatureHandler:
 
         for feature_name_key, feature in features.items():
             feature_name = core.core_data.local_manager.get_key(feature_name_key)
-            path = (
-                f"{parent_path}.{feature_name_key}" if parent_path else feature_name_key
-            )
+            path = current_path.copy()
+            path.append(feature_name_key)
             if isinstance(feature, dict):
                 found_features.update(
                     self.search_features(
@@ -180,34 +180,36 @@ class FeatureHandler:
                 )
             for alias in core.LocalManager.get_all_aliases(feature_name):
                 if not name:
-                    found_features[path] = 100
+                    found_features[*path] = 100
                     break
                 alias = alias.lower()
 
                 name = name.replace(" ", "")
                 alias = alias.replace(" ", "")
                 if alias in name or name in alias:
-                    found_features[path] = 100
+                    found_features[*path] = 100
                 break
 
         return found_features
 
-    def display_features(self, features: list[str]):
+    def display_features(self, features: list[list[str]]):
         feature_names: list[str] = []
         for feature_name in features:
-            feature_names.append(feature_name.split(".")[-1])
+            feature_names.append(feature_name[-1])
         print()
         dialog_creator.ListOutput(feature_names, [], "features", {}).display_locale(
             remove_alias=True
         )
 
-    def select_features(self, features: list[str], parent_path: str = "") -> list[str]:
+    def select_features(
+        self, features: list[list[str]], current_path: list[str]
+    ) -> list[list[str]]:
         if features != list(self.get_features().keys()):
-            features.insert(0, "go_back")
+            features.insert(0, ["go_back"])
         self.display_features(features)
         print()
         usr_input = color.ColoredInput().localize("select_features").strip()
-        selected_features: list[str] = []
+        selected_features: list[list[str]] = []
         if usr_input.isdigit():
             usr_input = int(usr_input)
             if usr_input > len(features):
@@ -216,59 +218,53 @@ class FeatureHandler:
                 color.ColoredText.localize("invalid_input")
             else:
                 feature_name_top = features[usr_input - 1]
-                if feature_name_top == "go_back":
-                    return list(self.get_features().keys())
+                if feature_name_top == ["go_back"]:
+                    return [[k] for k in self.get_features().keys()]
                 feature = self.get_feature(feature_name_top)
                 if isinstance(feature, dict):
                     for feature_name in feature.keys():  # type: ignore
-                        feature_path = (
-                            f"{parent_path}.{feature_name_top}.{feature_name}"
-                            if parent_path
-                            else f"{feature_name_top}.{feature_name}"
-                        )
+                        feature_path: list[str] = current_path.copy()
+                        feature_path.extend(feature_name_top + [feature_name])
                         selected_features.append(feature_path)
 
                 else:
-                    feature_path = (
-                        f"{parent_path}.{feature_name_top}"
-                        if parent_path
-                        else feature_name_top
-                    )
+                    feature_path = current_path.copy()
+                    feature_path.extend(feature_name_top)
                     selected_features.append(feature_path)
 
         else:
-            feats = self.search_features(usr_input)
+            feats = self.search_features(usr_input, [])
             if not feats:
                 color.ColoredText.localize("no_feature_with_name", name=usr_input)
             kv_map = list(feats.items())
             kv_map.sort(key=lambda v: v[1], reverse=True)
-            selected_features = [v[0] for v in kv_map]
+            selected_features = [list(v[0]) for v in kv_map]
 
         return selected_features
 
     def select_features_run(self):
-        features = self.get_features()
-        features = list(features.keys())
+        features_dict = self.get_features()
+        features: list[list[str]] = [[k] for k in features_dict.keys()]
         self.save_file.to_file_thread(self.save_file.get_temp_path())
         edits.clear_tutorial.clear_tutorial(self.save_file, False)
         self.save_file.show_ban_message = False
 
         while True:
-            features = self.select_features(features)
+            features = self.select_features(features, [])
 
-            new_features: list[str] = []
+            new_features: list[list[str]] = []
             found_strs: list[str] = []
             for feature_ in features:
-                if feature_.split(".")[-1] in found_strs:
+                if feature_[-1] in found_strs:
                     continue
-                found_strs.append(feature_.split(".")[-1])
+                found_strs.append(feature_[-1])
                 new_features.append(feature_)
 
             features = new_features
             feature = None
             if len(features) == 1:
                 feature = features[0]
-            if len(features) == 2 and features[0] == "go_back":
+            if len(features) == 2 and features[0] == ["go_back"]:
                 feature = features[1]
 
             if not feature:
@@ -283,8 +279,8 @@ class FeatureHandler:
 
                 self.save_file.to_file_thread(self.save_file.get_temp_path())
 
-                features = self.get_features()
-                features = list(features.keys())
+                features_dict = self.get_features()
+                features = [[k] for k in features_dict.keys()]
 
                 core.core_data.game_data_getter = None  # reset game data getter so that if an old version is removed, it will download the new version
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/main.py

@@ -291,10 +291,8 @@ class Main:
             return None
         try:
             json_data = core.JsonFile.from_data(path.read()).to_object()
-        except core.JSONDecodeError:
-            color.ColoredText.localize(
-                "load_json_fail", error=core.core_data.logger.get_traceback()
-            )
+        except (core.JSONDecodeError, UnicodeDecodeError):
+            color.ColoredText.localize("parse_json_fail")
             return None
         try:
             save_file = core.SaveFile.from_dict(json_data)

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/recent_saves.py

@@ -89,7 +89,10 @@ class RecentSaves:
     def to_path(self, path: core.Path):
         data = json.dumps(self.to_json(), indent=4)
 
-        path.write(core.Data(data))
+        try:
+            path.write(core.Data(data))
+        except Exception as e:
+            print(e)
 
     @staticmethod
     def read_default() -> RecentSaves:
@@ -100,7 +103,7 @@ class RecentSaves:
 
     @staticmethod
     def get_path() -> core.Path:
-        return core.Path.get_documents_folder().add("recent_saves.json")
+        return core.Path.get_data_folder().add("recent_saves.json")
 
     def save_default(self):
         path = RecentSaves.get_path()

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/save_management.py

@@ -27,7 +27,11 @@ class SaveManagement:
         if save_file.save_path is None:
             return
 
-        save_file.to_file(save_file.save_path)
+        try:
+            save_file.to_file(save_file.save_path)
+        except OSError as e:
+            print(e)
+            return
 
         color.ColoredText.localize("save_success", path=save_file.save_path)
 
@@ -48,14 +52,14 @@ class SaveManagement:
         color.ColoredText.localize("save_success", path=save_file.save_path)
 
     @staticmethod
-    def save_save_documents(save_file: core.SaveFile):
-        """Save the save file to the documents folder.
+    def save_save_data_dir(save_file: core.SaveFile):
+        """Save the save file to the data folder.
 
         Args:
             save_file (core.SaveFile): The save file to save.
         """
         SaveManagement.upload_items_checker(save_file)
-        save_file.save_path = core.SaveFile.get_saves_path().add("SAVE_DATA")
+        save_file.save_path = core.SaveFile.get_save_path()
         save_file.to_file(save_file.save_path)
         color.ColoredText.localize("save_success", path=save_file.save_path)
 
@@ -356,11 +360,9 @@ class SaveManagement:
         options = [
             "download_save",
             "select_save_file",
-            "load_from_documents",
+            core.localize("load_from_documents", path=core.SaveFile.get_save_path()),
             "adb_pull_save",
             "load_save_data_json",
-            # "load_recent_saves",
-            # "create_new_save",
         ]
         if starting_options:
             options.append("edit_config")
@@ -577,7 +579,10 @@ class SaveManagement:
 
         save_file.save_path = save_path
         backup_path = save_file.get_default_path()
-        save_file.save_path.copy_thread(backup_path)
+        try:
+            save_file.save_path.copy_thread(backup_path)
+        except Exception as e:
+            print(e)
         save_file.used_storage = used_storage
 
         return save_file, backup_path

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/cli/server_cli.py

@@ -64,7 +64,13 @@ class ServerCLI:
         if path is None:
             return None
 
-        save_file.to_file(path)
+        try:
+            save_file.to_file(path)
+        except OSError as e:
+            print(
+                f"failed to write save file to: {path} due to: {e}. Skipping writing the save file to disk"
+            )
+            input("press enter to continue anyway")
 
         color.ColoredText.localize("save_downloaded", path=path.to_str())
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/core/__init__.py

@@ -299,6 +299,8 @@ class CoreData:
 config_path = None
 print_config_err = True
 log_path = None
+transfer_backup_path = None
+game_data_path = None
 
 
 def set_config_path(path: Path):
@@ -306,11 +308,29 @@ def set_config_path(path: Path):
     config_path = path
 
 
+def set_game_data_path(path: Path):
+    global game_data_path
+    game_data_path = path
+
+
 def set_log_path(path: Path):
     global log_path
     log_path = path
 
 
+def set_transfer_backup_path(path: Path):
+    global transfer_backup_path
+    transfer_backup_path = path
+
+
+def get_transfer_backup_path() -> Path | None:
+    return transfer_backup_path
+
+
+def get_game_data_path() -> Path | None:
+    return game_data_path
+
+
 def update_external_content(_: Any = None):
     """Updates external content."""
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/core/game/catbase/gatya.py

@@ -235,7 +235,7 @@ class GatyaInfo:
 
     def get_file_path(self) -> core.Path:
         return (
-            core.Path.get_documents_folder()
+            core.Path.get_data_folder()
             .add("other_game_data")
             .add(self.cc.get_code())
             .add("gatya_info")

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/core/io/config.py

@@ -48,7 +48,7 @@ class Config:
 
     @staticmethod
     def get_config_path() -> core.Path:
-        return core.Path.get_documents_folder().add("config.yaml")
+        return core.Path.get_config_folder().add("config.yaml")
 
     def __getitem__(self, key: ConfigKey) -> Any:
         return self.config[key]

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/core/io/git_handler.py

@@ -52,9 +52,7 @@ class Repo:
         except FileNotFoundError:
             return None
 
-    def get_temp_file(
-        self, temp_folder: core.Path, file_path: core.Path
-    ) -> core.Data:
+    def get_temp_file(self, temp_folder: core.Path, file_path: core.Path) -> core.Data:
         path = temp_folder.add(file_path)
         return path.read()
 
@@ -74,7 +72,7 @@ class Repo:
 class GitHandler:
     @staticmethod
     def get_repo_folder() -> core.Path:
-        repo_folder = core.Path.get_documents_folder().add("repos")
+        repo_folder = core.Path.get_data_folder().add("repos")
         repo_folder.generate_dirs()
         return repo_folder
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/core/io/path.py

@@ -74,12 +74,22 @@ class Path:
         return self.path.replace("\\", "/")
 
     @staticmethod
-    def get_documents_folder(app_name: str = "bcsfe") -> Path:
+    def get_data_folder(app_name: str = "bcsfe") -> Path:
         os_name = os.name
         if os_name == "nt":
             path = Path.join(os.environ["USERPROFILE"], "Documents", app_name)
         elif os_name == "posix":
-            path = Path.join(os.environ["HOME"], "Documents", app_name)
+            data_home = os.environ.get("XDG_DATA_HOME")
+            if data_home is None:
+                path = Path.join(os.environ["HOME"], ".local", "share", app_name)
+            else:
+                path = Path.join(data_home, app_name)
+
+            # migrate old data
+            if path.is_empty():
+                orig = Path.join(os.environ["HOME"], "Documents", app_name)
+                orig.copy(path)
+
         elif os_name == "mac":
             path = Path.join(os.environ["HOME"], "Documents", app_name)
         else:
@@ -87,6 +97,41 @@ class Path:
         path.generate_dirs()
         return path
 
+    @staticmethod
+    def get_config_folder(app_name: str = "bcsfe") -> Path:
+        os_name = os.name
+        if os_name != "posix":
+            return Path.get_data_folder()
+
+        data_home = os.environ.get("XDG_CONFIG_HOME")
+        if data_home is None:
+            path = Path.join(os.environ["HOME"], ".config", app_name)
+        else:
+            path = Path.join(data_home, app_name)
+        path.generate_dirs()
+
+        # migrate from old Documents location
+        if path.is_empty():
+            orig = Path.join(os.environ["HOME"], "Documents", app_name, "config.yaml")
+            if orig.exists():
+                orig.copy(path.join("config.yaml"))
+        return path
+
+    @staticmethod
+    def get_state_folder(app_name: str = "bcsfe") -> Path:
+        os_name = os.name
+        if os_name != "posix":
+            return Path.get_data_folder()
+        data_home = os.environ.get("XDG_STATE_HOME")
+        if data_home is None:
+            path = Path.join(os.environ["HOME"], ".local", "state", app_name)
+        else:
+            path = Path.join(data_home, app_name)
+        path.generate_dirs()
+
+        # no need to migrate log file really
+        return path
+
     def is_empty(self) -> bool:
         return self.path == ""
 
@@ -100,11 +145,6 @@ class Path:
                 print(e, self)
         return self
 
-    def create(self) -> Path:
-        if not self.exists():
-            self.write(core.Data("test"))
-        return self
-
     def exists(self) -> bool:
         return os.path.exists(self.path)
 

{bcsfe-3.3.0 → bcsfe-3.4.0}/src/bcsfe/core/io/root_handler.py

@@ -78,7 +78,7 @@ class RootHandler:
         self, local_path: core.Path | None = None
     ) -> tuple[core.Path | None, core.CommandResult]:
         if local_path is None:
-            local_path = core.Path.get_documents_folder().add("saves").add("SAVE_DATA")
+            local_path = core.Path.get_data_folder().add("saves").add("SAVE_DATA")
         local_path.parent().generate_dirs()
         result = self.save_battlecats_save(local_path)
         if not result.success: