ManlyMarco / KKS-HF_Patch

Automatically translate, uncensor and update Koikatsu Sunshine!
GNU General Public License v3.0
127 stars 12 forks source link

preview

HF Patch for Koikatsu Sunshine!

An unofficial patch for Koikatsu Sunshine with fan-made English translations and essential mods. It will allow you to load all character cards and scenes and give you countless content creation and gameplay improvements while still keeping the original, uncluttered feel of the game. All content is tested and fixed (or removed) as needed before each update, providing a stable platform for further modding. HF Patch can also repair many common issues, try it if you have issues.

Read the full HF Patch manual to learn more about what it is, what it does, how to use it, and how to solve common issues.

Koikatsu can be split into two parts: character and scene creation tools (character maker and Studio), and an adventure game with story mode (it can use your custom characters, but not scenes). You can see preview videos of the game and some of the mods here.

HF Patch does not contain the full game, paid expansions or any other pirated content. You have to buy the game and expansions separately. You can buy the Japanese version on DMM (English/Steam release not announced yet). You can watch a guide on how to buy and install games from DMM here.

The base game (Koikatsu Sunshine), and by extension this patch are not suitable for minors. If you are under 18 years old you can not use this patch. The base game and this patch contain only characters of age 18 or higher. The creator of this patch is not responsible for creations of its users and prohibits any unlawful use of this software.

You can support development of HF Patch and many of the included plugins through my Patreon page: https://www.patreon.com/ManlyMarco

What's included?

HF Patch includes and installs by default:

Download

Check the Releases page for download links. The magnet links need to be downloaded with a torrent client like qBittorrent. To get mail updates for each new release you can watch this repositiory (top right) or watch the linked patreon page.

How to install the patch?

Here's a video guide that might be useful. The guide is mostly universal between different games, but there might be some differences.

Text guide

  1. Install Koikatsu Sunshine to a directory with no Japanese characters in its path (e.g. D:\Games\KKS)
  2. (Optional) Install any DLCs* you have. You don't have to install all of them, you can pick only some DLCs or don't install any DLCs at all.
  3. Download the latest HF Patch release from Releases. You should get a single .exe file along with a few .bin files. You can place these files anywhere you want (except the folder where the game is located), but they HAVE to be in the same folder together. DO NOT download any .zip files from GitHub - they contain source code for the patch, not the patch itself.
  4. Install the latest HF Patch by running the .exe and following the wizard. The default settings should work well for most users.
    • During the installation the patch may appear stuck, unless you get an error wait for it to finish.
    • If you use the light version of the patch its a good idea to update your Sideloader Modpack separately, you can do this by selecting update in the launcher or using the look for mods option in KKManager.
  5. Done! You can now start the game launcher as usual and you will notice some new options straight away. You can remove the downloaded patcher files now if you want to save some space. Special patch is included in HF Patch, you don't have to install it manually. It won't hurt anything if you have it installed already, the patch will figure itself out. Just to be safe you can verify game files in Steam before installing the HF Patch if you messed with your installation folder before doing this.
    • Keep in mind that the first launch of the game after patching could take a couple minutes on slower systems and the game window might not appear immediately.
  6. (Optional) You can update the modpacks by clicking the update button within the launcher. You can leave out Sideloader Modpack - Studio if you don't plan on using studio.

Note: If you want to run the game under Wine/Proton (Linux, SteamOS, macOS, etc.), read this and this.

How to install DLCs

DLCs are extra paid content and are all fully optional. Here's a simple way to install any downloaded DLCs (JP versions):

  1. Extract the DLC/expansion with 7zip (or similar) until you find a "setup" folder that contains an "abdata" folder and some other files.
  2. You need to copy all of these folders and files into your game's install directory (you should see our own abdata folder and other files similar to what's in the DLC). Replace files when asked.
  3. Install HF Patch, even if you already have it installed. (Optional, but if you replaced any files then you should reinstall it) DLCs for Koikatu and EmotionCreators will not work with Koikatsu Sunshine, trying to install them is likely to break your game (you might need to fully reinstall the game to fix it afterwards).

Solutions to common issues with the patch

Discussion and help

There is an extensive FAQ on the wiki and in the Koikatsu! discord server. There are also some guides available on the server.

If you need further help, feel free to ask in the #help channel on the server. Try to search for your issue first by using the Discord's search box at top right, it might have been already answered before. Please don't ask for help under this guide because I rarely check the comments here.

General FAQ / Notes

How to build the source

At least Visual Studio 2017 is needed for the helper library and latest unicode Inno Setup compiler is needed for the patch itself. All necessary mods have to be placed inside correct subfolders of the Input directory to compile. Because of massive size, they are not included here.