bcsfe 3.2.2__tar.gz → 3.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bcsfe
-Version: 3.2.2
+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.2.2 → 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.2.2 → bcsfe-3.4.0}/src/bcsfe/__init__.py

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

{bcsfe-3.2.2 → 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.2.2 → bcsfe-3.4.0}/src/bcsfe/cli/__init__.py

@@ -7,6 +7,7 @@ from bcsfe.cli import (
     save_management,
     server_cli,
     edits,
+    recent_saves,
 )
 
 __all__ = [
@@ -18,4 +19,5 @@ __all__ = [
     "save_management",
     "server_cli",
     "edits",
+    "recent_saves",
 ]

{bcsfe-3.2.2 → bcsfe-3.4.0}/src/bcsfe/cli/dialog_creator.py

@@ -73,16 +73,25 @@ class IntInput:
         default: int | None = None,
         signed: bool = True,
         bit_count: int = 32,
+        ensure_max: bool = False,
     ):
         self.signed = signed
         self.bit_count = bit_count
-        self.max = self.get_max_value(max, signed, bit_count)
+        self.max = self.get_max_value(max, signed, bit_count, ensure_max)
         self.min = min
         self.default = default
 
     @staticmethod
-    def get_max_value(max: int | None, signed: bool = True, bit_count: int = 32) -> int:
-        disable_maxes = core.core_data.config.get_bool(core.ConfigKey.DISABLE_MAXES)
+    def get_max_value(
+        max: int | None,
+        signed: bool = True,
+        bit_count: int = 32,
+        ensure_max: bool = False,
+    ) -> int:
+        disable_maxes = (
+            core.core_data.config.get_bool(core.ConfigKey.DISABLE_MAXES)
+            and not ensure_max
+        )
         if signed:
             bit_count -= 1
         max_int = (2**bit_count) - 1
@@ -273,9 +282,9 @@ class ChoiceInput:
             start_index=self.start_index,
             localize_elements=self.localize_options,
         ).display_locale(self.remove_alias)
-        return IntInput(self.get_max_value(), self.get_min_value()).get_input_locale(
-            self.dialog, self.perameters
-        )
+        return IntInput(
+            self.get_max_value(), self.get_min_value(), ensure_max=True
+        ).get_input_locale(self.dialog, self.perameters)
 
     def get_input_while(self) -> int | None:
         if len(self.strings) == 0:

{bcsfe-3.2.2 → 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.2.2 → 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.2.2 → 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.2.2 → bcsfe-3.4.0}/src/bcsfe/cli/main.py

@@ -40,6 +40,26 @@ class Main:
             if stop:
                 break
 
+    def version_check(self, v1: str, v2: str) -> bool:
+        v1_p = v1.split(".")
+        v2_p = v2.split(".")
+
+        for p1, p2 in zip(v1_p, v2_p):
+            if p1.isdigit():
+                p1 = int(p1)
+            else:
+                continue
+            if p2.isdigit():
+                p2 = int(p2)
+            else:
+                continue
+            if p1 > p2:
+                return True
+            if p1 < p2:
+                return False
+
+        return len(v1_p) > len(v2_p)
+
     def check_update(self):
         """Check for updates."""
 
@@ -64,16 +84,19 @@ class Main:
         local_no_beta = local_version.split("b")[0]
         latest_no_beta = latest_version.split("b")[0]
 
-        if latest_no_beta > local_no_beta:
+        if self.version_check(latest_no_beta, local_no_beta):
             update_needed = True
-        elif latest_no_beta < local_no_beta:
+        elif self.version_check(local_no_beta, latest_no_beta):
             update_needed = False
         else:
             if latest_version == local_version:
                 update_needed = False
             else:
                 if is_local_beta and is_latest_beta:
-                    update_needed = latest_version > local_version
+                    update_needed = self.version_check(
+                        latest_version.replace("b", "."),
+                        local_version.replace("b", "."),
+                    )
                 elif is_local_beta:
                     update_needed = True
                 else:
@@ -168,6 +191,15 @@ class Main:
             return stop
         self.save_file = save_file
 
+        color.ColoredText.localize(
+            "current_save",
+            inquiry_code=save_file.inquiry_code[:4]
+            + "***"
+            + save_file.inquiry_code[-2:],
+            gv=save_file.game_version,
+            cc=save_file.cc,
+        )
+
         self.feature_handler()
         return False
 
@@ -259,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.4.0/src/bcsfe/cli/recent_saves.py

@@ -0,0 +1,144 @@
+from __future__ import annotations
+from typing import Any
+
+from bcsfe import core
+import datetime
+import json
+from bcsfe.cli import color, dialog_creator
+
+
+class RecentSave:
+    def __init__(
+        self,
+        path: core.Path,
+        cc: core.CountryCode,
+        gv: core.GameVersion,
+        inquiry: str,
+        time: datetime.datetime,
+        name: core.Path,
+    ):
+        self.path = path
+        self.cc = cc
+        self.gv = gv
+        self.inquiry = inquiry
+        self.time = time
+        self.name = name
+
+    @staticmethod
+    def from_dict(data: dict[str, Any]) -> RecentSave | None:
+        path = data.get("path")
+        cc = data.get("cc")
+        gv = data.get("gv")
+        inquiry = data.get("inquiry")
+        time_stamp = data.get("timestamp")
+        name = data.get("name")
+        if (
+            path is None
+            or cc is None
+            or gv is None
+            or inquiry is None
+            or time_stamp is None
+            or name is None
+        ):
+            return None
+
+        return RecentSave(
+            core.Path(path),
+            core.CountryCode(cc),
+            core.GameVersion.from_string(gv),
+            inquiry,
+            datetime.datetime.fromtimestamp(time_stamp),
+            core.Path(name),
+        )
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            "path": self.path.to_str(),
+            "cc": self.cc.get_code(),
+            "gv": self.gv.to_string(),
+            "inquiry": self.inquiry,
+            "timestamp": self.time.timestamp(),
+            "name": self.name.to_str(),
+        }
+
+
+class RecentSaves:
+    def __init__(self, saves: list[RecentSave]):
+        self.saves = saves
+
+    @staticmethod
+    def from_json(data: list[dict[str, Any]]) -> RecentSaves:
+        res: list[RecentSave] = []
+
+        for item in data:
+            save = RecentSave.from_dict(item)
+            if save is not None:
+                res.append(save)
+
+        return RecentSaves(res)
+
+    def to_json(self) -> list[dict[str, Any]]:
+        return [save.to_dict() for save in self.saves][-10:]  # only store 10
+
+    @staticmethod
+    def from_path(path: core.Path) -> RecentSaves | None:
+        json_data = json.loads(path.read().to_str())
+
+        return RecentSaves.from_json(json_data)
+
+    def to_path(self, path: core.Path):
+        data = json.dumps(self.to_json(), indent=4)
+
+        try:
+            path.write(core.Data(data))
+        except Exception as e:
+            print(e)
+
+    @staticmethod
+    def read_default() -> RecentSaves:
+        path = RecentSaves.get_path()
+        if path.exists():
+            return RecentSaves.from_path(path) or RecentSaves([])
+        return RecentSaves([])
+
+    @staticmethod
+    def get_path() -> core.Path:
+        return core.Path.get_data_folder().add("recent_saves.json")
+
+    def save_default(self):
+        path = RecentSaves.get_path()
+        self.to_path(path)
+
+    def select(self) -> RecentSave | None:
+        if not self.saves:
+            color.ColoredText.localize("no_recent_saves")
+            return None
+        items: list[str] = []
+        for save in self.saves:
+            items.append(
+                core.localize(
+                    "recent_save",
+                    path=save.path,
+                    cc=save.cc,
+                    gv=save.gv,
+                    inquiry_code=save.inquiry,
+                    year=save.time.year,
+                    month=str(save.time.month).zfill(2),
+                    day=str(save.time.day).zfill(2),
+                    hour=str(save.time.hour).zfill(2),
+                    minute=str(save.time.minute).zfill(2),
+                    second=str(save.time.second).zfill(2),
+                    name=save.name,
+                )
+            )
+        items.reverse()
+
+        resp = dialog_creator.ChoiceInput.from_reduced(
+            items, localize_options=False, dialog="select_recent"
+        ).single_choice()
+        if resp is None:
+            return None
+
+        resp = len(self.saves) - resp
+
+        return self.saves[resp]