Name: MessageLogger
Version: 1.0
Date: 1/21/2015
Category: Utilities
Requirements: Oblivion Patch 1.2.0.416, Oblivion Script Extender (OBSE) v20 or later
Author: Tiawar


Description
===========
A plugin for OBSE which logs error and warning messages from the game engine to a text file.
This may help users and MOD authors to find errors and problematic settings including missing master files,
missing meshes, missing animations, invalid assignments in the CS, script errors, and many more.


Details
=======
Both the game and the construction set use a so called 'MessageHandler' class to give feedback about errors,
warnings, and other things. While the CS usually shows normal Windows message boxes, the game logs all messages
to log files... Or it would, if the MessageHandler in Oblivion.exe hadn't been almost completely disabled in the
release version of the game.
This plugins attempts to bring back the logging functionality.
There are basically 5 logging 'channels' for errors, warnings, debug messages, program flow messages.
(The name of the 5th channel is not known.)
An INI file allows you to filter specific channels and to add less helpful messages to an ignore list.
Additional (optional) hooks can help making specific messages more helpful by adding editor IDs from the CS, etc.

When installed, the plugin will output a text file called 'MessageLog.txt' in the Oblivion game folder.
You can examine the contents of the file after finishing the game or after a crash and check its contents for problems.
Each logged line has the following format:

date time [source address] [message type] message

The source address specifies the address in Oblivion.exe from where the message was sent.
This address can be added to the ignore list in the INI file to disable messages from that particular source.


Install
=======
1. Extract the files to a temporary location.
2. Copy the files in the Data folder to (install folder)\Oblivion\Data\


Uninstall
=========
1. Delete the files/folders associated with the mod.


Configuration
=================
Configuring the INI file allows you to specify what kind of messages you want to have logged and enable/disable
certain additional features.

See "INI Configuration.txt" for details.


Incompatibility
===============
Loading editor IDs will conflict with 'RuntimeEditorIDs' (http://www.nexusmods.com/oblivion/mods/40132/?).
If you are using this MOD, disable all editor ID loading in MessageLogger's INI file.

Unfortunately, the editor IDs loaded by RuntimeEditorIDs will not be shown in logged messages since
the MOD only hooks the 'SetEditorID' function but not 'GetEditorID' (which is hard-coded to return an empty string).


History
=======
1.0, 2015/01/21 - Initial release.


Credits
=======
Thanks to the OBSE team for the Oblivion Script Extender.
Thanks to Bethesda for creating Oblivion.
Thanks to TESNexus.com for the a one-stop-shop resource for authors and players.
Thanks to LHammonds for the Readme Generator this file was based on.


Legal
=====
This mod is provided as "is".
The author is not responsible for any damage done to your save game, game installation
or even your computer (though such an event happening is highly unlikely).
Use at your own risk.