Modding API for Illusion games
This is an API designed to make writing plugins for recent UnityEngine games made by the company Illusion easier and less bug-prone. It abstracts away a lot of the complexity of hooking the game save/load logic, creating interface elements at runtime, and many other tasks. All this while supplying many useful methods and tools. Supported games:
- PlayHome (PHAPI)
- Koikatu/Koikatsu Party (KKAPI)
- Emotion Creators (ECAPI)
- AI-Shoujo/AI-Syoujyo (AIAPI)
- HoneySelect2 (HS2API)
- Koikatsu Sunshine (KKSAPI)
Some mods that use the Modding API
The API is required by many plugins made for Koikatsu, Emotion Creators and AI-Girl/AI-Shoujo. Here are some of them:
- Illusion Overlay Mods - Uses many different features like saving to coordinates, partial load toggles, advances maker interface elements, using Windows Open File dialogs, etc.
- KK_BecomeTrap - Simple mod that give a good example of how clean and easy KKAPI makes things.
- KK_SkinEffects - Uses StudioAPI to create custom controls in the studio interface.
- ABMX - Uses a lot of runtime-generated maker UI elements, fairly complex.
- UncensorSelector, KK_EyeShaking, KK_RandomCharacterGenerator, more...
- AI PushUp
- and many more...
How to install
- Install at least BepInEx 5.4.4 and BepisPlugins r16.2 . If MoreAccessories is used, make sure it is up to date as well.
- Download the latest release for your game. Warning: You only need the version specific for your game (check the prefix, for example KK = for Koikatsu). Downloading version for the wrong game or multiple versions will break things!
- Extract the archive into your game directory. The .dll file should end up inside BepInEx\plugins.
Developers
- Basic construction of the API is explained in the introduction.
- A short tutorial on how the API can be used to make a plugin can be found here.
- Code reference can be found here.
- You can get help with using this API on the Koikatsu! discord server.
Previews
To get a good preview you can download one of the mods listed above, for example Koikatu Overlay Mods.
