A save file editor for The Battle Cats
Project description
Battle Cats Save File Editor
BCSFE is a python command line save editor for The Battle Cats.
Join the discord server if you want to suggest new features, report bugs or get help on how to use the editor (please read the below tutorials / watch the latest tutorial video first before asking for help).
Thanks to
Lethal's editor for giving me inspiration to start the project and it helped me work out how to patch the save data and edit cf/xp: https://www.reddit.com/r/BattleCatsCheats/comments/djehhn/editoren/
Beeven and csehydrogen's open source code, which helped me figure out how to patch save data: beeven/battlecats, csehydrogen/BattleCatsHacker
Everyone who's given me saves, which helped to test save loading/saving and to test/develop new features
How to use
If you have a pc: watch a Tutorial video, or scroll down for a text tutorial
If you only have an android device: read the Android text tutorial
If you only have an ios device: watch the IOS tutorial video (Made by Viarules, NOTE: Some people have said that ish is really slow, and you should use a-shell instead)
Main tutorial
-
Install python (You'll need version 3.9 and up) https://www.python.org/downloads/
-
Follow the
Install from source
instructions below as 3.0.0 isn't on pypi yet -
Enter the command:
py -m bcsfe
to run the editor. If that doesn't work then usepython3
orpython
instead ofpy
in the command -
Go into the in-game transfer system in
Settings-> Data Transfer
and clickBegin Data Transfer
-
In the editor use the option called
Download save file using transfer and confirmation code
(enter the corresponding number, not the name itself) -
Enter your transfer code
-
Enter your confirmation code
-
Select the country code that you are using,
en
=english,kr
=korean,jp
=japanese,tw
=taiwanese. -
Edit what you want. Note that in most cases, if you want to exit the current input you can enter
q
and press enter to go back to the previous menu -
Go into the
Save Management
option and selectSave changes and upload to game servers (get transfer and confirmation codes)
. It may take some time, it may also fail, if it does then try again -
Enter those codes into the game's transfer system (click on
Resume Data Transfer
) (You may need toCancel Data Transfer
in-game before doing so)
Using a rooted device via adb
-
Add adb to your PATH environment variable, or edit the config to set ADB path to the full path of the adb executable. You can download adb from adb
-
Open the editor and select the option named
Pull save file from device using adb
and enter your game version, or select the option namedSelect save file from file
and select a copy of your save data -
Edit what you want
-
Go into save management and select an option to push save data to the game
-
Enter the game and you should see changes
Using a rooted device directly
-
You need to be running the editor on the device itself, so you'll need to follow the Android tutorial to install the editor
-
Open the editor and select the option named
Pull save file from root storage
-
Edit what you want
-
Go into save management and select an option to push save data to the game
-
Enter the game and you should see changes
How to unban your account
-
Select the option in
Account
toUnban account
or just upload the save data to the game servers again -
It may take some time but after, you should be able to choose one of the options in save management to push the save data to the game.
How to prevent a ban in the future
-
Instead of editing in platinum tickets use the
Platinum Shards
feature -
Instead of editing in rare tickets use the
Normal Ticket Max Trade Progress (allows for unbannable rare tickets)
feature -
Instead of hacking in cat food, just edit everything in that you can buy with cat food, e.g battle items, catamins, xp, energy refills (leaderships), etc. If you really want catfood then you can clear and unclear catnip missions with the feature
Catnip Challenges / Missions
then entering 1 when asked. You'll need to collect the catfood in-game after each clear though -
Instead of hacking in tickets, just hack in the cats/upgrades you want directly
Android Tutorial
If you don't have a pc to install and run the editor you can use Termux.
-
Download F-Droid - You can download the Termux apk directly but then it won't automatically update. You cannot download Termux from the Play Store because it does not work
-
Install F-Droid
-
Open it and wait for it to finish
Updating repositories
-
Tap the green search button in the bottom right and search for
Termux
-
Tap
Termux Terminal emulator with packages
-
Tap
INSTALL
and thenOPEN
once installed -
Once opened enter the command
pkg install python
-
If that doesn't work then read this: https://stackoverflow.com/a/71097459
-
Then follow the
Install from source
instructions below -
If that doesn't work then run
pkg upgrade
and try again -
Then run
python -m bcsfe
-
Note that the editor might complain about not being to run tkinter, but you can ignore that and just enter
SAVE_DATA
when asked to enter the path to a save file -
You can then use the editor like normal
Install from source
If you want the latest features then you can install the editor from the github.
-
Download Git
-
Run the following commands: (You may have to replace
py
withpython
orpython3
)
git clone https://github.com/fieryhenry/BCSFE-Python.git
cd BCSFE-Python
git checkout 3.0.0
pip install -e .
py -m bcsfe
If you want to use the editor again all you need to do is run the py -m bcsfe
command
Then if you want the latest changes you only need to run git pull
in the downloaded
BCSFE-Python
folder. (use cd
to change the folder)
Documentation
I only have documentation for the locales and themes atm, but I will probably add more documentation in the future.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file bcsfe-3.0.0b3.tar.gz
.
File metadata
- Download URL: bcsfe-3.0.0b3.tar.gz
- Upload date:
- Size: 173.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7acd0a17e9750308fa175838a2792e0b83027d2cdf1e821207ac77ad9dc6d8d8 |
|
MD5 | 5c05ca0c190135642250ef543c132847 |
|
BLAKE2b-256 | f8084faf236f0282a644d0965789fb626a39697816f8b8f0d777404cbe430e92 |
File details
Details for the file bcsfe-3.0.0b3-py3-none-any.whl
.
File metadata
- Download URL: bcsfe-3.0.0b3-py3-none-any.whl
- Upload date:
- Size: 220.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42fa428c3acd2970c0c33cc36a679b6789aa5be2758531203183833523e8fb4f |
|
MD5 | e19bebbb712e36f9898a72e0ab892da1 |
|
BLAKE2b-256 | 79cd40745a3d701caf2b1a7258ce3de283e90fbae0414e11a7f85ec118a9f636 |