===============================================================================
| Potion Renamer |
| A Morrowind Mod, Version 1.0 |
| by Necrolesian |
===============================================================================

-------------
Description |
-------------

This mod renames potions so that they'll sort rationally in the inventory,
first by effect and then by quality. The naming scheme is basically identical
to BTB's scheme in BTB's Game Improvements, with a couple tweaks/additions.

Potions' names in vanilla Morrowind are all over the place, though they
generally follow the format of "(Quality) Potion of (Effect)". This makes it
tedious and time-consuming to find the potion you're looking for.

The new format for standard potions is "(Effect), (Quality)". Potions will now
sort alphabetically by effect, making it much easier to find a particular
effect.

Quality terms have also been tweaked; "Standard" has been changed to "Normal",
and "Exclusive" to "Special". This means that potions of a given effect will
sort alphabetically by quality, from lowest to highest. Potions that only come
in one quality do not have a quality descriptor at all; the name of the potion
is simply the name of the effect.

With one exception, unique or otherwise special potions have not been renamed.

In addition, two tweaks have been made to the naming scheme for convenient
sorting, both of which can be disabled in the Mod Config Menu.

First, alcohol potions have been renamed so that they all sort together in the
inventory. In vanilla, alcohol is scattered all over the place. With this mod's
default settings, the naming format is "Alcohol, (Name)".

Second, "spoiled" potions have also been renamed. In vanilla, these potions'
names generally follow the format "Spoiled Potion of (Effect)" - though a few
of them have a slightly different format - which means all spoiled potions
cluster together in the inventory. This mod, with default settings, renames
them to "(Effect), Spoiled" so spoiled potions will sort with other potions of
their (positive) effect.

This mod uses MWSE-lua to effect its changes. Only the names of potions are
changed; potion effects remain as they are in vanilla or whatever mods you're
using. No other changes are made to the game, and mod-added potions are not
affected.

The archive contains a spreadsheet listing each potion with its name in vanilla
and with this mod.

---------------
Configuration |
---------------

The Mod Config Menu allows you to disable the mod entirely if you wish. The
mod's renaming of alcohol and spoiled potions can also be disabled separately.

In addition, the MCM contains a blacklist feature; individual potions can be
added to the blacklist, which will disable renaming for those specific potions.
If you're using another mod that changes potion effects such that this mod's
name is no longer accurate, you can add the affected potions to the blacklist
so the other mod's name for them will be used instead.

--------------
Installation |
--------------

Use a mod management tool such as Wrye Mash, or just copy the MWSE directory to
your Data Files directory.

--------------
Requirements |
--------------

This mod requires MGE XE and the latest version of MWSE 2.1. Just install MGE
XE and run MWSE-Update.exe to download the latest build.

---------------
Compatibility |
---------------

This mod is compatible with almost everything, except for other mods that
change potion names via MWSE-lua. It is compatible with plugin mods that change
vanilla potions, though such mods' changes to potion *names* will be overridden
by this mod - it might be necessary to add potions to the blacklist in this
case to avoid inconsistencies.

There's little point in using this mod with BTB's Game Improvements, since
BTBGI includes basically the same naming scheme and changes the effects (and
thus names) of many potions besides. However you could blacklist everything
except alcohol to have the alcohol-renaming effect of this mod alongside BTBGI.

-----------------
Version History |
-----------------

Version 1.0 - 2021-05-25
- Initial release.

---------
Credits |
---------

This naming scheme was implemented by BTB in BTB's Game Improvements. I just
added a couple tweaks and implemented it in MWSE-lua.

---------
Contact |
---------

Feel free to contact me on the Nexus with any comments or suggestions. You can
also find me on Discord as Necrolesian#9692.

-------
Usage |
-------

You can use this however you want.