Zombie Debuff Tweaks - Graveyard Keeper 2
=========================================

Removes the "excessive zombies" debuff that cuts the faith you get from
sermons when you have more zombies than your resurrection room's quality.

Without this mod, that debuff lowers faith per parishioner in every sermon
(for example 0.25 -> 0.05 base faith and 0.30 -> 0.10 bonus on the basic
sermon). In testing, a 30-parishioner sermon gave 27 faith with the mod
versus 12 with the debuff.


REQUIREMENTS
------------
BepInEx 5 (x64), version 5.4.23 or newer:
https://github.com/BepInEx/BepInEx/releases
(Download BepInEx_win_x64_5.4.23.x.zip - NOT BepInEx 6 / IL2CPP.)


INSTALL
-------
1. Install BepInEx: extract the BepInEx zip into your Graveyard Keeper 2 folder
   (the folder with GraveyardKeeper2.exe). Start the game once, then close it.
2. Extract this mod's zip into the same Graveyard Keeper 2 folder.
   You should end up with:
   Graveyard Keeper 2\BepInEx\plugins\ZombieDebuffTweaks\ZombieDebuffTweaks.dll
3. Start the game. If you already have the debuff, it disappears within
   a couple of seconds of loading your save.

Steam: right-click the game > Manage > Browse local files to find the folder.


SETTINGS
--------
After the first launch, edit:
Graveyard Keeper 2\BepInEx\config\hellcore49.gk2.zombiedebufftweaks.cfg

  Mode = Disabled   The debuff never applies (default).
  Mode = Vanilla    The game behaves as if the mod is not installed. If you
                    have too many zombies, the debuff comes back a few
                    seconds after loading your save.

  VerboseLogging = true   Writes to BepInEx\LogOutput.log whenever the mod
                          blocks the debuff, and after each sermon shows the
                          faith you got next to what the debuff would have
                          left you with.

Restart the game after changing settings.


"RaiseLimit" VERSION
--------------------
The optional RaiseLimit file adds a third mode that keeps the debuff but
raises the zombie limit (it starts in Mode = Disabled - set Mode = RaiseLimit
to use it):

  Mode = RaiseLimit
  ExtraZombies = 10       Extra zombies allowed on top of the room's quality
  LimitMultiplier = 1.0   Multiplies the room's quality first

  Limit = floor(RoomQuality x LimitMultiplier) + ExtraZombies

Install only one of the two files - they replace each other.


UNINSTALL
---------
Safe to remove at any time: the mod saves nothing of its own into your save.

For a clean uninstall (so the game's own debuff state is correct again):
  1. Set Mode = Vanilla in the config.
  2. Start the game, load your save, wait a few seconds, then save.
  3. Close the game and delete BepInEx\plugins\ZombieDebuffTweaks.

If you just delete the folder, the debuff only returns the next time the game
itself re-checks your zombie count (e.g. when a hypno buff or panic-reducing
item changes the limit).


CHANGELOG
---------
1.0.1 - Vanilla mode now restores the debuff right away if you have too many
        zombies (before, it only came back on the game's next check).
        The mod re-checks the zombie limit after loading a save and when the
        mode changes. RaiseLimit mode fully tested - no longer experimental.
1.0.0 - Initial release.


PERMISSIONS & CREDITS
---------------------
Created by Hellcore49.

Anyone may use, modify, and upload their own version of this mod (including
as part of a modpack or a new mod), as long as you credit Hellcore49 as the
original author, for example with a link back to the original mod page.

You may NOT sell this mod, or any mod made with it, or put it behind a
paywall. Mods should be free for everyone.


COMPATIBILITY
-------------
- Built and tested on Graveyard Keeper 2 (Steam, Unity 6000.3) with BepInEx 5.4.23.5.
- Game updates may break it if the developers change the zombie limit code.
- Co-op / multiplayer: untested.
