bcsfe 3.0.1__tar.gz → 3.2.0__tar.gz

{bcsfe-3.0.1 → bcsfe-3.2.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: bcsfe
-Version: 3.0.1
+Version: 3.2.0
 Summary: A save file editor for The Battle Cats
 Author: fieryhenry
 License-Expression: GPL-3.0-or-later
-Project-URL: Homepage, https://github.com/fieryhenry/BCSFE-Python
-Project-URL: Repository, https://github.com/fieryhenry/BCSFE-Python
-Project-URL: Issues, https://github.com/fieryhenry/BCSFE-Python/issues
-Project-URL: Changelog, https://github.com/fieryhenry/BCSFE-Python/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://codeberg.org/fieryhenry/BCSFE-Python
+Project-URL: Repository, https://codeberg.org/fieryhenry/BCSFE-Python
+Project-URL: Issues, https://codeberg.org/fieryhenry/BCSFE-Python/issues
+Project-URL: Changelog, https://codeberg.org/fieryhenry/BCSFE-Python/raw/branch/main/CHANGELOG.md
 Keywords: battle cats,save editor,hacking
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: End Users/Desktop
@@ -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,9 +113,19 @@ 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).
 
-If you are using Windows and you are still struggling, try watching this video [here](https://youtu.be/ypmT39jqZrg).
+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
 
@@ -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,14 +430,18 @@ 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`)
 
 ```sh
-git clone https://github.com/fieryhenry/BCSFE-Python.git
+git clone https://codeberg.org/fieryhenry/BCSFE-Python.git
 cd BCSFE-Python
 py -m pip install -e .
 py -m bcsfe
@@ -368,16 +454,18 @@ Alternatively you can use pip directly, although it won't auto-update with the l
 git commits.
 
 ```sh
-py -m pip install git+https://github.com/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
 
-- [Custom Editor Locales](https://github.com/fieryhenry/ExampleEditorLocale)
-- [Custom Editor Themes](https://github.com/fieryhenry/ExampleEditorTheme)
+- [Custom Editor Locales](https://codeberg.org/fieryhenry/ExampleEditorLocale)
+- [Custom Editor Themes](https://codeberg.org/fieryhenry/ExampleEditorTheme)
 
 I only have documentation for the locales and themes atm, but I will probably
 add more documentation in the future.
@@ -390,6 +478,8 @@ discussion in #dev-chat, or create an issue in this repo, or a draft pull reques
 If you need help with reverse engineering the save file, I have a basic starting guide here:
 <https://codeberg.org/fieryhenry/bc_ree>.
 
+If you want to localize the editor see [here](./LOCALIZATION.md).
+
 ## License
 
 BCSFE is licensed under the GNU GPLv3 which can be read [here](https://www.gnu.org/licenses/gpl-3.0.en.html).

bcsfe-3.0.1/src/bcsfe.egg-info/PKG-INFO → bcsfe-3.2.0/README.md

@@ -1,32 +1,3 @@
-Metadata-Version: 2.4
-Name: bcsfe
-Version: 3.0.1
-Summary: A save file editor for The Battle Cats
-Author: fieryhenry
-License-Expression: GPL-3.0-or-later
-Project-URL: Homepage, https://github.com/fieryhenry/BCSFE-Python
-Project-URL: Repository, https://github.com/fieryhenry/BCSFE-Python
-Project-URL: Issues, https://github.com/fieryhenry/BCSFE-Python/issues
-Project-URL: Changelog, https://github.com/fieryhenry/BCSFE-Python/blob/master/CHANGELOG.md
-Keywords: battle cats,save editor,hacking
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Topic :: Utilities
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: aenum
-Requires-Dist: colored==1.4.4
-Requires-Dist: pyjwt
-Requires-Dist: requests
-Requires-Dist: pyyaml
-Requires-Dist: beautifulsoup4
-Requires-Dist: argparse
-Dynamic: license-file
-
 # Battle Cats Save File Editor
 
 [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/fieryhenry)
@@ -98,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:
 
@@ -112,9 +84,19 @@ 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:
 
-If you are using Windows and you are still struggling, try watching this video [here](https://youtu.be/ypmT39jqZrg).
+```powershell
+py -m pip uninstall bcsfe
+```
 
 ### Linux
 
@@ -145,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.
 
@@ -207,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.
@@ -237,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.
 
@@ -348,14 +401,18 @@ 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`)
 
 ```sh
-git clone https://github.com/fieryhenry/BCSFE-Python.git
+git clone https://codeberg.org/fieryhenry/BCSFE-Python.git
 cd BCSFE-Python
 py -m pip install -e .
 py -m bcsfe
@@ -368,16 +425,18 @@ Alternatively you can use pip directly, although it won't auto-update with the l
 git commits.
 
 ```sh
-py -m pip install git+https://github.com/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
 
-- [Custom Editor Locales](https://github.com/fieryhenry/ExampleEditorLocale)
-- [Custom Editor Themes](https://github.com/fieryhenry/ExampleEditorTheme)
+- [Custom Editor Locales](https://codeberg.org/fieryhenry/ExampleEditorLocale)
+- [Custom Editor Themes](https://codeberg.org/fieryhenry/ExampleEditorTheme)
 
 I only have documentation for the locales and themes atm, but I will probably
 add more documentation in the future.
@@ -390,6 +449,8 @@ discussion in #dev-chat, or create an issue in this repo, or a draft pull reques
 If you need help with reverse engineering the save file, I have a basic starting guide here:
 <https://codeberg.org/fieryhenry/bc_ree>.
 
+If you want to localize the editor see [here](./LOCALIZATION.md).
+
 ## License
 
 BCSFE is licensed under the GNU GPLv3 which can be read [here](https://www.gnu.org/licenses/gpl-3.0.en.html).

{bcsfe-3.0.1 → bcsfe-3.2.0}/pyproject.toml

@@ -30,10 +30,10 @@ dynamic = ["version"]
 keywords = ["battle cats", "save editor", "hacking"]
 
 [project.urls]
-Homepage = "https://github.com/fieryhenry/BCSFE-Python"
-Repository = "https://github.com/fieryhenry/BCSFE-Python"
-Issues = "https://github.com/fieryhenry/BCSFE-Python/issues"
-Changelog = "https://github.com/fieryhenry/BCSFE-Python/blob/master/CHANGELOG.md"
+Homepage = "https://codeberg.org/fieryhenry/BCSFE-Python"
+Repository = "https://codeberg.org/fieryhenry/BCSFE-Python"
+Issues = "https://codeberg.org/fieryhenry/BCSFE-Python/issues"
+Changelog = "https://codeberg.org/fieryhenry/BCSFE-Python/raw/branch/main/CHANGELOG.md"
 
 [tool.setuptools.dynamic]
 version = { attr = "bcsfe.__version__" }

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

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

{bcsfe-3.0.1 → 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.0.1 → 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.0.1 → bcsfe-3.2.0}/src/bcsfe/cli/dialog_creator.py

@@ -285,6 +285,11 @@ class ChoiceInput:
                 return int_val
             if user_input == core.core_data.local_manager.get_key("quit_key"):
                 return None
+            for i, string in enumerate(self.strings):
+                if self.localize_options:
+                    string = core.core_data.local_manager.get_key(string)
+                if string.lower().strip() == user_input.lower().strip():
+                    return i + self.start_index
 
     def get_max_value(self) -> int:
         return len(self.strings) + self.start_index - 1
@@ -322,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:
@@ -333,9 +338,19 @@ class ChoiceInput:
             except ValueError:
                 if inp == core.core_data.local_manager.get_key("quit_key"):
                     return None, False
-                if inp in self.strings:
-                    int_vals.append(self.strings.index(inp) + self.start_index)
+
+                cont = False
+                for i, string in enumerate(self.strings):
+                    if self.localize_options:
+                        string = core.core_data.local_manager.get_key(string)
+                    if string.lower().strip() == inp.lower().strip():
+                        int_vals.append(i + self.start_index)
+                        cont = True
+                        break
+
+                if cont:
                     continue
+
                 color.ColoredText.localize(
                     "invalid_input_int",
                     min=self.get_min_value(),
@@ -674,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.0.1 → bcsfe-3.2.0}/src/bcsfe/cli/edits/__init__.py

@@ -8,6 +8,8 @@ from bcsfe.cli.edits import (
     aku_realm,
     map,
     event_tickets,
+    max_all,
+    storage,
 )
 
 __all__ = [
@@ -19,5 +21,7 @@ __all__ = [
     "enemy_editor",
     "aku_realm",
     "map",
-    "event_tickets"
+    "event_tickets",
+    "max_all",
+    "storage",
 ]

{bcsfe-3.0.1 → 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")