docs: update README.md

This commit is contained in:
RedDeadDepresso
2024-10-07 00:55:27 +01:00
committed by GitHub
parent d8b61b2b9f
commit 6823b14110

View File

@@ -6,10 +6,10 @@
## Features
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](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_
- 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.
- 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.
- **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](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_
- **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.
- **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.
## Requirements
- 7-Zip installed
@@ -24,7 +24,7 @@ If you want to run from source code, follow these steps to get KAFIO working:
4. 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 it run cmd as administrator, type cd with the path of KAFIO folder and then type python KAFIO.py
**Note**: You may 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