=====================
Kyoma's Spell Renamer
Version 2.0.5 Basic
=====================

Forum thread
http://www.bethsoft.com/bgsforums/index.php?showtopic=931763

1. Description
2. Installing, Updating and Requirements
3. Version History
4. Known Issues
5. Contact and Feedback
6. Credits

==============
1. Description
==============

Do you like having your spells sorted according to school and level? Do you like it when you can quickly see what the level and magic school is for a spell? If so, then this is the mod for you. It adds prefixes to your spells and those on spell merchants. What kind of prefixes are added is up to you. You can have the spell's school and level, or also it's strongest effect. And several ways to seperate the prefix from the spell. To configure the sorting mode, change the settings in the "Kyoma's Spell Renamer.ini" file. You can find a full list plus examples of different sorting modes in that file.

This version is a reboot of the 'Spell Renamer' series and goes back-to-basics. If you were using an older version and had a slight lag when using it, you should definitely try this new version. The possible performance hit has been reduced to (almost) zero.

To rename a custom spell, simply highlight the spell and right click on it. A menu will pop up where you can type the new name. After you're done you can either click the Done button or press the Enter key. If bSkipRenamed is on you will also be able to unmark the spell in this menu , assuming it was marked earlier.

***Modders Note***
If you are changing the names or the school/mastery level of a spell, the Spell Renamer does not know it needs to recheck it for the correct prefix. It's not a big problem since it will always recheck after a game load but it can be annoying. As a modder there is something simple you can do to help Spell Renamer. It doesn't mean you'll need Spell Renamer as a master plugin, it doesn't even mean you have to be using Spell Renamer. All it requires is OBSE v16 or higher, if your mod doesn't need v16 you can make this addition optional by checking for OBSE's version first. Just place the lines below after the code where you change a spell. Keep in mind you need to use a MyQuest.spellRef syntax as it will be run in the console (and there are no variables in the console itself).

If you're only changing a single spell you can put these two lines in your script.
RunScriptLine "set SRQuest.pSpell to "
RunScriptLine "set SRQuest.iRecheck to 1"
Or if you're changing multiple spells per frame you can use this instead. That will cause Spell Renamer to recheck all spells.
RunScriptLine "set SRQuest.iRecheck to 2"
******************

========================================
2. Installing, Updating and Requirements
========================================

* Copy the esp and ini file to your data folder. This mod requires:
- OBSE v0016. You can find the latest version at http://obse.silverlock.org/.
* If you're using an version below v2 of this mod, make a clean save first.

==================
3. Version History
==================

2.0 and up

2.0.5
* Moved most of the script to a token as a workaround for the 2 seconds delay at startup. (Thanks to SkyRanger-1 for the tip!)
2.0.4
* Fixed Enter key stayed disabled after the manual rename menu.
* Added some code to help determine the NULL-prefix problem.
2.0.3
* Added two new options: bSkipCustom and bSkipRenamed.
* Fixed getting a new line when pressing enter in the renaming menu. Now pressing enter is the same as clicking the Done button.
* Spell menu will be refreshed after renaming a spell.
2.0.2
* Really fixed the bug this time.
* Added function for modders to signal Spell Renamer to recheck a spell or spells if they changed something.
2.0.1
* Fixed bug where some scripted spells with a dummy effect (to give it an icon) were incorrectly sorted.
2.0
* Rewrote the entire mod and stripped all the excessive features. This version is going back-to-basics.
* Merged and stripped the previously seperate Addon. Now it can only rename player made spells.

===============
4. Known Issues
===============

* When you have a lot of spells in your spell book (above 100) you will get a slight lag the first time you open the spell book after a game load. This is not a bug with Spell Renamer itself but more with how Oblivion handles changes to the spell list. Because after a game load all spells get a prefix, the entire list is updated the first time you open it after the sorting is complete. It only happens once after a game restart cause spells keep their names (prefixes) between game loads.

=======================
5. Contact and Feedback
=======================

Should you have any questions or comments you can PM me (kyoma) at the Elder Scrolls Forum or post in the forum thread (see top of readme). Alternatively you can email me at [email protected]

==========
6. Credits
==========

* The OBSE team, without them this mod would even exist!
* bg2408, for coming up with the L.A.M.E. style sorting and organizing all of the abbreviations for me :D
* SkyRanger-1, for the many bugreports and suggestions.
* All the other people that gave feedback and helped me with problems (sorry, just don't remember all the names :P)