mirror of
https://github.com/RedDeadDepresso/KKAFIO.git
synced 2025-12-22 01:10:01 +00:00
docs: update README.md
This commit is contained in:
28
README.md
28
README.md
@@ -5,11 +5,29 @@
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
KKAFIO is a Python-based script to automate file input and output operations for the game Koikatsu which include:
|
**1. Create Backup**
|
||||||
- **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.
|
- Automatically creates a `.7z` file that includes:
|
||||||
- **Filter & Convert KKS**: Works the same as [FlYiNGPoTAToChiP's KK_SunshineCardFilter](https://github.com/FlYiNGPoTAToChiP/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_
|
- `Userdata`
|
||||||
- **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.
|
- `Mods` (excluding Sideloader Modpack)
|
||||||
- **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 they're found. ONLY USE it if you have selected RENAME or REPLACE in file conflicts in install chara.
|
- `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](https://github.com/FlYiNGPoTAToChiP/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
|
## Requirements
|
||||||
- 7-Zip installed
|
- 7-Zip installed
|
||||||
|
|||||||
Reference in New Issue
Block a user