Ring Swapper 1.0
         
                           by CDCooley
                            2016-06-04

                               for
                    The Elder Scrolls V: Skyrim

                           Requirements:
                       SKSE 1.7.2 or higher

                    "Left Hand Rings" by duggelz
                                OR
               "Left Hand Rings Modified" by Homercide

               "Left Hand Enchanted Rings" by juf0816
                     (for the enchanted version)

    

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

Do you love the simple Left Hand Rings from mods by dugglez, 
Homercide, and juf0816 but don't like that you have to find a 
forge just to switch which finger the ring fits?

This mod allows you to equip common rings, their standard enchanted
versions (if using juf0816's mod), and even player-enchanted common 
rings on either hand using the same controls you normally use to 
equip spells and weapons in the left or right hand (or with the
LeftEquip control only when unequipping the ring if using the 
alternate version.)

You will need one of the Left Hand Rings mods to actually provide 
the rings because all this mod does is allow you to swap them 
without using the crafting system.

This works with either the original Left Hand Rings mod or any of 
the variations of the Left Hand Rings Modified and the Left Hand 
Enchanted Rings mods. The variations of those mods are designed
for compatibility with other mods so hopefully you can find a 
version that works for you.


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

INSTALLATION INSTRUCTIONS

There's an FOMod to help with installtion for NMM and MO users, but
if you use Wrye Bash or want to manually install the mod here are
the descriptions of what's in the various folders.

There are two ESP files and two scripts. You can choose either ESP
and either script (but only one of each). There's also an optional
configuration file to force SkyUI to display the ring icons.

Use the ESP from the "01 Common Only" folder if you only have 
either "Left Hand Rings" by duggelz or "Left Hand Rings Modified" 
by Homercide.

Use the ESP from the "01 Enchanted Too" folder if you have one of 
the core "Left Hand Rings" mods and "Left Hand Enchanted Rings" 
by juf0816 too.

Use the script from the "02 Auto-swap on Equip" folder if you want 
rings to to act like weapons and automatically swap to match the 
hand based on which equip control you used. That means you have 
to unequip them with the same control or they will swap positions.

Use the script from the "02 Swap on Left Unequip" folder if you 
want rings to always equip to the hand they currently are marked 
to use and swap hands only when you use LeftEquip to unequip them. 
I use SkyUI's favorites groups and I found it annoying when I would 
accidentally swap a ring between hands and it would automatically 
get removed from my favorites groups. So this version of the script 
makes swapping rings by accident less likely.

Use the "03 SkyUI Ring Icons" folder if you want SkyUI to display
and recognize Left Hand Rings as rings. (This option installs a 
custom config.ini file in Data/Interface/SkyUI which shouldn't be
a problem unless you are already using a custom config.txt file.)


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

KNOWN PROBLEMS AND LIMITATIONS

Swapping rings between hands removes their Favorite status.

Enchantments and custom names are transferred to the new rings
but the system isn't flawless. Save the game before attempting
to swap a newly enchanted or named ring just in case.

Player enchantments might not trigger after swapping a ring 
between hands and you might have to unequip and re-equip the
ring again to get the enchantment effect to work.

Only common rings provided by the Left Hand Rings mods will swap.
Rings from other mods and Dawnguard do not swap automatically.

The SkyUI config.txt settings don't change icons on the crafting
menu. And the file is for version 5.1 of SkyUI, if you're still 
using an older version you should upgrade. (And if you haven't
upgraded because you don't like the new crafting menus, use the
SkyUI-Away craftingmenu.swf to restore that menu with version 5.1
so you also get the various 5.1 bug fixes and extra features.)


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

KNOWN AND POTENTIAL MOD CONFLICTS

This is not compatible with "Immersive Jewelry" by Forteverum. 
Immersive Jewelry already has a ring swapping script of its own.

Since swapping rings removes their Favorite status it will also
remove them from SkyUI's favorite groups.



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

ADDING SUPPORT FOR MORE RINGS FOR YOURSELF

If you're interested in modifying this to support for more rings 
yourself it's not too hard. At least not the part about swapping.

You just need a matching pair of rings and add the right-hand ring 
to the CDC_RightRingsFL FormList and the left-hand ring to the 
CDC_LeftRingsFL FormList in the same position. (The two lists must 
always be the same length and have matching rings in each position!)

There are just two complications.

1. You'll need to "esm-ify" the plugins with rings you want to
add to the lists because the Creation Kit won't allow you to
patch normal ESP files with another ESP.

2. The difficult part is creating the matching left-hand rings.
And for that I have no advice since I don't have a clue how that
is done. That's why I built this around the Left Hand Ring mods.



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

CREDITS AND LICENSING

This mod contains a modified version of the ring swapping script I
originally created with Forteverum for Immersive Jewelry. 

Do not upload this to other hosting sites. It is a Nexus exclusive.

If you want to create and publish a modified or extended version of 
this mod, contact me.

Charles Cooley
cdcooley@fastmail.us
cdcooley on the NexusMods and Bethesda forums