===================================================================================================
Weapon and Armor Etching
AUTHOR: Lord Zapharos (www.lordzapharos.com)
DATE: 26 November 2021
VERSION: 1.2
===================================================================================================


LICENSE AND CREDITS:
===================================================================================================
Creative Commons Attribution 4.0 International (https://creativecommons.org/licenses/by/4.0/)

You are free to share and transform this work (commercially or otherwise) provided you give proper
credit to Lord Zapharos, provide a link to this license, and indicate if changes were made.


DESCRIPTION:
===================================================================================================

There are a lot of excellent armor and weapon mods for Skyrim. However, one drawback of using these
mods alongside Requiem is that the latter mod relies on item keywords for core game mechanics. For
example, a mod-added sword (even with high damage) will be fairly useless against Dwarven machines
unless it also has the daedric keyword. This means that many cool-looking weapons cannot be used
reliably throughout the game.

This mod addresses the problem via a SkyProc patch. The patch examines every weapon and armor item
in your load order and automatically produces "etched" versions of that item, complete with the
smithing recipes to create and temper them. Within Skyrim, your Iron Sword of Awesomeness can then
be taken to any suitable forge and converted into one of the following:

 - Iron Sword of Awesomeness (Silver)
 - Iron Sword of Awesomeness (Orcish)
 - Iron Sword of Awesomeness (Glass)
 - Iron Sword of Awesomeness (Ebony)
 - Iron Sword of Awesomeness (Dragonbone)
 - Iron Sword of Awesomeness (Daedric)

Similarly, your Leather Armor of Amazement can be transformed into:

 - Leather Armor of Amazement (Glass)
 - Leather Armor of Amazement (Dragonscale)

and your Steel Armor of Incredible Things can be reforged into:

 - Steel Armor of Incredible Things (Orcish)
 - Steel Armor of Incredible Things (Ebony)
 - Steel Armor of Incredible Things (Dragonbone)
 - Steel Armor of Incredible Things (Daedric)

The damage, value, and weight of all etched items are adjusted to suit the desired final material,
and the appropriate keywords are added to ensure that your cool-looking iron sword can finally hurt
Dwarven constructs in Requiem.

Within your inventory, etched items will look as though they have already been enchanted; however,
you can still enchant and temper them just like any other smithed item. You CANNOT "re-etch" an
item e.g. from (Ebony) to (Daedric), so make sure it's really the material you want!

Smithing perks are REQUIRED to smith or temper etched items in game. If you are using any mod that
changes perks, just make sure that the vanilla smithing perks still exist in your skill tree (even
if the effects of those perks have been changed by another mod). Otherwise, this mod should be
compatible with everything.


EXTENDING THE PATCHER:
===================================================================================================

If you have another mod that introduces new "equivalent materials" (Immersive Armors does this with
IAK_Iron, IAK_Steel, etc.), any new items with those keywords might not be detected by this patcher
and thus no etched items will be created. In such a case, you need to modify the SkyProc patcher to
include and process those materials. This process only requires a little Java experience and I have
included the complete source code of this project to make your task easier. All of my own code is
clearly documented and should be easy to understand for performing minor tweaks. If your project is
more complex, consider looking at the SkyProc tutorials online.

To edit SkyProc source code, you will need the Java SDK installed on your computer. An IDE such as
Eclipse (free!) can be helpful. The main project folder is "skyprocstarter". To build this folder,
you will need to add "skyproc" as a contributing source and also include the libraries "lev.jar"
and "WinRegistry.jar" (also included in the source). Eclipse users will need to choose the "package
dependencies/libraries into file" option when creating their file via "Export --> Runnable JAR".


REQUIREMENTS:
===================================================================================================

Skyrim Legendary Edition
Java
Requiem 1.9.4*
Immersive Armors**

* other versions will likely work; this prerequisite can be removed by editing the SkyProc source
** optional (see below)


CHANGE LOG:
===================================================================================================

1.2     Fixed recipes e.g. Ebony (Silver) weapons now require ebony ingots (not silver) to temper

1.1     Daedric and dragonbone weapons are now etchable; reduced all damage penalties for silver

1.0     Initial release


UPDATE INSTRUCTIONS (to any version from v1.0 or from v1.1):
===================================================================================================

Follow the regular installation instructions below, overwriting all files. Then re-run Etching.jar
to generate a new WeaponArmorEtching.esp file. The new .esp file should already be active and will
remain in the correct load order after updating.


INSTALLATION:
===================================================================================================

1. Copy the "Data" folder from this directory to your main Skyrim directory (this is usually found
   in "C:\Program Files (x86)\Steam\steamapps\Skyrim"). If your load order contains Immersive
   Armors, rename the "Data_ImmersiveArmors" folder to "Data" and copy that instead.
2. Run Etching.jar by double-clicking on it (Java is required!), then follow the instructions.
3. Activate the generated WeaponArmorEtching.esp (this ABSOLUTELY MUST be loaded AFTER your
   "Requiem for the Indifferent" patch!).

To uninstall, just remove the added files and deactivate any WeaponArmorEtching plugin you created.
This mod does not use scripts, so you can uninstall at any time (any etched items you possess will
be lost by doing so, however).


SKYRIM SPECIAL EDITION USERS:
===================================================================================================

This mod was designed in Skyrim Legendary Edition and WILL NOT WORK with Skyrim Special Edition. If
you decide to convert this mod to work in Skyrim Special Edition, I would be happy to bundle your
converted version with this mod and give you due credit -- just send me your conversion.


MY OTHER MODS:
===================================================================================================

Arrows to Ingots
Better Low-Level Illusion
Dragon Souls Experience System
Finders Keepers (Better Stones of Barenziah)
Guild Ranks and Progression
Inigo Avoid All Combat
Lord Zapharos Default Outfit Changer
Lord Zapharos IO Utilities
Lord Zapharos String Utilities
Necromancy is Hated
Save and Load Cells: Jaxonz Extension
Spriggans Fear Nettlebane
TDF Equipment Restrictions for Duelists and Assassins
The Legendary Red Eagle
Useful Requiem Beverages
Vilja Avoid All Combat
Wait I Know You Bug Fix
Weapon and Armor Etching
Whispering Fang Unarmed Combat
