----------------------------------------------------------------------------------------------------
Why Use This Mod?
----------------------------------------------------------------------------------------------------

Normally, magic-focused characters need to constantly rest to restore magicka. 
This usually means you need to backtrack (in a dungeon) or risk random encounters 
(in the world), both of which are tedious and break the flow of gameplay. With this mod, 
that is no longer a concern, as you regenerate a small amount of magicka every second
and restore a significant amount when resting.

Why not use another mod that does the same thing?

* more customization options
* accounts for resting and waiting
* no dependencies on MWSE, Tribunal.esm, or Bloodmoon.esm
* immaculate, readable, and well-documented script (great if you're trying to learn)

----------------------------------------------------------------------------------------------------
The Formula
----------------------------------------------------------------------------------------------------

The player's magicka is regenerated every second based on the following formula:

RegenAmount = BaseAmount
if (UseMaxMagicka) RegenAmount *= (MaxMagicka * 0.01)
if (UseIntelligence) RegenAmount *= (MIN(MAX(Intelligence, IntelligenceMin), IntelligenceMax) * IntelligenceMult + IntelligenceBase)
if (UseWillpower) RegenAmount *= (MIN(MAX(Willpower, WillpowerMin), WillpowerMax) * WillpowerMult + WillpowerBase)
if (UseFatigue) RegenAmount *= (MIN(MAX(FatiguePercent, 0), 1) * FatigueMult + FatigueBase)

With the default settings, this simplifies to:

RegenAmount = MaxMagicka * MIN(Willpower, 1000) * 0.0001

In other words, you typically restore 0.3% to 1.0% of your max magicka every second, based on your Willpower.

----------------------------------------------------------------------------------------------------
Resting and Waiting
----------------------------------------------------------------------------------------------------

When you rest, wait, or time passes for any other reason, you regenerate 120x this amount every hour.
This is in addition to the (Intelligence * 0.15) magicka per hour you regenerate while resting.
The "Until Healed" button does not take the regeneration from this mod into account.

----------------------------------------------------------------------------------------------------
How To Customize
----------------------------------------------------------------------------------------------------

You can modify how RegenAmount is calculated by updating the variables listed below.
To change a variable, open the console and type in the following command:

Set Ben_MagickaRegen.[VariableName] to [NewValue]
EXAMPLE: Set Ben_MagickaRegen.BaseAmount to 0.5

These console commands are not case-sensitive.
Any variable changes only affect the current character.
Here's the full list of variables and their default values:

RespectStuntedMagicka = 1 ; 1 = stunted magicka prevents magicka regeneration
OnlyRegenWhileResting = 0 ; 1 = only regen magicka while resting
BaseAmount = 1

UseMaxMagicka = 1
UseIntelligence = 0
UseWillpower = 1
UseFatigue = 0

IntelligenceMin = 0
IntelligenceMax = 1000
IntelligenceMult = 0.01
IntelligenceBase = 0

WillpowerMin = 0
WillpowerMax = 1000
WillpowerMult = 0.01
WillpowerBase = 0

FatigueMult = 0.5
FatigueBase = 0.75

Initialized ; set to zero to restore default values

IMPORTANT: This mod assumes your max fatigue is: Strength + Willpower + Agility + Endurance.
If another mod changes this formula, FatiguePercent will not be calculated correctly.

----------------------------------------------------------------------------------------------------
Special Functionality
----------------------------------------------------------------------------------------------------

By default, Stunted Magicka prevents your magicka from regenerating. If you want your 
magicka to regenerate while stunted, set the RespectStuntedMagicka variable to 0.

Set Ben_MagickaRegen.RespectStuntedMagicka to 0

By default, this mod regenerates magicka in real time and during every time skip. 
If you only want your magicka to regenerate while resting (like in vanilla Morrowind), 
set the OnlyRegenWhileResting variable to 1.

Set Ben_MagickaRegen.OnlyRegenWhileResting to 1

If you want to reset all variables to their default values, set the Initialized variable to 0.

Set Ben_MagickaRegen.Initialized to 0

----------------------------------------------------------------------------------------------------
Installation
----------------------------------------------------------------------------------------------------

Extract files into "Morrowind/Data Files" and enable Ben-MagickaRegen.esp

IMPORTANT: While this mod does not depend on the Tribunal or Bloodmoon .esm files, 
you must have the Tribunal and Bloodmoon expansions installed (or have a version of 
the game, like the GOTY edition, that includes both expansions).

----------------------------------------------------------------------------------------------------
My Other Mods
----------------------------------------------------------------------------------------------------

Ben's Build-Your-Own Rebalance
Ben's Skill-Independent Level-Up Multipliers
Ben's Super Customizable Max Health
Ben's Balanced Passive Races
Ben's Balanced Passive Birthsigns
Ben's Fatigue Rebalance
Ben's Movement Rebalance