Written in
year: 2022
month: 1
day: 30

Contenet:
In this docuemnt i provide information how SlaversOfSkyrim mod interior working, what parts of mod made as interface.
How other mods expected to interact with my mod.

General information:
All record i added given uniqe editor id to make easy to find:
SLOS
this is put evry record start.

How this thing should work:
i define items, npcs, factions, magic effects and all the leveled list inside slaversofskyrim.esp
cosnider this file is a master file.
To change how things work i create addons to itt that addons owerite how the system work.
I made slaversofskyrim.esp way that make this type of use very easy and support this.
I wish keep script free this main file if script going to added to base its going to happen with addons.
Reason for this high modularty and compatibility.

Possible od conflicts:
Changes to Skyrim:
This mod adds trapdors to tamriel word, very close to some mapmakers.
Bandit faction changed to allies with slaver faction.


items:
i made lot of slaver weapons that specialy enchanted and some armors too.
all cases i prefer use template system.
this means i use a weapon as template and add enchantment to it.
This way if the base weapon get changed by other mods. my weapons get effected to.

In some cases this not good way to work becuse the base weapons not good for the porpuse i plan to use.
This cases i change the weapon and not use the tempalte. This happened with ZaZ.

Leveled items:
i use leveled items and leveled item lists to control item managment, and optional addons ittem effects.
This system may seen complicated and confusing at first but in basic is simple.

All leveled item list start SLOS  this fallowed the list type keyword this can be:
LItem - List of items, this type of list contain items
WTL- Weapon Type List, used to manage weapons that given the characters this fall into subb categorys.
WTLItem[category][type][enchant]-weapon list, contain actual weapons and define what level what weapon put to user hand
[Category] means one handed, two handed, slasher or other special weapon. 
[Type] means what type of weapons in it the list like sword, axe, hammer
[enchant] weapon in this list enchanted this type of enchant
WTLSet[category][type][enchant] Set of weapons, this weapons came from same type. best think this a pacage of weapons that going put into use.
this lists used to make active selected type of weapon lists.
WTLZZZ[category] special list for weapon setts. the weapon set that placed here going to added the slavers or any one that make use slaver weapons.
important to note this added to the mod input lists to as place holder!
so if a mod that get input point not active this take effect, if mod active the input point get overiten by the mod.
WTLSlaver[category] this list contain items that get used by slavers. this exact list referenced by the actors.
this list very special contain other weapon list references, and allow us to use multiple weapon addons at the same time.
mod addon weapon list need added to this lists to take effect.
in example:
this list alway contain a WTLZZZ[category]
at last one addon input point ( and this input point contain a same WTLZZZ[category] reference i case mod not in use)
...
and any other mod addon input point addded in future versions.

Reserved outside interfaces to leveled items:
REserved for any outside mod that can add weapons to slavers:
SLOSLitemOutsideToSlaversArrow
SLOSLitemOutsideToSlaversBow
SLOSLitemOutsideToSlaversDagger
SLOSLitemOutsideToSlaversOneH
SLOSLitemOutsideToSlaversSlasher
SLOSLitemOutsideToSlaversTwoH
IMPORTANT:
This added weapons NOT OWERITE 100% THE ACTUAL WEAPON SETTINGS!
Slavers get at the moment from 3 sources weapons: Zaz, outside, inside weapon lists ( the chosen active ones)
this 3 soruces provide weapons at the same time! 

SLOSLitem that contain zaz or zad in names used to recive items from zaz animation pack and devious devices.

SLOSDeathItem - this items are death items that placed to slavers or slaves inventory in case the actor is die.
Vampire, dreomra, slave and slavers use different item lists. imõportant vampire and dremora only add own special intigrent to list of slaversdeath item list.
if needed can made outside input point to death items at the moment no made.
but zaz and dd has acces point given.

SLOSPackage[slaver type] - pacages are items that specifiled type of slavers recive. this pacage placed all this type of slavers or slaves.
one special package in use: "SLOSPackageSlaverBase" this inserted all slavers inventory.
i made great use pacages to unifromly fill the inventory of all slavers or slaves. All type of actor has own uniqe pacage too.


Actors:
Mod use slavers and slaves. Both get a coresponding uniqe faction.

Hierahy looks as fallows:
SLOSEncSlaver00Template - the root and base all slavers from this template all other slaver recive the factions that in use.
SLOSEncSlaver01TemplateMelle - one handed weapon user template, all one handed weapon user reference this as source template.
This actor add items, outfits,combat style, ai data all other melle fighter template.
This actor add lvl 1 onehanded melle combatants the stats in use.

SLOSEncSlaver01TemplateMelle2 - two handed melle fighters base template. all other 2h figter use this as source for items, combat stlye, ai data, faction information etc.
any change to this lead all other twohanded user get changed.

SLOSEncSlaver01TemplateMagic- mage users base, this define inventory, ai data, etc.
define lvl 1 caster spell list, and stats.
any change in inventory here effect all magic slaver.

SLOSEncSlaver01TemplateHeavyMelle- Define slaver tank basic data, same as others any change here effect all heavy armored slaver tank.

SLOSEncSlaver01TemplateMissile- Slaver Archers base, any change here change all other archers inventory, outfit etc.

SLOSEncSlaver01SlasherTemplae- Slasher definitation all slasher take from here the inventory, ai data etc...

Logic behind the hierarchy:
6 class exist for most slavers, vampire slavers has 7 class.
class 01 come with lvl 1
class 02 come with lvl 5
class 03 come with lvl 10
class 04 come with lvl 15
class 05 come with lvl 20
class 06 come with lvl 25

This can differ in special cases like: Slaver bosses, vampires, dremoras.

Evry level has a tamplate that define the spells and statistic for that level actors.
then the actors that actualy get put the game. all actor depends on the template.

all actor then put the leveled character sublist:
SLOSSubCharSlaver01Melle1H - onehanded class 1 actors put here. this has 2h variant and all other version of slaver one sublist.

then all the sublist colected by a master list like this:
SLOSLCharSlaverMelle1H
This list contain all slaver that melle one handed with in leveled.
this list referenced a actor that actualy placed into skyrim:

SLOSLvLSlaverMelle1H
this return a leveled actor that use one handed weapon.

if one create new mod i very strongly suggest create for start own interface actor.
This actor need reference this type of actor as template and take all atribute from my list.
Then use this actor as base for other works inside your addon.

Reason for this: if i change something inside SlaversOfSkyrim.esp not going to effect your mod radicaly.
only need re link the actors and evrything going to work.