Name: Custom Spell Icons
Version: 3.1
Date: 8/4/2009
Category: Miscellaneous
Requirements: Oblivion Script Extender (OBSE), MenuQue
Author(s): statttis

Description
===========
Mods have added so much variety to magic in Oblivion. Between Midas Magic and LAME, I can easily have 30 different unique script effect spells. Problem is, they all have the exact same icon. This mod solves that problem.


Details
=======
Diverse Icons:
There are now new icons for hundreds of spells from the popular mods Less Annoying Magic Experience, Supreme Magicka, Midas Magic, and Race Balancing project. If you have any of these mods loaded, icons will automatically be assigned for them.

Assigning Icons:
There is a new button in your spell menu list, next to "Spell Effectiveness". Click the button and icons will pop up to the right of your spell list (click the button again to hide them). Click on an icon to assign it to your current spell. There are hundreds of available icons; you can scroll through them with the arrows to their left.

To set the icon of a spell in any other menu, select the spell. Then put your mouse cursor over any item/spell in your inventory and press the 'I' key (this can be changed).
You can use this feature in any menu that lists items or spells, so you can use icons from the stuff merchants are selling, or from diseases, or race abilities, or items in a container, or...
To restore the icon of a spell, select the spell. Then go into your inventory and press the 'O' key (this can be changed).

CustomSpellIcons.ini:
Modify this file in the data folder if you want to change the keys for setting or clearing spell icons. Instructions are in the file.

For Modders
Instructions to add custom icons to your mods can be found in the included "CSI-Modders.txt" file, as well as the readme included with the CustomSpellIcons.dll plugin.


Install
=======
Requires OBSE v18 or newer! Get it here: http://obse.silverlock.org/

Requires kyoma's MenuQue for the icon selection menu to work. Get it here: http://www.tesnexus.com/downloads/file.php?id=32200
MenuQue is not required to use this mod, but you won't get the icon selection menu without it.

1. Copy the included files to \Oblivion\Data. Check that the following files have been installed:
CustomSpellIcons.esm
CustomSpellIcons.ini
Scripts\CSI_LAME.ini
Scripts\CSI_Midas.ini
Scripts\CSI_Misc.ini
Scripts\CSI_RBP.ini
Scripts\CSI_SM.ini
OBSE\plugins\CustomSpellIcons.dll
Menus\prefabs\iconlist.xml
and this folder:
Textures\Menus\Icons\CSI

BAIN users warning: BAIN does not currently support installing OBSE plugins, so you will have to do that manually.

2. If you want to change the keys used, open CustomSpellIcons.ini in \Oblivion\Data and modify the settings it contains.

3. Activate the .esm with Wrye Bash, OBMM, or the Oblivion launcher.


Uninstall
=========
1. Delete the installed files.

Incompatibility
===============
None.

Known Issues or Bugs
====================


History
=======
3.1 7/2/2010
- Fixed texture format error that caused problem for lower texture settings.
- Fixed a couple bugged icon paths.
- More icons.
- New icon selection menu.
3.0 6/10/2010
- New OBSE plugin handles icons.
- Some features made unnecessary by plugin and new icons; removed them.
- 250+ new icons included and automatically assigned.
- Improved documentation.
2.4 5/20/2010
- Added ini-like support.
- Fix to spell purchase icons.
2.3 5/10/2010
- Fixed a bug where newly added spells didn't show a custom icon in the magic menu.
- Added a bunch of new additional icons. Many thanks to albertovizoso for making new icons and to gdarknight for allowing his icons to be used as a resource.
2.2 1/3/2010
- Changed names of icon items for better inventory ordering.
- Fixed bug with adding/removing icon items.
- Added string cleanup where appropriate. Not sure if it was causing any problems, but better safe than sorry.
- Moved .ini file for easier BAIN installation.
- Merged CustomSpellIcons.esp into the master file to free up load order spot.
- Set Icon spell is hidden by default.
2.1 ?/?/2009
- Bug fix for 0 magnitude effects.
- Can no longer set an invalid icon.
- Custom icons show in spell purchase menu.
- Removed unnecessary removal spell.
- Fixed error with fQuestDelayTime that caused slow icon setting.
- Changed key press detection to OnKeyDown; codes in .ini changed accordingly.
- Eliminated need for extra .esp for Cobl options.
- Made 23 unused icons from Oblivion textures available as custom icons.
- Made it much easier for modders to add custom icons to their own mods. Using the power of OBSE v18, you don't need the .esm as a master and it only requires a 2 line script.
2.0 8/4/2009 - Version 2.
1.0 7/31/2009 - Initial release.

Contact
=======
You can find me on TESNexus and gamesas.com forums as 'statttis'

Credits
=======
Thanks to the OBSE team, without their hard work on OBSE this mod wouldn't be possible.
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.
Thanks to albertovizoso for providing new spell icons.
Thanks to gdarknight for providing new spell icons.
Thanks to Ranokoa for the textures resource.

Tools Used
==========
Oblivion Script Extender (OBSE) - http://obse.silverlock.org/
TES4Edit - http://www.tesnexus.com/downloads/file.php?id=11536
TES Construction Set - http://www.tesnexus.com/downloads/file.php?id=11367
Readme Generator - http://lhammonds.game-host.org/obmm/tools_readme_generator1.asp

Licensing/Legal
===============
You can do whatever you want with this mod.

Diverse Icons:
There are now new icons for hundreds of spells from popular mods: Less Annoying Magic Experience, Supreme Magicka, Midas Magic, Race Balancing project, Oscuro's Oblivion Overhaul, and Elsweyr Anequina. If you have any of these mods loaded, icons will automatically be assigned for them.

- Improved documentation.

Just awesome. Thanks for the release! I'd guess there's no need for a clean save if updating from v2.3? Or is safer to do that?

Does this mean it comes with the guide of how to use the custom icon path function for personal mods? I haven't actually used this because I can't figure out whether should I or should I not load the esm along with the mod

You don't need the esm anymore, just the .dll file. Example code from the readme:

if (IsPluginInstalled "CustomSpellIcons.dll")    if (doOnce == 0)        set doOnce to 1        SetSpellIcon MySpell1 "MyFolder\MyIcon1.dds"        SetSpellIcon MySpell2 "MyFolder\MyIcon2.dds"        SetSpellIcon MySpell3 "MyFolder\MyIcon3.dds"        ;etc    endifendif

A clean save shouldn't be necessary, though it's always safer to do so. Just be aware that version 3 is a total rewrite so you will lose any icons assignments you made previously. That shouldn't be too much trouble, since icons are now auto assigned for about 500 spells.

Getting icons for all those spells is great, but is there a way to assign icons for spells that don't get them?

Thanks! It seems to work just about perfectly. I get custom icons for all SM spells my char has and also for most MM spells. I don't get custom icons for Midas Tornado and Midas Grand Lightning Bolt, though, even though I noted that they are listed in the CSI_Midas.ini. BTW, tried a clean save to check if it made any difference but it didn't.

Getting icons for all those spells is great, but is there a way to assign icons for spells that don't get them?

I commented on the Tesnexus thread, but I'll do so here as well - can you think of any reason why the game would simply fail to start when I have this .esm enabled? It freezes when the loading screen for the title menu comes up...

I do have the latest version of OBSE, if that helps.

Ah, the first bugs
The tornado icon name is mismatched, and it looks like I entirely missed the grand lightning bolt.

I commented on the Tesnexus thread, but I'll do so here as well - can you think of any reason why the game would simply fail to start when I have this .esm enabled? It freezes when the loading screen for the title menu comes up...

I do have the latest version of OBSE, if that helps.

What Raestloz said. Or perhaps it's caused by CustomSpellIcons.esm loading before Oblivion.esm? CustomSpellIcons.esm has a rather early dating. If so, use Wrye Bash, OBMM or BOSS to manage the load order.

What Raestloz said. Or perhaps it's caused by CustomSpellIcons.esm loading before Oblivion.esm? CustomSpellIcons.esm has a rather early dating. If so, use Wrye Bash, OBMM or BOSS to manage the load order.

Is it possible to add in the PC,s inventory a bag with icons from which to choose?

Errm, my spell icons are messed up, like its static-y. Does your pack work with games that use medium sized textures?

For middle-range and lower resolution settings, Oblivion will have to resize the icon, which may look bad. However, you may provide resized versions yourself, at 80%, 75%, and 50% the size of the original icon - this may improve the quality of the icon at lower resolutions because image editors are capable of much cleaner resizing than Oblivion is.

Could you clarify how you go about setting icons for spells that aren't done automatically? Do you have to purchase the spell now? I used an earlier version of this mod and I thought there used to be something in your inventory or a menu option or something that installed a whole bunch of icons to choose from. Now when I select a spell and press "i" nothing happens. I think the plugin loaded correctly because I do see some new icons - I'm running Supreme Magicka. Also the obse log reports that the dll loaded correctly... I'm not running pluggy - I hope that's not required.

Also, is there a custom icon for Wizard's Fury? I don't have that spell yet... If not, could you create one? I'd like to be able to tell that one from a regular fire spell.

This is a fabulous mod. I love the new icons already

I used an earlier version of this mod and I thought there used to be something in your inventory or a menu option or something that installed a whole bunch of icons to choose from