Manure Readme

*****************************************************************


                    THE ELDER SCROLLS V: SKYRIM
			      MANURE
			   Version 2.0.0


*****************************************************************

Index:
1. Installation
2. Description
3. Configuration
4. Change List
5. F.A.Q.
6. Uninstallation


*****************************************************************

     1. Manual Installation

*****************************************************************

1. Unzip the contents of the mod to your Skyrim Data folder. Below is a list of the default
   Skyrim installation locations:

	C:\Program Files (x86)\Steam\steamapps\common\Skyrim\Data

		For Special Edition Edition:

	C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition\Data

2. Confirm you have the following files in your Skyrim data folder:

	Manure.esp
	Manure.bsa
	Manure - Textures.bsa (Skyrim Special Edition only)

3. Run the Skyrim Launcher. Go to Data Files and make sure Manure.esp is loaded
   after your master files.

   For Special Edition, open %userprofile%\AppData\Local\Skyrim Special Edition\plugins.txt
   and add *Manure.esp after your master files.

4. Save.

5. Launch the game.


*****************************************************************

     2. Description

*****************************************************************

Manure gives animals such as cows, chickens, bears, etc, the ability to produce manure.

Key Features:

Immersive Poop: Animals such as cows, bears, chickens, and goats will produce manure. The state of
the animal affects how it produces manure. For example, animals that are in an alerted state have a
higher likelihood of producing manure, while combat makes it less likely. Manure can be collected
and used in variety of ways.

Mix Up A Stink: Mix manure with other ingredients at an alchemy workbench to create potent poisons.
Or mix manure with a pinch of deathbell and nightshade at a cooking pot to create a unique poisonous
stew.

Silent But Deadly: Reverse pickpocket poison stew onto an unsuspecting victim for a stealthy
assassination. Or coat your weapon in it to poison your enemies more directly.

The Staff of Discharge: Once you reach level 10, you'll receive a quest to retrieve the mighty Staff
of Discharge; a staff with the ability to induce an instant bowel movement on a given target. Use the
staff to temporarily incapacitate humanoid enemies and make the Mad God proud.

An MCM is included that allows you to toggle all features added by this mod.


*****************************************************************

     3. Configuration

*****************************************************************

Manure includes an MCM that allows you to configure the following options:

- Manure Base Chance:
  Controls the base chance of a poop being produced by the pooper. This chance is modified
  dynamically based on the condition of the pooper. For example, animals are more likely
  to poop during the day or when they're alarmed or alerted (it's the, umm... adrenaline?),
  but are less likely to poop at night or while in combat. There are other factors that affect
  the likelihood of pooping, e.g.: dead animals won't poop but animals that were just killed
  may make one final poop. By default this value is set to 30.
  You can also change this setting with the following console command:

	set MN_PoopChance to #		(0 - 100%)

- Disease Chance
  Controls the likelihood of contracting a disease when consuming manure.
  By default this value is set to 10.
  You can also change this setting with the following console command:
	set MN_DiseaseChance to #	(0 - 100%)

- Minimum Manure Interval:
  Controls the minimum time in seconds to poll for a poop. By default this value is set to 30.
  This value cannot be set higher than the Maximum Poop Interval.
  You can also change this setting with the following console command:

	set MN_PoopTimeMin to #		(10 - 1000 seconds)

- Maximum Manure Interval:
  Controls the maximum time in seconds to poll for a poop. By default this value is set to 300.
  This value cannot be set lower than the Minimum Poop Interval.
  You can also change this setting with the following console command:

	set MN_PoopTimeMax to #		(10 - 1000 seconds)

- Manure Generation:
  Enables or Disables manure generation altogether. Animals will still fart based on the interval
  defined above. By default this option is set to enabled.
  You can also change this setting with the following console command:

	set MN_EnablePooping to #	(0 to disable, 1 to enable)

- Fart Sound:
  Play a fart sound whenever an animal tries to produce manure.
  By default this option is set to enabled.
  You can also change this setting with the following console command:

	set MN_EnableFarting to #	(0 to disable, 1 to enable)

- Multi-Poo:
  Lets animals generate more than one manure each time the script is attached to them.
  By default this option is set to disabled.
  You can also change this setting with the following console command:

	set MN_EnableMultiplePoops to #	(0 to disable, 1 to enable)

- Toggle Debug
  Enables or disables debug notifications.
  By default this option is set to disabled.
  You can also change this setting with the following console command:

	set MN_EnableDebug to #		(0 to disable, 1 to enable)

- Flatulus Encounter Level.
  The minimum player level before Flatulus' quest starts. Once you reach this level, the
  courier will deliver a letter, starting a quest to seek out the Staff of Discharge.
  By default this option is set to 10.
  You can also change this setting with the following console command:

	set MN_FlatulusEncLevel to #	(1 - 81)


*****************************************************************

     4. Change List

*****************************************************************

1.0   - Initial Release on Nexus Mods and Steam.

1.1   - Fixed some minor issues.

1.2   - Fixed compatibility issues by removing edits to animal races. The poop script is
        now dynamically attached to animals as the player travels.
      - Animals now poop less frequently by default and the time between poops is now more
        varied.
      - More animal races poop. Even magical animals. And ghost animals.
      - Added an MCM.
      - Renamed Boiled Manure to Refined Manure (it's a matter of taste...), changed the
        ingredients required to make it from salt to deathbell and nightshade. Also increased
        the poison duration. This is now some potent shit. Quite literally.
      - NPCs will now enter a bleedout, or shall we say poopout, state for a few seconds while
        pooping if the NPC doing the deed has bleedout animations.
      - Added new fart sounds, adjusted db variance, added reverb and increased attenuation so
        farts aren't audible several blocks away from the one doing the farting.
      - Manure is now automatically deleted either after 6 in-game hours or when the parent
        cell is unloaded. This should prevent save file bloat. Manure in your inventory will
        remain, but manure you store in containers will eventually disappear.
      - Added a mage named Flatulus Corvius to random world and location encounters once the
        player is level 10 or higher. Kill or pickpocket him to obtain the Staff of Discharge.
      - Removed the poop cudgel and temper recipes. Kept manure ingots in case making bricks
        out of poop is your thing.
      - You now have a 10% chance of contracting a disease when eating uncooked manure.
      - Changed the alchemical properties of manure. Primary effect is now Stagger.

2.0.0 - By default animals now only produce a single manure each time the script is attached to
	them to prevent too much of it from accumulating if the player remains in the same area.
      - Added a new option to the MCM to toggle multiple poop generation back on if desired.
      - Added extra conditions to prevent manure from being produced if the animal is in no
        state to produce manure.
      - Reduced the initial poop chance from 40% to 30% to make manure a bit more scarce and to
        further improve performance. This can still be increased in the MCM.
      - 'Refined Manure' has been renamed to 'Poo Stew' and has a different model.
      - Manure Ingots and Manure Ingot recipe have been removed.
      - Manure will now only be automatically deleted if the player never picks it up.
      - Manure generated by chickens is scaled down. Manure generated by mammoths is scaled up.
      - Unticking 'Manure Generation' in the MCM now completely stops attaching the script to
        nearby animals for better performance.
      - Added a condition to limit bleedout animation and forced dialogue to humans only.
      - Replaced race checks with ActorTypeAnimal keyword check to catch DLC and modded animals.
      - MN_PoopAbility is now properly removed from animals that leave the player radius.
      - Added extra IsActor condition to MN_ApplyingEffect which should exclude it from trying
        to check inanimate objects. This should also improve performance.
      - Also added extra conditions to MN_ApplyingEffect to prevent it from trying to apply the
        script to dead and disabled animals, or if 'Generate Manure' is unticked in the MCM.
      - Created a new texture for the manure ingredient and adjusted the UVs for extra detail.
      - Ghosts now create ghost manure, assuming they don't resist the effect.
      - Dragons now resist the Staff of Discharge.
      - Reworked the encounter with Flatulus Corvius. You will now receive a letter from the
        courier to start a quest to retrieve the Staff of Discharge. Once you have the staff,
        you may encounter Flatulus on the road.
      - Flatulus Corvius now has a unique soul gem in his inventory. Use it wisely.
      - Rewrote Flatulus Corvius' journal.
      - Disease chance when consuming manure is now configurable in the MCM.
      - Killing Flatulus now triggers his wife's revenge encounter.
      - Killing Flatulus' wife now puts their kids into Honorhall Orphanage.
      - Replaced the old fart sounds with higher quality farts.


*****************************************************************

     5. F.A.Q

*****************************************************************

Q. What patch level is required?
A. None.

Q. Do I need Dawnguard, Hearthfire or Dragonborn or additional plugins like SKSE?
A. SKSE and SkyUI will be required if you want to change any settings via the MCM, but this
   mod will function perfectly fine without them and settings can be changed with console
   commands.

Q. Is this mod stable? / compatible with ### / affect performance?
A. Manure makes zero changes to any base game records, so there shouldn't be much out there
   that it could be incompatible with. I'm not aware of any stability issues associated with
   this mod. The script source is included if you want to take a look. Manure is automatically
   cleaned up and from 2.0.0 onwards animals produce a lot less of it by default.

Q. Won't this fill my game up with poo?
A. By default each animal can only produce 1 manure each time it's loaded, though you can turn
   on Multi Poo in the MCM if you want animals to continue producing manure.

Q. Will this bloat my save?
A. Manure is automatically deleted when it's unloaded, unless the player picks it up.

Q. Do I need to start a new game to use this mod?
A. No.

Q. Is this ESL flagged?
A. Yes.

Q. Can I modify this mod or use any assets from it?
A. You can do what ever you want with this mod and the assets included, with attribution.
   See Immersive Poop as an example.


*****************************************************************

     6. Uninstallation

*****************************************************************

If you want to remove the mod permanently:

1. Close the game.

2. Remove the Manure.esp and Manure.bsa files from your Skyrim data folder. By default this
   should be either of the following locations:

	C:\Program Files\Steam\steamapps\common\skyrim\data

			or for 64-bit Windows:

	C:\Program Files (x86)\Steam\steamapps\common\skyrim\data

3. Refer to SuperSajuuk's document on manually removing any left-over MN_* script files from
   your save file:

   https://www.dropbox.com/s/lj6d98yy8ohcoh3/Uninstalling%20Skyrim%20Mods.pdf?dl=0

   Note: You should not experience any problems with stability if you do not clean these script
   files from your save.