Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/thojmr/KK_PregnancyPlus
Browse files Browse the repository at this point in the history
  • Loading branch information
@thojmr
thojmr committed Aug 25, 2021
2 parents 7a46af3 + 70d9d84 commit 4960264
Showing 1 changed file with 48 additions and 37 deletions.
85 changes: 48 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,43 @@ The belly shape will persist in any game mode when slider values are saved to th
See `How To Install` for installation instructions


<img src="https://github.com/thojmr/KK_PregnancyPlus/blob/master/images/result.png" height="575"></img>
<img src="https://github.com/thojmr/KK_PregnancyPlus/blob/master/images/P%2BMakerGUI.PNG" height="575"></img>
<img src="https://github.com/thojmr/KK_PregnancyPlus/blob/master/images/P%2BStudioGUI.PNG" width="476.5"></img>
<img src="https://github.com/thojmr/KK_PregnancyPlus/blob/master/images/P+ All Menus.png"></img>

## Latest Features (I will update this occasionally)
- Copy Paste Belly buttons
- Override KK_Pregnancy belly shape
- Multithreaded computation
- HS2 belly inflation logic

</br>

## Features
- Adds a number of sliders that will allow you to change the size and shape of a characters belly in Studio, Maker, and Main Game.
- Adds a number of sliders that will allow you to change the size and shape of a characters belly in Studio, Maker, and Main Gameplay.
- Slider values will save to scene or character card.
- In the main game you can further tweak all characters belly shapes with the F1 plugin config sliders.
- Adds Timeline (KK) and VNGE (HS2/AI) integration for animating the belly by creating blendshapes that save to character card (see specific features below).
- Adds 3 configurable keybinds in plugin config that can be used to increase or decrease the belly size in Main Game, on the fly.
- Substitutes for stomach bulges/fat bellies as well, but it's original intent is pregnancy.
- Adds a "Main Game" mode config option. Disable if you want to turn off this plugins' features temporarily while playing.
- Adds an "Override KK_Pregnancy belly shape" toggle, that lets you replace the KK/AI_Pregnancy belly with the Preg+ one in Main Gameplay
- Adds an "Override KK_Pregnancy belly shape" toggle, that lets you replace the KK/AI_Pregnancy belly with the Preg+ one in Main Gameplay.
- Adds a "Mesh Smoothing" button in Studio and Maker, that allows you to smooth the belly mesh and reduce any edges resulting from some slider combinations.
- The smoothing will reset on slider change or character load, so it's mostly for screenshots, animations, and blendshapes.
- The smoothed shape will be captured by blendshapes!
- Optionally you can smooth any skin tight clothing as well, to help reduce clipping while smoothing, but clothing doesn't always look great afterwords.
- The smoothed mesh can be saved as a blendshape!
- It's a slow prcess so give it some time to complete (extremely so when using a high poly mesh)
- Somewhat compatible with "[ddaa33] Pregnant plugin (ShapeKeyPlugin)" if you wish to combine the effects of both, you can. But the effects applied by that plugin will not save to the character card by default. (Only with Pregnancy+ captured blendshapes)

## Honey Select 2 Only Features
- Because I'm too lazy to port KK_Pregnancy to HS2, belly inflation logic has been added to Main Game HScenes when finishing inside. Similar to how KK_Pregnancy inflation works. It is off by default, turn it on in Preg+ plugin config.
- Because I'm too lazy to port KK_Pregnancy to HS2, belly inflation logic has been added to Main Game HScenes when finishing inside (Thanks to Crescent696). Similar to how KK_Pregnancy inflation works. It is off by default, turn it on in Preg+ plugin config.

## Koikatsu and AI Only Features
- This was way too confusing, so I added the option to disable the KK_Pregnancy belly shape in favor of the Pregnancy+ belly in HScenes and Main Gameplay. Both plugins will still work together, and pregnancy will progress. You just have less to think about now! Look for "Override KK_Pregnancy belly shape" in plugin config.

<del>
- When using the KK/AI_Pregnancy `inflation` or `pregnancy` features, any saved Pregnancy+ belly sliders will be added in addition to KK/AI_Pregnancy's shape, but only both pregnancy plugins are installed. You can control the amount of Pregnancy+ belly shape applied on top of the KK/AI_Pregnancy belly with the "Max Additional Belly Size" slider in plugin config. 0 being no additional Preg+ slider effect, and max being the full Preg+ slider effect. You can use the plugin config sliders to further adjust the results for all pregnant characters at once.
- This can be used to tweak the final pregnant shape, or make the max size larger than what KK/AI_Pregnancy allows.
- Toggle this feature off by setting "Max Additional Belly Size" to 0.
- *Key thing to note*: If you just want to alter the KK/AI_Pregnancy shape. Make sure to set the "Inflation Size" slider to 0 before saving character card. When it is above 0 it will always be visible in Main Game even when not pregnant.
- *Key thing to note*: If you just want to alter the KK/AI_Pregnancy shape. Make sure to set the "Inflation Size" slider to 0 before saving character card. When it is above 0 it will always be visible in Main Game even when not pregnant.
</del>

## Koikatsu Only Features
- Studio Timeline integration via blendshapes. Here's how to:
Expand All @@ -59,6 +62,19 @@ See `How To Install` for installation instructions
- To use BlendShapes in VNGE set ExportChara_XXPE_BlendShapes=1 in vnactor.ini everywhere it is found (may become obsolete)
- Follow VNGE guides for further info

</br>

## How to install
1. Requires a recent version of BetterRepack or HF Patch (Preg+ is included with these, but probably not the latest version of Preg+)
- Otherwise make sure you have at least BepInEx 5.4.4 and KKAPI 1.17 for PregnancyPlus v3.0+ (These are all included in latest BetterRepack)
3. Download the latest release of Preg+ [here](https://github.com/thojmr/KK_PregnancyPlus/releases).
4. Right click the zip > "Extract Here" and copy that folder to your root game directory. The plugin .dll will end up inside your BepInEx\plugins\ directory.
- like {root game}/BepInEx/plugins/XX_PregnancyPlus.dll
5. Check for warnings on game startup, if the plugin loaded it should appear in Plugin Config.
- If you see warnings in game about KKAPI or BepInEx versions, you need to download the latest BetterRepack or HFPatch

</br>

## Bigger!
- For additonal effect in HS2 you can mimic what KK_Pregnancy does to belly bones to make the final shape larger/rounder
- Here's how
Expand All @@ -69,37 +85,45 @@ See `How To Install` for installation instructions
- This will however make slight changes to the characters spine shape, so keep that in mind.
- Also since this is altering bones, you may have some unintended cosequences down the road.

</br>

## FAQ - Troubleshooting
- Q: Where do I put the PregnancyPlus.dll?
- A: It should end up under {Root game folder}/BepinEx/Plugins/xx_PregnancyPlus.dll
- Q: Why are some outfits not affected by the sliders?
- A: Some outifts in Unity are marked as not readable, and the mesh of these outfits can not be altered at runtime.
- Q: Some of the sliders are not working?
- A: First make sure you don't have the debug mesh option enabled. Then try adjusting your 'Move Y' 'Move Z' sliders to make sure their centers are not outside your characters body. Third, make sure P+ gameplay is enabled in Plugin Config, and on the character card (It will be by default). Worst case scenario you can try turning on Preg+ debug logging to look for any errors in the Plugin Config and report to me.
- Q: The belly size is suddenly changing when the character moves, or the first time I adjust a slider.
- A: The default belly size is calculated based on the hip and rib bone width. In rare cases It can be due to strange character animations, or character size adjustments.
- Q: There are no slider effects when the character has no legs.
- A: The character must have a leg scale > 0 for the belly sliders to work correctly.
- Q: The heck is a BlendShape?
- A: Put simply a blendshape is a copy of the mesh that has some deformation that you want to be able to slide into. Like visually morphing from originalMesh -> targetMesh (Preggo).
- Q: The belly size/shape is different in Maker than in Studio?
- A: This was fixed in v3.5 and some cards with belly shapes before that version need to be re-saved again. Only old characters with ABMX adjustments to the torso will have this issue.

</br>

## Notes
- There will always be some amount of cloth clipping. You can use the Cloth Offset slider to help with it, but It's a difficult problem to solve.
- If you are looking for a higher poly base mesh to make up for Koikatsu's lack of belly polygons, you can try this [high poly uncensor (mesh)](https://ux.getuploader.com/nHaruka_KK/) However you will see a lot of cloth clipping with this uncensor, since it doesn't fully line up with the default one. Pick your poison.

## How to download
You can grab the latest plugin release [here](https://github.com/thojmr/KK_PregnancyPlus/releases), or build it yourself (developers only). Explained further below.
This plugin works in Koikatsu, Honey Select 2, and AI. Grab the KK zip for Koikatsu, HS2 zip for Honey Select 2, and AI zip for AI [here](https://github.com/thojmr/KK_PregnancyPlus/releases)
</br>

### Some KK_PregnancyPlus technical details
- Instead of manipulating the bones like KK_Pregnancy does, this mod alters the mesh itself via computed blendshapes which has benefits and drawbacks
- A blendshape is generated at runtime for every mesh near the belly. The sliders alter the shape of the pre calculated blendshape before re-applying it.
- Integrates with KK/AI_Pregnancy in Story Mode so that both plugins can work together. This can be configured in plugin config

### Some of the drawbacks of generating blendshapes instead of manipulating bones directly
- Right now clothing can be hit or miss, because of the way the belly grows the mesh loses its local positional data causing clipping. With bone scaling, clothes shift automagically via bone weights which usually results in less clipping.
- There are some clothing items in HS2 and AI that simply wont work at all with blendshapes because they are marked as not readable in Unity
- Acessories won't automatically move with the mesh as they do when you manipulate bones
- It has bigger impact on performance (only when changing a slider) because of the computation it has to perform. However once the shape is calculated the performance is equally as fast as bone manipulation.
- Unity doesn't have great blendshape support in older versions like KK is running on.
- Since blendshapes are tied to a single mesh, if the mesh is changed (like uncensors), any saved blendshape will become invalid, and a new blendshape will need to be made.

</br>
</br>
</br>

## How to install
1. Requires a recent version of BetterRepack or HF Patch (Preg+ is included with these, but probably not the latest version of Preg+)
- Otherwise make sure you have at least BepInEx 5.4.4 and KKAPI 1.17 for PregnancyPlus v3.0+ (These are all included in latest BetterRepack)
3. Download the latest release of Preg+ [here](https://github.com/thojmr/KK_PregnancyPlus/releases).
4. Right click the zip > "Extract Here" and copy that folder to your root game directory. The plugin .dll will end up inside your BepInEx\plugins\ directory.
- like {root game}/BepInEx/plugins/XX_PregnancyPlus.dll
5. Check for warnings on game startup, if the plugin loaded it should appear in Plugin Config.
- If you see warnings in game about KKAPI or BepInEx versions, you need to download the latest BetterRepack or HFPatch

## (Developers only) Compiling with Visual Studio 2019 (The official way)
<details>
Expand Down Expand Up @@ -160,16 +184,3 @@ Example build task:
```
If sucessfull you should see a KK_PregnancyPlus.dll file nested in .\bin\
</details>

### Some KK_PregnancyPlus technical details
- Instead of manipulating the bones like KK_Pregnancy does, this mod alters the mesh itself via computed blendshapes which has benefits and drawbacks
- A blendshape is generated at runtime for every mesh near the belly. The sliders alter the shape of the pre calculated blendshape before re-applying it.
- Integrates with KK/AI_Pregnancy in Story Mode so that both plugins can work together. This can be configured in plugin config

### Some of the drawbacks of generating blendshapes instead of manipulating bones directly
- Right now clothing can be hit or miss, because of the way the belly grows the mesh loses its local positional data causing clipping. With bone scaling, clothes shift automagically via bone weights which usually results in less clipping.
- There are some clothing items in HS2 and AI that simply wont work at all with blendshapes because they are marked as not readable in Unity
- Acessories won't automatically move with the mesh as they do when you manipulate bones
- It has bigger impact on performance (only when changing a slider) because of the computation it has to perform. However once the shape is calculated the performance is equally as fast as bone manipulation.
- Unity doesn't have great blendshape support in older versions like KK is running on.
- Since blendshapes are tied to a single mesh, if the mesh is changed (like uncensors), any saved blendshape will become invalid, and a new blendshape will need to be made.

0 comments on commit 4960264

Please sign in to comment.