bcsfe 3.1.0__tar.gz → 3.2.0__tar.gz

{bcsfe-3.1.0/src/bcsfe.egg-info → bcsfe-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bcsfe
-Version: 3.1.0
+Version: 3.2.0
 Summary: A save file editor for The Battle Cats
 Author: fieryhenry
 License-Expression: GPL-3.0-or-later
@@ -98,7 +98,8 @@ python3 -m pip install bcsfe
 py -m ensurepip --upgrade
 ```
 
-Again change `py` for `python` or `python3` if needed
+Again change `py` for `python` or `python3` if needed. I won't mention this again, so just remember
+the one which works at keep using that.
 
 5. To run the editor, as long as Python is in your PATH, you should be able to run:
 
@@ -112,10 +113,20 @@ bcsfe
 py -m bcsfe
 ```
 
-Again change `py` for `python` or `python3` if needed.
-
 If you are using Windows and you are still struggling, try watching this video [here](https://codeberg.org/fieryhenry/videos/media/branch/main/bcsfe_windows_help.webm).
 
+7. To update the editor run:
+
+```powershell
+py -m pip install -U bcsfe
+```
+
+8. To uninstall the editor run:
+
+```powershell
+py -m pip uninstall bcsfe
+```
+
 ### Linux
 
 1. Install Python 3.9 or later using your system's package manager if you don't already have it
@@ -145,6 +156,18 @@ bcsfe
 6. You may also need to install `tk` with your system package manager to open the
 file selection dialog. This package may be called `tk` or `python-tk` or `python3-tk`.
 
+7. To update the editor if you are using pipx run:
+
+```sh
+pipx upgrade bcsfe
+```
+
+8. To uninstall the editor if you are using pipx run:
+
+```sh
+pipx uninstall bcsfe
+```
+
 If anyone wants to put the editor on the AUR or another package repo, feel free, I'll be happy to
 help if needed.
 
@@ -207,23 +230,84 @@ selection dialog, you just have to type the file path manually.
 For example to save your save file to your downloads directory, the path might look something like
 `/storage/emulated/0/Download/SAVE_DATA` or `/sdcard/Download/SAVE_DATA`
 
+5. To update the editor run:
+
+```sh
+pip install -U bcsfe
+```
+
+Or
+
+```sh
+python -m pip install -U bcsfe
+```
+
+
+5. To uninstall the editor run:
+
+```sh
+pip uninstall bcsfe
+```
+
+Or
+
+```sh
+python -m pip uninstall bcsfe
+```
 
 ### iOS
 
-I do not have an iOS device, so there is no text tutorial, but Viarules has made a video
-tutorial [here](https://www.youtube.com/watch?v=xw-uOqQRYJ8). The video uses iSH which is
-apparently quite slow, and other people recommend using a-Shell instead.
+I do not have an iOS device, so there is no tutorial. The video that was recommended is now outdated.
+But for a general overview of what you need to do:
+
+1. Download a-Shell from the App Store
+2. Install the editor with:
+
+```sh
+pip install bcsfe
+```
+
+3. Run the editor with:
 
+```sh
+bcsfe
+```
+
+Or if that doesn't work try:
 
+```sh
+python -m bcsfe
+```
+
+Or 
+
+```sh
+python3 -m bcsfe
+```
+
+4. To update the editor run:
+
+```sh
+pip install -U bcsfe
+```
+
+5. To uninstall the editor run:
+
+```sh
+pip uninstall bcsfe
+```
 ## Terms of Use
 
+I don't like that I have to have Terms of use but these terms are designed to prevent scams and the
+exploitation of users.
+
 By using the editor you agree to the following:
 
 If you are using the editor to run a paid service that profits off of the editor
 (e.g a service to provide people with hacked accounts, or a paid discord bot to edit people's accounts,
 etc) you must make it very clear that you are using this save editor.
 
-This should be done by linking this GitHub page, and explicitly stating that the tool you are
+This should be done by linking this Codeberg page, and explicitly stating that the tool you are
 using is available for free and that they don't need to use your service to hack their account.
 
 This information needs to be visible and something the customer agrees to **before** any payment is made.
@@ -237,8 +321,6 @@ the editor under the hood as long as you abide by the [License](#license). Basic
 distributing a program which uses the editor, you need to license your own program under the GPL
 or a compatible license (basically make it open source / free software too).
 
-These terms are designed to prevent scams and the exploitation of users.
-
 Also if you **are** profiting from the editor, it would be greatly appreciated if you could
 give back something and support me.
 
@@ -348,9 +430,13 @@ You'll need to collect the catfood in-game after each clear though
 
 ### Install from source
 
-If you want the latest features then you can install the editor from the github.
+If you want the latest features then you can install the editor from the git repo.
 
-1. Download [Git](https://git-scm.com/downloads)
+1. Download git:
+    - Windows: [Git](https://git-scm.com/downloads)
+    - Linux: (use package manager, e.g `sudo apt-get install git` or `sudo pacman -S git`)
+    - Android: Termux: `pkg install git`
+    - iOS: a-Shell should already include it
 
 2. Run the following commands: (You may have to replace `py` with `python` or `python3`)
 
@@ -368,10 +454,12 @@ Alternatively you can use pip directly, although it won't auto-update with the l
 git commits.
 
 ```sh
-py -m pip install git+https://codeberg.org/fieryhenry/BCSFE-Python.git
+py -m pip install -U git+https://codeberg.org/fieryhenry/BCSFE-Python.git
 py -m bcsfe
 ```
 
+Again, you might need change `py` for `python` or `python3`
+
 If you want to use the editor again all you need to do is run the `py -m bcsfe` command
 
 ## Documentation

{bcsfe-3.1.0 → bcsfe-3.2.0}/README.md

@@ -69,7 +69,8 @@ python3 -m pip install bcsfe
 py -m ensurepip --upgrade
 ```
 
-Again change `py` for `python` or `python3` if needed
+Again change `py` for `python` or `python3` if needed. I won't mention this again, so just remember
+the one which works at keep using that.
 
 5. To run the editor, as long as Python is in your PATH, you should be able to run:
 
@@ -83,10 +84,20 @@ bcsfe
 py -m bcsfe
 ```
 
-Again change `py` for `python` or `python3` if needed.
-
 If you are using Windows and you are still struggling, try watching this video [here](https://codeberg.org/fieryhenry/videos/media/branch/main/bcsfe_windows_help.webm).
 
+7. To update the editor run:
+
+```powershell
+py -m pip install -U bcsfe
+```
+
+8. To uninstall the editor run:
+
+```powershell
+py -m pip uninstall bcsfe
+```
+
 ### Linux
 
 1. Install Python 3.9 or later using your system's package manager if you don't already have it
@@ -116,6 +127,18 @@ bcsfe
 6. You may also need to install `tk` with your system package manager to open the
 file selection dialog. This package may be called `tk` or `python-tk` or `python3-tk`.
 
+7. To update the editor if you are using pipx run:
+
+```sh
+pipx upgrade bcsfe
+```
+
+8. To uninstall the editor if you are using pipx run:
+
+```sh
+pipx uninstall bcsfe
+```
+
 If anyone wants to put the editor on the AUR or another package repo, feel free, I'll be happy to
 help if needed.
 
@@ -178,23 +201,84 @@ selection dialog, you just have to type the file path manually.
 For example to save your save file to your downloads directory, the path might look something like
 `/storage/emulated/0/Download/SAVE_DATA` or `/sdcard/Download/SAVE_DATA`
 
+5. To update the editor run:
+
+```sh
+pip install -U bcsfe
+```
+
+Or
+
+```sh
+python -m pip install -U bcsfe
+```
+
+
+5. To uninstall the editor run:
+
+```sh
+pip uninstall bcsfe
+```
+
+Or
+
+```sh
+python -m pip uninstall bcsfe
+```
 
 ### iOS
 
-I do not have an iOS device, so there is no text tutorial, but Viarules has made a video
-tutorial [here](https://www.youtube.com/watch?v=xw-uOqQRYJ8). The video uses iSH which is
-apparently quite slow, and other people recommend using a-Shell instead.
+I do not have an iOS device, so there is no tutorial. The video that was recommended is now outdated.
+But for a general overview of what you need to do:
+
+1. Download a-Shell from the App Store
+2. Install the editor with:
+
+```sh
+pip install bcsfe
+```
+
+3. Run the editor with:
 
+```sh
+bcsfe
+```
+
+Or if that doesn't work try:
 
+```sh
+python -m bcsfe
+```
+
+Or 
+
+```sh
+python3 -m bcsfe
+```
+
+4. To update the editor run:
+
+```sh
+pip install -U bcsfe
+```
+
+5. To uninstall the editor run:
+
+```sh
+pip uninstall bcsfe
+```
 ## Terms of Use
 
+I don't like that I have to have Terms of use but these terms are designed to prevent scams and the
+exploitation of users.
+
 By using the editor you agree to the following:
 
 If you are using the editor to run a paid service that profits off of the editor
 (e.g a service to provide people with hacked accounts, or a paid discord bot to edit people's accounts,
 etc) you must make it very clear that you are using this save editor.
 
-This should be done by linking this GitHub page, and explicitly stating that the tool you are
+This should be done by linking this Codeberg page, and explicitly stating that the tool you are
 using is available for free and that they don't need to use your service to hack their account.
 
 This information needs to be visible and something the customer agrees to **before** any payment is made.
@@ -208,8 +292,6 @@ the editor under the hood as long as you abide by the [License](#license). Basic
 distributing a program which uses the editor, you need to license your own program under the GPL
 or a compatible license (basically make it open source / free software too).
 
-These terms are designed to prevent scams and the exploitation of users.
-
 Also if you **are** profiting from the editor, it would be greatly appreciated if you could
 give back something and support me.
 
@@ -319,9 +401,13 @@ You'll need to collect the catfood in-game after each clear though
 
 ### Install from source
 
-If you want the latest features then you can install the editor from the github.
+If you want the latest features then you can install the editor from the git repo.
 
-1. Download [Git](https://git-scm.com/downloads)
+1. Download git:
+    - Windows: [Git](https://git-scm.com/downloads)
+    - Linux: (use package manager, e.g `sudo apt-get install git` or `sudo pacman -S git`)
+    - Android: Termux: `pkg install git`
+    - iOS: a-Shell should already include it
 
 2. Run the following commands: (You may have to replace `py` with `python` or `python3`)
 
@@ -339,10 +425,12 @@ Alternatively you can use pip directly, although it won't auto-update with the l
 git commits.
 
 ```sh
-py -m pip install git+https://codeberg.org/fieryhenry/BCSFE-Python.git
+py -m pip install -U git+https://codeberg.org/fieryhenry/BCSFE-Python.git
 py -m bcsfe
 ```
 
+Again, you might need change `py` for `python` or `python3`
+
 If you want to use the editor again all you need to do is run the `py -m bcsfe` command
 
 ## Documentation

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.1.0"
+__version__ = "3.2.0"
 
 from bcsfe import core, cli
 

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/__main__.py

@@ -52,7 +52,9 @@ def main():
         cli.main.Main.leave()
     except Exception as e:
         tb = traceback.format_exc()
-        cli.color.ColoredText.localize("error", error=e, traceback=tb)
+        cli.color.ColoredText.localize(
+            "error", error=e, version=bcsfe.__version__, traceback=tb
+        )
         try:
             cli.main.Main.exit_editor()
         except Exception:

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/color.py

@@ -113,13 +113,9 @@ class ColoredText:
                 print(colored.stylize(text, fg), end="")  # type: ignore
 
     @staticmethod
-    def localize(
-        string: str, escape: bool = True, **kwargs: Any
-    ) -> ColoredText:
+    def localize(string: str, escape: bool = True, **kwargs: Any) -> ColoredText:
         return ColoredText(
-            core.core_data.local_manager.get_key(
-                string, escape=escape, **kwargs
-            )
+            core.core_data.local_manager.get_key(string, escape=escape, **kwargs)
         )
 
     def parse(self, txt: str) -> list[tuple[str, str]]:
@@ -134,11 +130,7 @@ class ColoredText:
         special_chars = core.LocalManager.get_special_chars()
         while i < len(txt):
             char = txt[i]
-            if (
-                char == "\\"
-                and i + 1 < len(txt)
-                and txt[i + 1] in special_chars
-            ):
+            if char == "\\" and i + 1 < len(txt) and txt[i + 1] in special_chars:
                 i += 1
                 char = txt[i]
                 text += char
@@ -183,7 +175,5 @@ class ColoredInput:
         return input()
 
     def localize(self, string: str, escape: bool = True, **kwargs: Any) -> str:
-        text = core.core_data.local_manager.get_key(
-            string, escape=escape, **kwargs
-        )
+        text = core.core_data.local_manager.get_key(string, escape=escape, **kwargs)
         return self.get(text)

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/dialog_creator.py

@@ -327,7 +327,7 @@ class ChoiceInput:
         dialog = core.core_data.local_manager.get_key(key).format(
             min=self.get_min_value(), max=self.get_max_value()
         )
-        usr_input = color.ColoredInput().get(dialog).split(" ")
+        usr_input = color.ColoredInput().get(dialog).strip().split(" ")
         int_vals: list[int] = []
         for inp in usr_input:
             try:
@@ -689,7 +689,11 @@ class YesNoInput:
 
         if usr_input == core.core_data.local_manager.get_key("quit_key"):
             return None
-        return usr_input == core.core_data.local_manager.get_key("yes_key")
+        return (
+            usr_input == core.core_data.local_manager.get_key("yes_key")
+            or usr_input.lower().strip()
+            == core.core_data.local_manager.get_key("yes").lower().strip()
+        )
 
 
 class DialogBuilder:

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/edits/__init__.py

@@ -9,6 +9,7 @@ from bcsfe.cli.edits import (
     map,
     event_tickets,
     max_all,
+    storage,
 )
 
 __all__ = [
@@ -22,4 +23,5 @@ __all__ = [
     "map",
     "event_tickets",
     "max_all",
+    "storage",
 ]

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/edits/basic_items.py

@@ -12,6 +12,12 @@ class BasicItems:
             return core.core_data.local_manager.get_key(key)
         return name.strip()
 
+    @staticmethod
+    def reset_golden_cat_cpus(save_file: core.SaveFile):
+        save_file.golden_cpu_count = 0
+
+        color.ColoredText.localize("reset_golden_cat_cpus_success")
+
     @staticmethod
     def edit_catfood(save_file: core.SaveFile):
         should_exit = not dialog_creator.YesNoInput().get_input_once("catfood_warning")

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/edits/cat_editor.py

@@ -48,7 +48,6 @@ class CatEditor:
         if len(current_cats) > 50:
             color.ColoredText.localize("total_selected_cats", total=len(current_cats))
         else:
-            self.save_file.cats.bulk_download_names(self.save_file, current_cats)
             for cat in current_cats:
                 names = cat.get_names_cls(self.save_file)
                 if not names:
@@ -56,9 +55,8 @@ class CatEditor:
                 color.ColoredText.localize("selected_cat", id=cat.id, name=names[0])
 
     def select(
-        self,
-        current_cats: list[core.Cat] | None = None,
-    ) -> list[core.Cat] | None:
+        self, current_cats: list[core.Cat] | None = None, finish_option: bool = True
+    ) -> tuple[list[core.Cat], bool]:
         if current_cats is None:
             current_cats = []
         options: dict[str, Callable[[], Any]] = {
@@ -72,19 +70,25 @@ class CatEditor:
             "select_cats_not_unlocked": self.get_non_unlocked_cats,
             "select_cats_not_obtainable": self.get_cats_unobtainable,
             "select_cats_non_gatya": self.get_non_gacha_cats,
+            "select_cats_game_version": self.select_cats_game_version,
         }
+        if finish_option:
+            options["finish"] = lambda: None
         option_id = dialog_creator.ChoiceInput(
             list(options), list(options), [], {}, "select_cats", True
         ).single_choice()
         if option_id is None:
-            return current_cats
+            return current_cats, False
         option_id -= 1
 
+        if option_id == len(options) - 1 and finish_option:
+            return current_cats, True
+
         func = options[list(options)[option_id]]
         new_cats = func()
 
         if new_cats is None:
-            return None
+            return current_cats, False
 
         if current_cats:
             mode_id = dialog_creator.IntInput().get_basic_input_locale("and_mode_q", {})
@@ -102,12 +106,12 @@ class CatEditor:
             mode = SelectMode.OR
 
         if mode == SelectMode.AND:
-            return list(set(current_cats) & set(new_cats))
+            return list(set(current_cats) & set(new_cats)), False
         if mode == SelectMode.OR:
-            return list(set(current_cats) | set(new_cats))
+            return list(set(current_cats) | set(new_cats)), False
         if mode == SelectMode.REPLACE:
-            return new_cats
-        return new_cats
+            return new_cats, False
+        return new_cats, False
 
     def select_id(self) -> list[core.Cat] | None:
         cat_ids = dialog_creator.RangeInput(
@@ -117,6 +121,78 @@ class CatEditor:
             return None
         return self.save_file.cats.get_cats_by_ids(cat_ids)
 
+    def select_cats_game_version(self) -> list[core.Cat] | None:
+        unitbuy = core.UnitBuy(self.save_file)
+        if unitbuy.unit_buy is None:
+            return None
+
+        versions_set: set[int] = set()
+        for cat in unitbuy.unit_buy:
+            if cat.game_version == -1:
+                continue
+            versions_set.add(cat.game_version)
+
+        if not versions_set:
+            return None
+
+        versions = list(versions_set)
+        versions.sort()
+
+        color.ColoredText.localize("possible_gvs")
+
+        cur_major_v = -1
+        for version in versions:
+            gv = core.GameVersion(version)
+            major_v = gv.get_parts()[0]
+            if major_v != cur_major_v:
+                if cur_major_v != -1:
+                    print()
+                cur_major_v = major_v
+            else:
+                color.ColoredText(", ", end="")
+            color.ColoredText(f"<@t>{gv.format()}</>", end="")
+
+        print()
+
+        usr_input = dialog_creator.StringInput().get_input_locale("select_gv")
+        if usr_input is None:
+            return None
+        chunks = usr_input.split(" ")
+
+        versions_selected: list[int] = []
+        for chunk in chunks:
+            parts = chunk.split("-")
+            if len(parts) == 2:
+                min = parts[0]
+                max = parts[1]
+
+                v1 = core.GameVersion.from_string(min)
+                v2 = core.GameVersion.from_string(max)
+
+                for v in range(v1.game_version, v2.game_version + 1):
+                    versions_selected.append(v)
+            else:
+                v = core.GameVersion.from_string(chunk)
+                versions_selected.append(v.game_version)
+
+        valid_versions: set[int] = set()
+        for version in versions_selected:
+            if version in versions_set:
+                valid_versions.add(version)
+
+        if not valid_versions:
+            color.ColoredText.localize("no_valid_gvs_entered")
+
+        cats: list[core.Cat] = []
+        for cat in self.save_file.cats.cats:
+            row = unitbuy.get_unit_buy(cat.id)
+            if row is None:
+                continue
+            if row.game_version in valid_versions:
+                cats.append(cat)
+
+        return cats
+
     def select_rarity(self) -> list[core.Cat] | None:
         rarity_names = self.save_file.cats.get_rarity_names(self.save_file)
         rarity_ids, _ = dialog_creator.ChoiceInput(
@@ -639,11 +715,12 @@ class CatEditor:
         stop = False
         cats = []
         while not stop:
-            current_cats = cat_editor.select(cats)
-            if current_cats is None:
-                return None, []
+            current_cats, finished = cat_editor.select(cats)
             cats = current_cats
             cat_editor.print_selected_cats(cats)
+            if finished:
+                stop = True
+                continue
             finished = dialog_creator.YesNoInput().get_input_once(
                 "finished_cats_selection"
             )
@@ -682,9 +759,7 @@ class CatEditor:
             return False, cats
         option_id -= 1
         if option_id == 0:
-            cats_ = self.select(cats)
-            if cats_ is None:
-                return False, cats
+            cats_, _ = self.select(cats, False)
             cats = cats_
         elif option_id == 1:
             self.unlock_remove_cats_run(self.save_file, cats, self)

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/edits/event_tickets.py

@@ -20,7 +20,8 @@ class EventTickets:
         )
 
         cli.color.ColoredText.localize("downloading_gatya_data")
-        gatya_event_data = core.ServerHandler(self.save_file).download_gatya_data()
+        temp_save_file = core.SaveFile(cc=save_file.cc, gv=save_file.game_version)
+        gatya_event_data = core.ServerHandler(temp_save_file).download_gatya_data()
 
         if gatya_event_data is None:
             cli.color.ColoredText.localize("download_gatya_data_fail")

{bcsfe-3.1.0 → bcsfe-3.2.0}/src/bcsfe/cli/edits/map.py

@@ -92,8 +92,12 @@ def edit_chapters(
     chapters: ChaptersType,
     letter_code: str,
     type: int | None = None,
+    no_r_prefix: bool = False,
+    base_index: int | None = None,
 ) -> dict[int, bool] | None:
-    map_names = core.MapNames(save_file, letter_code)
+    map_names = core.MapNames(
+        save_file, letter_code, no_r_prefix=no_r_prefix, base_index=base_index
+    )
     names = map_names.map_names
 
     choice = dialog_creator.ChoiceInput.from_reduced(