# Readme

This is my version of a NSFW mod for Hades 2. This is currently for The 1.0 release. There's still some work to do on it but I wanted to get a release that can be used on the 1.0 version quickly.

### Disclaimer:

This mod is made using AI image generation. Secifically Invoke AI using the following:
Model: perfectPonyXL_v40
LoRA: hades_pony_v2-1

## ToDo

1. Finalize all the portrait placements. I haven't run across all the images in-game yet and usually once I run across them in-game I need to adjust their placements to make them look appropriate.
2. I would love to add the effects that I needed to disable for all the portraits (glint, flames, blinking, moonglow, wiggle, etc.) but I don't know how to do that without a massive amount of work
3. Add additional artwork to replace the following images:
    `Portraits_Circe_Serious_01.png`
    `Portraits_Melinoe_EmpatheticFlushed_01.png`
    `Portraits_Melinoe_PleasedFlushed_01.png`
    `Portraits_Nemesis_Flushed_01.png`
    `Portraits_Hecate_Bath_01.png` (The masked version)
4. Finish replacing the following images:
    `Portraits_Hecate_Baby_01.png`
    `Portraits_Hecate_Frozen_01.png`
    `Portraits_Melinoe_Bath_Shock_01.png`
    `Portraits_Melinoe_Bath_Tears_01.png`
    `Portraits_Nemesis_Flustered_01.png`
5. Replace Fates at some point?
6. Replace Scylla at some point?

## Changelog

### [01] Initial Release
### [02] Update for the v1.0 Hades 2 Release
- Fixed an issue where the glow and other effects of the original artwork was showing on top of the replacement images.
- Added "Dora Thoughtful" image.
- When they released 1.0 they added some artwork with the characters are "flushed". For the time being I have just replaced them with the non-flushed versions to get a release out for use while I work on other images.
- Fixed the placement of some of the images to be better aligned on screen.

# Install

DISCLAIMER:
I have copied these steps and the base layout of the mod from Medician. I have adjusted the instructions to be up to date for the current patch (The Unseen Update) so they may change in the future.

1. Download, and install r2modman (https://thunderstore.io/package/ebkr/r2modman/). This is standard for Hades II mods.
    1. Run r2modman, search for "Hades" in the search bar. Click "Select Game".
    2. Select "Default" profile, or "Create New" (name it NSFW, for example).
    3. On the left side menu you will see a "MODS" section. Click "Online".
    4. You need to install essential mods, that are neccessary for most mods to run. Search for "ModUtil" and click on it, and "Download with dependencies".
    5. Done. You should now have the number "8" next to the "Installed" text on the left side menu.
    6. Click "Run modded" on the top left, and load the game once.
    7. Close the game.

2. Open the folder where we will put our modded files...
    1. Press both `Windows` + `R` keys on the keyboard together.
    2. Type `%appdata%` inside, and press ENTER.
    3. It will open a file explorer window that puts you in `C:\Users\USERNAME\AppData\Roaming\` (USERNAME will be your own).
    4. Navigate to to: `r2modmanPlus-local\HadesII\profiles`
    5. In profiles open the profile we created in r2modman during step 2 (Default, or NSFW, etc.).
    6. There open folder `ReturnOfModding`.

3. Copy the files from the `Kuipo-Resprite-v02-r2modman/plugins` and `Kuipo-Resprite-v02-r2modman/plugins_data` into the `ReturnOfModding/plugins/` and `ReturnOfModding/plugins_data` directories respectively.
    1. The files should look like:
```
C:\USERS\KUIPO\APPDATA\ROAMING\R2MODMANPLUS-LOCAL\HADESII\PROFILES\DEFAULT\RETURNOFMODDING
├───plugins
│   └───Kuipo-Resprite
│           config.lua
│           def.lua
│           icon.png
│           main.lua
│           manifest.json
│           ready.lua
│           reload.lua
│           sjson.lua
│
└───plugins_data
    └───Kuipo-Resprite
            Kuipo-Resprite.pkg
            Kuipo-Resprite.pkg_manifest
```

4. You can now run Hades II with the modded art by using the following steps:
   1. Open r2modman, select Hades II, then the profile. You will still see "8" mods, that's normal- it shows only online mods (we installed our's locally).
   2. Click "Start modded"
   3. Enjoy
