/***********************************************************************/
/*-------------The Witcher 3 - Leveling Starting Armor Mod-------------*/
/* FOR WITCHER 3 PATCH 1.22 */
/* By: MikeNekro */
/* Modifies the games Starting Armor to Level up with your character */
/***********************************************************************/

�Made with the Witcher III Modding Tool,
developed and released by CD PROJEKT RED
for use with The Witcher III: Wild Hunt. � 2014
and � CD PROJEKT RED. All rights reserved.
Check out the Witcher III Modding Tool here:
[http://redkit.cdprojektred.com/]�

This version is for The Witcher 3: Wild Hunt Patch 1.22

Official Version: v1.4.1

Thank you for downloading Leveling Starting Armor!

This document will go over some important information about the mod and
how to install the mod if you need help.

If you want to run Leveling Starting Armor(This mod) with Leveling DLC Temerian,
Undvik, Nilfgaardian, and Oathbreaker Armor mod(My other mod), you MUST have the
same version of both mods!

Example...
This is good!
Leveling Starting Armor Version v1.1
Leveling DLC Temerian, Undvik, Nilfgaardian Version v1.1
Leveling Oathbreaker Armor Version v1.1

This is BAD!
Leveling Starting Armor Version v0.8.9.1
Leveling DLC Temerian, Undvik, Nilfgaardian Version v1.1
Leveling Oathbreaker Armor Version v1.0

/*****Contents:*****/
-Versions
-Important Information
- What does this mod do?
- Why Create this mod?
- Testing
- Installation

Credits: CD Projekt Red - For the creation of the edited files

Mikenekro - Programming, Editing, Modding the files

If you think the armor should increase at a different rate, let me know
and I can add different rates as well.

NEWS: Update v1.4.0: Compatibility improvments to make any Leveling Armor mod
compatible with any mod released after v1.4.0

Update v1.3.5: Efficiency improvements over v1.3.2
Update v1.3.5: Added Resistances (Might still cause lag but please let me know)

Update v1.3.0: All Versions will now have leveling Starting Swords
as well as a "Witcher Gear" Quality level.
Update v1.3.0: Compatibility for Patch 1.21 added

Update v1.2: Sign Intensity now increases with the Sign Intensity
version of the mod.
Update v1.2: More efficient code should help with anyone experiencing FPS
drop. This may make the Resistance mod work better with some
more testing

Update v1.1.0: The mod has been updated for compatibility with
the newest version of Leveling DLC Temerian,
Undvik, Nilfgaardian, and Oathbreaker armor!

Update v1.0.0: There have been efficiency improvements
in the code with Version v1.0.0 and there
has been enough testing and debugging for
me to feel comfortable calling this version
v1.0.0.

Update v0.8.9: The Glyph (Enhancement) Slots that were added to
the armor in v0.8.7 should now actually work!
There is a weird problem that the game has which
does not allow "old" armor, that you had before
installing the mod, to update its internal
enhancement slots. That meant that the slots
would show but you could not put anything on them.
I went into the code and switched out that item
for a brand new one (only happens the first
time you put a glyph on the modded armor ever).

Update v0.8.8: Before, New Game Plus did not work with this mod
but thanks to haziqhanafiah, I have fixed this
problem. New Game Plus uses different XML files
for the armor so I needed to include the NGP XML
files with the mod for it to work.

Update v0.8.7: The starting armor, pants, gloves, and boots now
all have 3 enhancement slots (for glyphs). I have
also optimized the code more than in v0.8.5. The
resistances mod still needs more work before it
can be released (Resistances causes some major
lagging) but I am working on that.

Update v0.8.5: Items will now level up requardless if they are in your
inventory, or in your player stash. I have also removed
all need for the gameParams.ws script which will allow
more compatibility with other mods. This also reduces
the size of the file.


Update v0.8.0: Added Leveling Starting Pants, Boots, and Gloves
Pants Increase at 2.0 Armor Rating per level
Gloves and Boots Increase at 1.5 Armor Rating per level


/***********************************************************************/
/* Versions */
/***********************************************************************/

This section will go over the different versions of the mod and what is
included with them:


/---------------Base Game Armor Ratings-----------------/

Here is the base (default Level 1) Armor Rating for each piece:
Warrior's Leather Jacket: 30 Armor
Kaer Morhen Armor: 15 Armor
Starting Pants: 4 Armor
Starting Gloves & Boots: 1 Armor


/-------------------Full Set Version--------------------/
The "Full Set" Version of the mod levels up each part of the starting
armor you start with in the game. These are the Chest, Pants, Gloves, and
Boots. The full set version has the Gloves and Boots Armor Rating
increasing by a smaller amount than the Pants and Chest. The Pants are
next with the Chest pieces increasing by the greatest amount. The Chest
pieces include the "Kaer Morhen Armor" along with the "Warrior's Leather
Jacket".


Here is their Armor Rating Per Level (ARL):
Warrior's Leather Jacket: 4.5 ARL
Kaer Morhen Armor: 3.0 APL
Starting Pants: 2.5 APL
Starting Gloves & Boots: 1.5 APL


/------------Armor Only (Chest Only) Version------------/
The "Armor Only" (Or Chest Only) Version of the mod only includes the
Kaer Morhen Armor and Warriors Leather Jacket. This mod is for those who
want the Chest piece to level up but do not care for the pants, boots, or
gloves.

Here is their APL for this Version:
Warrior's Leather Jacket: 4.5 APL
Kaer Morhen Armor: 3.0 APL


/-------Stronger (Boots Pants and Gloves) Version-------/
The "Stronger" Version of the mod is for those who want the Starting Pants,
Boots, and Gloves but also want to have their APL more closely match the
rates of the Chest pieces. The Chest pieces, however, do not get a boosted
APL since I believe adding any more would overpower the armor during the
game.

Here is the APL for the items on this Version:
Warrior's Leather Jacket: 4.5 APL
Kaer Morhen Armor: 3.0 APL
Starting Pants: 3.0 APL
Starting Gloves & Boots: 3.0 APL


/------------------Sign Intensity Version---------------/
The Sign Intensity version of this mod will increase the sign intensity
of the armor every 5 levels. It is combined with the Starting Armor Original
version of the mod.

Here is the Sign Intensity increases on the items:
Warrior's Leather Jacket: 3.5% Sign Intensity Increase every 5 Levels
Kaer Morhen Armor: 2.0% Sign Intensity Increase every 5 Levels
Starting Pants: 2.0% Sign Intensity Increase every 5 Levels
Starting Boots: 2.0% Sign Intensity Increase every 5 Levels
Starting Gloves: 2.0% Sign Intensity Increase every 5 Levels


/------------------Resistances Version------------------/
MIGHT STILL CAUSE LAGGING

The "Resistances" Version of the mod levels up resistances every 5 levels.

For the Version that will first be released, here are the stats:
Warrior's Leather Jacket - Slashing: Base 18%
Adds 2.5% every 5 Levels

Bludgeoning: Base 9%
Adds 2.9% every 5 Levels

Piercing: Base 9%
Adds 2.7% every 5 Levels


Kaer Morhen Armor,
pants, boots, gloves - Slashing: Base 10%
Adds 1.5% every 5 Levels

Bludgeoning: Base 7%
Adds 2.0% every 5 Levels

Piercing: Base 0%
Adds 1.8% every 5 Levels



/***********************************************************************/
/* Important Information */
/***********************************************************************/

/-------------------Spawning Commands-------------------/
The following commands are used to spawn the pieces of armor if you have
sold or lost any of them:

additem('Starting Armor')
additem('Starting Armor 1')
additem('Starting Pants')
additem('Starting Gloves')
additem('Starting Boots')

USING THE FOLLOWING COMMANDS WILL NOT WORK... yet!

additem('Autogen Armor')
additem('Autogen Armor 1')
additem('Autogen Pants')
additem('Autogen Gloves')
additem('Autogen Boots')

/----------------What does this mod do?-----------------/
Leveling Starting Armor modifies some code from The Witcher 3: Wild Hunt
to make the Starting Armor (Kaer Morhen Armor) and the upgraded version
of the Starting Armor (Warrior's Leather Jacket) Level up with your
character. This means that as you level up, the armor rating of both armor
will increase as well. The armors required level will also increase to
give you the sense that it is, in fact, leveling up itself.


/-----------------Why Create this mod?-----------------/
The reason I created this mod is that I thought the Kaer Morhen Armor and
Warrior's Leather Jacket are some of the best looking armor in the game
but I was dissapointed that you could not upgrade the armor past 30. I
also did not want to overpower the armor by releasing a set armor rating
so I started examining the code that we are given to find out if I could
level up the armor with your character.

I have not been able to find sufficient documentation on all of the
functions, methods, and/or inner workings of The Witcher 3: Wild Hunt's
code, so it took me a few days of nothing but reading through each line
of code to get a good feel for how it all fit together. Although I would
still be grateful if anybody has a link to some documentation of the code.

Due to the above, some of the code that I wrote may not be the most
efficient but it should not affect your game at all unless you have
another mod installed that uses one of the scripts that I edited. I will
be looking for more efficient ways to implement the inner workings of
this mod and will update the mod when I find a better way.


/------------------------Testing-----------------------/
This mod has not been tested through a full play through of the game but
I did not edit anything in such a way that any other methods would break.
This means that the only things that will come across the code I have
edited are other items, spawning(loading the game), and leveling up. The
code that was edited was done so in such a way that the only items that
will be affected are the Starting Armor (Kaer Morhen Armor) and the
Starting Armor's upgraded brother (Warrior's Leather Jacket).

Other mods you have installed may make use of some of the scripts I used
so if you have other mods installed that effect the games code make sure
none of the scripts overlap each other. In other words, any mod that is
NOT purely Graphical/Visual, you should look at the scripts in both mods
to be sure nothing is used twice. Some graphical/visual mods might edit
code but i don't regularly mess with graphics so I could be wrong.

If you find anything weird or unusual that happens as a result from
this mod, any bugs, let me know and I will do my best to fix the bug.
Try to keep track of how you ran into the bug and it will help with
debugging.





/***********************************************************************/
/* Installation */
/***********************************************************************/

Most will probably not need this help but I am going to include this just
in case anybody needs it.

If you have trouble installing this mod, refer to this section. If you
still cannot get it to work, let me know and I will do my best to help you.

Steps: Since you are reading this, you probably already unzipped the main
folder but I will put this in here for anyone in question.
-Unzip this mods main folder. Named "StartingArmorMod(Read Txt Inside)".

1. Find the location of your copy of The Witcher 3: Wild Hunt installation
Mine is:
"C:\The Witcher 3\The Witcher 3 Wild Hunt"

Steam should be something like :
"C:\Program Files (x86)\Steam\steamapps\common\The Witcher 3"

GOG Galaxy:
I am not sure about this. But GR00T from the GOG forums says,
"Bottom left of the Galaxy client is a small cog.
That's your settings. You can configure it there,
and also see where the files are DLed".

2. Inside of your main Witcher 3 Installation folder from the step above,
the folder that contains bin, content, and/or DLC, make sure there is a
folder named "mods". If it is not there, create a new folder named "mods"
and open that folder.

You should be at a location similar to:
"C:\The Witcher 3\The Witcher 3 Wild Hunt\mods"

3. Now open the "StartingArmorMod" folder you downloaded
and copy the "modStartingArmor" folder into the "mods" folder.

4. Optional: If you have other mods that might edit any scripts/code,
make sure none of the scripts in that mod have the same
name as any scripts in the Leveling Starting Armor mod.
If, for example, there is a mod that has a "playerWitcher.ws"
file in the folder, one of the mods may break.

If that happens, you can only run one of the mods unless
you convert the scripts to work with each other. If you want
to run both of the mods at the same time, I can convert the
script to work with the mod in question.

5. Run the game and load up your character.

This mod will work on any pre-created characters as well as new characters.