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

The Elder Scrolls III
MORROWIND:
Pack Rat Companion, Paxon
Version: 3.2.4
by Tizzo

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

Index:
1. Installation
2. Playing the Plugin
3. Plugin Features
4. Save Games
5. Known Issues/Conflicts
6. Revisions
7. Upgrading From Previous Versions
8. Credits

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

1. INSTALLING THE PLUGIN

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

To install the plugin, unzip the files into the Morrowind directory.

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

2. PLAYING THE PLUGIN

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

To use this mod check the box next to PaxonRat.esp in the Data Files menu of your Morrowind launcher.

This mod adds "Paxon, the Pack Rat" to your game.

As the name implies, Paxon is a "Pack" Rat. He's difficult to kill, hard to lose, and can carry a lot of stuff. He will also fight beside you.

Paxon can be found in the courtyard of the Census and Excise Office, in Seyda Neen.

Give him stuff to carry and try not to trip over him.

(It's not a very complicated mod to play.)

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

3. PLUGIN FEATURES

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

Your new Pack Rat has several useful companion scripting features:

- Will warp behind the player if he lags far behind.
- Can warp with you when you use Recall, Intervention, or scripted teleports.
- Can be summoned to your location with his magic acorn.
- Can be instructed to Wait or Follow by sneaking and activating him.
- You can easily swap places with Paxon by jumping and activating him while doing so.
- You can swap places with Paxon (if you are stuck in a doorway for example) via dialogue.
- You can inspect his stats, and see how your Pack Rat is doing. (in the "Health" menu).
- Paxon can be set into 'Durable Mode' via dialogue, making him functionally invulnerable.
- Paxon levels with the player, his stats increase as your character's stats increase.
- Paxon levitates and water walks with the player.
- Your Pack Rat can act as a light source.
- Paxon can be healed with potions via dialogue.
- Paxon has 'Potion Saver' code, meaning he will not drink all your health potions.
- Players can ask a Guard where Paxon is located, and he will be warped to a nearby tavern.
- There is a wide variety of commentary on your new buddy (based off Race/Class/Other).
- Ask around via the "- My Pack Rat -" topic!

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

4. Save Games

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

This plugin should not invalidate your old saved games. If you remove the
plugin from a game already in progress, you will have to click through
all those error messages. However, you should be able to continue on afterward.

**Note: As a rule, you should backup all your saves before using this or any
other plugin, as a precaution against any strange error you might encounter.

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

5. Known Issues/Conflicts

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

-- Users have reported in previous versions that Paxon can get stuck in an 'animation loop'
which causes attack noises to constantly play. This is quite rare, and is an engine based
bug. To resolve this issue if it happens to you during play, use Paxon's Summoning Acorn
and the the issue should stop.

If this error happens repeatedly, you might try the 'Pack Rat Anti-Swish' patch incuded
in this archive. This is an edited Key Frame file which removes the attack sounds from
the Pack Rat model entirely.

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

6. Revisions

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

Version 1.0

-- Initial Release Version. Yay!

Version 1.1

-- Moved Paxon to Addamasartus.

-- Changes to scripts.

Version 1.2

-- Changed a script reference in one of the dialoge options. Was referencing an old script.

-- Added some code to make Paxon not quite as "tanky" in combat. Will start to miss (and be missed) in combat after taking a given amount of damage.

-- Upped Paxon's damage. Paxon now does damage equivalent to a Blighted rat.

Version 2.0.1

-- Mod redone from scratch.

-- Completely recoded, totally redone dialogue.

-- Redone stats, added leveling code.

-- Paxon moved to Census and Excise Office courtyard.

-- Added dialogue topic "- My Pack Rat -".

-- Added 'Auto Move' and 'One-Time Move' functionality.

-- Added 'Light' ability, toggleable from dialogue.

-- Various other 'Under-The-Hood' changes.

-- Other stuff I am probably forgetting.

Version 2.2.0

-- Increased Paxon's scale setting to fix a few clipping bugs with the packrat model.

-- Slightly tweaked leveling code to increase Paxon's health values.

-- Paxon now cures any diseases on himself when leveling up.

-- Added dialogue topic "- Warp -"

-- Paxon can now be set to warp along through Recall, Intervention, or scripted teleports.

-- Added a few lines of dialogue to the "- My Pack Rat -" Topic

-- A few other bug and stability fixes.

Version 2.3.0

-- Scale setting set back to normal.

-- More leveling code tweaks. Slightly higher health, increased armor class.

-- In addition to curing diseases when leveling up, Paxon cures any attribute damage to himself.

-- When the player is Underwater, and Water Breathing or Swift Swimming, Paxon will now match his Z axis to yours.

-- Added a cutesy little particle effect when using the 'Summoning Acorn' on Paxon.

-- Condensed dialogue tree for controlling pet slightly.

-- Improved 'Where is Paxon' behavior when talking to Guards. Doesn't get warped immediately now.

-- Added script to 'Clean up' extra summoning items (acorns) if you somehow get more than one.

-- Additional dialogue with more NPC's about your furry little buddy.

-- Bug fixes, script improvements.

-- Other stuff I am probably forgetting.

Version 2.3.1

-- Minor script and dialogue tidying.

Version 2.3.2

-- Code tweaks to ensure smooth transitions from walking to running animations.

-- Checks added to ensure Paxon is not dragged along with you if he somehow dies.

-- Dialogue changes to reduce the volume and frequency of squeaking when selecting options.

-- Paxon will now have a minimum of 155 health, before any other adjustments or increases.

-- Paxon can now warp with you into certain end game expansion areas.

-- Added code to prevent Paxon from following you if you have not spoken to him.

-- Added code to enable Paxon to follow you when using the 'Vampire' amulet warp items.

-- Leveling code tweaks. Paxon is tougher at lower levels now, with slightly less offense.

-- Other minor dialogue fixes.

-- More stuff I really am probably forgetting.

Version 3.1.6

-- Across the board stat reduction. As a general rule of thumb, Paxon will have half your stats (up to 50 for most stats), and 2 times your health (up to a max of 275).

-- Added 'Check Paxon's Stats' option in the 'Health' dialogue menu.

-- Attack damage changed. Was previously 4-12/4-12/4-12, is now 2-6/1-2/4-12.

-- Paxon has had maximum strength reduced from 255 to 125. (No, I don't get it either.)

-- Added "Durable Mode" toggle. Gives Paxon 9999 health and 255 strength, but removes any sort of offensive capability. Use this toggle if you just want him to act as a porter. This option may be found in the 'Health' menu, but only when Paxon is at Full Health.

-- Replaced 'Auto-Move' and 'One-Time Move' with 'Swap Places' code. Can be utilized by jumping and activating Paxon, or from dialogue under the 'Move' option.

-- Added code to allow the player to easily put Paxon into 'Wait' or 'Follow' mode by first sneaking, and then activating Paxon while doing so.

-- Improved underwater following code.

-- Improved "AIFix" Script.

-- Paxon water-walks by default unless you are sufficiently underwater. This is to prevent the 'Levitation' spellcast animation used in the underwater code from firing all the time.

-- Code tweaks to try and prevent the 'Swishy Pack Rat' bug that people were experiencing.

-- Added dialogue responses (the "My Pack Rat" topic) based on NPC class.

-- Removed "Packless Pack Rat" .esp from archive. Was confusing to new mod users.

-- Other minor dialogue fixes.

-- I forget stuff, so there's probably other things I added that I am missing.

-- Oh! Right, I added code so that Paxon sneaks with you in a better fashion. I told you I forget stuff.

Version 3.1.7

-- Minor bugfix release.

-- Fixes for some grammatical errors.

-- Cleaned up references to old Globals related to a reworked feature.

-- Fixes to a couple math errors in the level reporting script.

-- 'Mabrigash' class NPCs assigned their correct '- My Pack Rat -' topic response.

-- Added 'One-Time Move' feature back to the mod by request.

-- Tweaks to 'Level-Up' script to reduce script size and improve some calculations.

Version 3.1.8

-- Minor text and bug fix update.

-- Text for NPC class "Champion" under "- My Pack Rat -" was doubled.

-- Menu options for changing "Stay Outside" values were not set correctly.

-- Removed references to defunct global value in various dialogue responses.

Version 3.2.1

-- Text and bug fixes.

-- Script optimizations. The mod should run better overall.

-- Attack damage increased. Was previously 2-6/1-2/4-12, is now 4-12/1-10/5-15.

-- Various stat value reductions for balance reasons.

-- Companion maximum Strength reduced from 125 to 100.

-- Companion maximum health reduced to 200.

-- Companion maximum AR reduced from 175 to 115.

Version 3.2.2

-- Script edit to fix an issue users of "OpenMW" were having with "In-Combat" warping behaviors.

-- Probably some other stuff, I don't know.

Version 3.2.3

-- Script edits to fix additional "OpenMW" issues.

Version 3.2.4

-- Script edit to fix a value being misreported when checking Paxon's stats.


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

7. UPGRADING FROM PREVIOUS VERSIONS

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

Unload Paxon and set him to wander in another cell. Save, then exit the game.

Uncheck the old version and make a new save with the mod unloaded.

(It helps to "clean" your save with an external tool like Wrye Mash at this point.)

Exit the game again, check the updated version of the mod.

Load the clean save, go back to Seyda Neen and collect Paxon again.

... Maybe give the little guy a treat for being a good sport about the whole ordeal.


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

8. Credits

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

Bethseda Morrowind Team -- For making a game that's kept me interested and entertained since 2002.

Ghanburigan, Yacoby, Melian -- Morrowind Scripting for Dummies, an invaluable aid.

Greatness 7, Emma, Grumpy, DinkumThinkum, others -- Various pieces of code, dialogue, information, inspiration, and a host of other things. Thanks, everyone!

EJ-12, AKA HedgeHog12 - Creator of the new Pack Rat model.

UESP.Net -- For being such an amazingly useful resource.

Danae -- Lots and lots of constructive feedback, help testing, and being awesome.

abot -- Helping out with code fixes, the 'bump' script, and generally being a great person.

Lightsourced -- Lots of testing help and constructive feedback. Needs more spoiling.

Judge Dan -- Testing, constructive feedback. Inspired the changes to the underwater code.


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


Any bugs should be reported to me as soon as possible, so they can be fixed.
You can PM me on the NexusMods forums, message me on the Morrowind Modding Discord, or message me on Reddit (as "TizzoHeavy")

This mod may be posted on other sites, provided that the site owner contacts
me for permission or I send it to him/her, and I am credited as the mod author.

Enjoy, and thank you for using my mod!