KKAFIO: Koikatsu Auto File I/O

<p align="center"> <img width="720" alt="KKAFIO preview" src="https://github.com/user-attachments/assets/5acc50f1-baf3-476f-b625-fc0405bf4e2f"> </p>

Features

1. Create Backup

• Automatically creates a .7z file that includes:
  • Userdata
  • Mods (excluding Sideloader Modpack)
  • BepInEx folders
• If a .7z file with the same name already exists, it will be overwritten.

2. Filter & Convert KKS

• Functions similarly to FlYiNGPoTAToChiP's KK_SunshineCardFilter
• Given a folder, the script:
  • Finds all KKS (Koikatsu Sunshine) cards and moves them into the folder _KKS_card_
  • Optional: If conversion is enabled, it also converts KKS cards and stores them in _KKS_to_KK_

3. Install Chara

• Given a folder containing:
  • Chara, Coordinate, Overlays, and Zipmod files
• The script automatically copies and pastes the files into their respective game folders.
• Additionally, if it finds any compressed files (e.g., .zip, .rar, .7z), it will automatically extract them.

4. Remove Chara

• Performs the reverse process of the "Install Chara" feature:
  • Given a folder with Chara, Coordinate, Overlays, and Zipmod files, it looks for and deletes these files from the game directories if found.
• Important: Only use this feature if you have selected Rename or Replace in file conflicts when using the "Install Chara" feature.

Requirements

• 7-Zip installed
• If running from source code, uv installed.

Installation and Usage

Download the latest version and extract it, then run KKAFIO.exe.

If you want to run from source code, follow these steps:

1. Clone or download this repository.
2. Install uv if you haven't already.
3. Run uv sync in the repository folder to create the virtual environment and install dependencies.
4. Run uv run KKAFIO.py and modify the settings to your preference.
5. Press Start.

Note: You may have to run as administrator if Koikatsu is saved in C:\Program Files (x86). To do so, run Command Prompt as administrator, cd to the KKAFIO folder and then run uv run KKAFIO.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:

• 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 the 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:

• zhiyiYo for providing PyQt-Fluent-Widgets allowing me to make the GUI.
• Kiramei for creating the logger. You can find the original here.
• 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.
• Evaanxd and GaryuX for Ryuko Matoi card and image.