bcsfe 3.2.0b2__tar.gz → 3.2.0b3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bcsfe
-Version: 3.2.0b2
+Version: 3.2.0b3
 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,14 +230,72 @@ 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
 
 By using the editor you agree to the following:
@@ -350,7 +431,11 @@ You'll need to collect the catfood in-game after each clear though
 
 If you want the latest features then you can install the editor from the github.
 
-1. Download [Git](https://git-scm.com/downloads)
+1. Download git:
+    1. Windows: [Git](https://git-scm.com/downloads)
+    2. Linux: (use package manager, e.g `sudo apt-get install git` or `sudo pacman -S git`)
+    3. Android: Termux: `pkg install git`
+    4. iOS: a-Shell should already include it
 
 2. Run the following commands: (You may have to replace `py` with `python` or `python3`)
 

{bcsfe-3.2.0b2 → bcsfe-3.2.0b3}/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,14 +201,72 @@ 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
 
 By using the editor you agree to the following:
@@ -321,7 +402,11 @@ You'll need to collect the catfood in-game after each clear though
 
 If you want the latest features then you can install the editor from the github.
 
-1. Download [Git](https://git-scm.com/downloads)
+1. Download git:
+    1. Windows: [Git](https://git-scm.com/downloads)
+    2. Linux: (use package manager, e.g `sudo apt-get install git` or `sudo pacman -S git`)
+    3. Android: Termux: `pkg install git`
+    4. iOS: a-Shell should already include it
 
 2. Run the following commands: (You may have to replace `py` with `python` or `python3`)
 

{bcsfe-3.2.0b2 → bcsfe-3.2.0b3}/src/bcsfe/__init__.py

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

{bcsfe-3.2.0b2 → bcsfe-3.2.0b3}/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.2.0b2 → bcsfe-3.2.0b3}/src/bcsfe/cli/edits/cat_editor.py

@@ -55,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]] = {
@@ -71,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", {})
@@ -101,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(
@@ -116,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(
@@ -638,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"
             )
@@ -681,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.2.0b3/src/bcsfe/cli/edits/storage.py

@@ -0,0 +1,214 @@
+from __future__ import annotations
+from bcsfe import core
+from bcsfe.cli import color, dialog_creator
+from bcsfe.cli.edits import cat_editor
+
+
+def display_storage(save_file: core.SaveFile, storage: list[core.StorageItem]):
+    color.ColoredText.localize("current_storage_items")
+    index = 0
+    for item in storage:
+        if item.item_type == 0:
+            continue
+
+        index += 1
+        color.ColoredText(f"{index}. ", end="")
+        display_item(item, save_file)
+
+    if index == 0:
+        color.ColoredText.localize("storage_is_empty")
+
+    available_slots = len(storage) - index
+
+    color.ColoredText.localize("available_storage", slots=available_slots)
+
+
+def display_item(item: core.StorageItem, save_file: core.SaveFile):
+    color.ColoredText(get_item_str(item, save_file))
+
+
+def get_item_str(item: core.StorageItem, save_file: core.SaveFile) -> str:
+    if item.item_type == 1:
+        cat_id = item.item_id
+        names = core.Cat.get_names(cat_id, save_file)
+
+        if not names:
+            names = [str(cat_id)]
+
+        return core.localize("cat", name=names[0], id=cat_id)
+    elif item.item_type == 2:
+        skill_id = item.item_id
+
+        skill_names = (
+            core.core_data.get_gatya_item_buy(save_file).get_names_by_category(
+                core.GatyaItemCategory.SPECIAL_SKILLS
+            )
+            or []
+        )
+
+        if skill_id >= len(skill_names) or skill_id < 0:
+            name = str(skill_id)
+        else:
+            name = skill_names[skill_id][1]
+
+        return core.localize("special_skill", name=name, id=skill_id)
+    elif item.item_type == 3:
+        item_id = item.item_id
+
+        name = core.core_data.get_gatya_item_names(save_file).get_name(item_id)
+        if name is None:
+            name = str(item_id)
+
+        return core.localize("item", name=name, id=item_id)
+    else:
+        return core.localize(
+            "unrecognised_storage_item", item_type=item.item_type, id=item.item_id
+        )
+
+
+def clear_storage(storage: list[core.StorageItem]):
+    for item in storage:
+        item.item_id = 0
+        item.item_type = 0
+
+
+def add_item(storage: list[core.StorageItem], item: core.StorageItem) -> bool:
+    for citem in storage:
+        if citem.item_type == 0:
+            citem.item_type = item.item_type
+            citem.item_id = item.item_id
+            return True
+    return False
+
+
+def get_storage_space(storage: list[core.StorageItem]) -> int:
+    space = 0
+
+    for item in storage:
+        if item.item_type == 0:
+            space += 1
+    return space
+
+
+def edit_storage(save_file: core.SaveFile):
+    display_storage(save_file, save_file.cats.storage_items)
+    exit = False
+    while not exit:
+        exit = edit_loop(save_file)
+
+    color.ColoredText.localize("storage_success")
+
+
+def edit_loop(save_file: core.SaveFile) -> bool:
+    storage = save_file.cats.storage_items
+
+    options = [
+        "display_storage",
+        "clear_storage",
+        "add_cats",
+        "add_special_skills",
+        "remove_items",
+        "finish",
+    ]
+
+    choice = dialog_creator.ChoiceInput.from_reduced(
+        options, dialog="select_option"
+    ).single_choice()
+    if choice is None:
+        return False
+
+    choice -= 1
+
+    if choice == 0:
+        display_storage(save_file, storage)
+    if choice == 1:
+        clear_storage(storage)
+    elif choice == 2:
+        editor, cats = cat_editor.CatEditor.from_save_file(save_file)
+        if editor is None:
+            return False
+
+        space = get_storage_space(storage)
+        if len(cats) > len(storage):
+            color.ColoredText.localize(
+                "too_many_cats_selected", max=len(storage), current=len(cats)
+            )
+            return False
+
+        needs = len(cats) - space
+        if needs > 0:
+            color.ColoredText.localize("need_x_more_space", needs=needs)
+            return False
+
+        color.ColoredText.localize("added_cats")
+        for cat in cats:
+            item = core.StorageItem.from_cat(cat.id)
+            add_item(storage, item)
+            display_item(item, save_file)
+    elif choice == 3:
+
+        skill_names: list[str] = list(
+            map(
+                lambda sk: sk[1] or str(sk[0].id),
+                core.core_data.get_gatya_item_buy(save_file).get_names_by_category(
+                    core.GatyaItemCategory.SPECIAL_SKILLS
+                )
+                or [],
+            )
+        )
+
+        options, _ = dialog_creator.ChoiceInput.from_reduced(
+            skill_names, localize_options=False, dialog="select_special_skills"
+        ).multiple_choice(False)
+
+        if options is None:
+            return False
+
+        space = get_storage_space(storage)
+        if len(options) > len(storage):
+            color.ColoredText.localize(
+                "too_many_skills_selected", max=len(storage), current=len(options)
+            )
+            return False
+
+        needs = len(options) - space
+        if needs > 0:
+            color.ColoredText.localize("need_x_more_space", needs=needs)
+            return False
+
+        color.ColoredText.localize("added_special_skills")
+        for choice in options:
+            item = core.StorageItem.from_special_skill(choice)
+            add_item(storage, item)
+            display_item(item, save_file)
+
+    elif choice == 4:
+        options2: list[str] = []
+        for item in storage:
+            if item.item_type == 0:
+                continue
+            options2.append(get_item_str(item, save_file))
+
+        choices, _ = dialog_creator.ChoiceInput.from_reduced(
+            options2, localize_options=False
+        ).multiple_choice(False)
+        if choices is None:
+            return False
+
+        color.ColoredText.localize("removed_items")
+        index = 0
+        for item in storage:
+            if item.item_type == 0:
+                continue
+
+            if index in choices:
+                display_item(item, save_file)
+                item.item_type = 0
+                item.item_id = 0
+
+            index += 1
+
+    elif choice == 5:
+        return True
+
+    return False

{bcsfe-3.2.0b2 → bcsfe-3.2.0b3}/src/bcsfe/cli/feature_handler.py

@@ -26,6 +26,8 @@ class FeatureHandler:
             edits.basic_items.BasicItems.edit_special_skills
         )
 
+        cat_features["cat_storage"] = edits.storage.edit_storage
+
         features: dict[str, Any] = {
             "save_management": {
                 "save_save": save_management.SaveManagement.save_save,
@@ -217,7 +219,7 @@ class FeatureHandler:
                     return list(self.get_features().keys())
                 feature = self.get_feature(feature_name_top)
                 if isinstance(feature, dict):
-                    for feature_name in feature.keys():
+                    for feature_name in feature.keys():  # type: ignore
                         feature_path = (
                             f"{parent_path}.{feature_name_top}.{feature_name}"
                             if parent_path