Skip to content

Koikatsu Auto File I/O. Create backup, filter and convert kks cards, install/remove chara given a folder.

License

Notifications You must be signed in to change notification settings

RedDeadDepresso/KKAFIO

Repository files navigation

KKAFIO: Koikatsu Auto File I/O

Screenshot 2024-07-19 002241

KKAFIO is a Python-based script to automate file input and output operations for the game Koikatsu which include:

  • Create Backup: It will create a .7z file which include the game Userdata, mods (Sideloader Modpack excluded), BepInEx folders. If a .7z already exists with the same name it will be overwritten.
  • Filter & Convert KKS: Works the same as FlYiNGPoTAToChiP's KK_SunshineCardFilter. Given a folder it find all KKS cards and move them into the folder KKS_card. If conversion is enabled it will also convert KKS cards and store them KKS_to_KK
  • Install Chara: Given a folder with chara, coordinate, overlays and zipmod, it will automatically copy and paste them into the respective game folders. Also, if it finds any zip, rar, 7z it will automatically extract them. The script assume all chara are female so they will be installed in Userdata/female.
  • Remove Chara: The reverse process of install chara. Given a folder with chara, coordinate, overlays and zipmod it will automatically look into game folders and delete them if their found. ONLY USE it if you have selected RENAME or REPLACE in file conflicts in install chara and the input folder DOES NOT contain any MALE chara.

Requirements

  • 7-Zip installed
  • Python 3.11 or latest, installed and added to your system's PATH.

Installation and Usage

Follow these steps to get KAFIO up and running:

  1. Clone or download this repository.
  2. Install the required packages using pip3 with the command pip3 install -r requirements.txt.
  3. Run KKAFIO.py and modify the settings to your preference.
  4. Press Start

Note: You have to run as administrator if Koikatsu is saved in C:\Program Files (x86). To do it run cmd as administrator, type cd with the path of KAFIO folder and then type python KAFIO.py Please feel free to use and modify KAFIO as you see fit. Your feedback and contributions are always welcome.

Known Bugs

Here are some known issues with KKAFIO:

  • When running Create Backup it won't display any output for a while. Don't worry, just wait.
  • Any .png that cannot be classified as chara or coordinate will be treated as Overlays. It is not a big issue, you can go to Overlays folder, sort by date and delete any files that are not overlays.

Acknowledgment

I'd like to express my gratitude to the following individuals, listed in no particular order:

  • Akascape: Provided customtkinter widgets that are both complex and user-friendly.
  • Egoistically: For making ALAuto open-source and providing the foundation for KAFIO.
  • FlYiNGPoTAToChiP For making KK_SunshineCardFilter open-source allowing me to implement it as a module. Also, they provided the method to distinguish chara and coordinate.
  • TomSchimansky: Created customtkinter, making it possible for an inexperienced programmer like me to create a modern GUI.

About

Koikatsu Auto File I/O. Create backup, filter and convert kks cards, install/remove chara given a folder.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages