Working Slaves mod Players Guide ------------------------------ Written in the year: 2023 motnh: 09 day: 03 For version: V2.1 Realise 5 By NonSeen ------------------------------ How to use this documentation file: ------------------------------ I suggest check first the table of content, select the desired topcik then use quick search for it (CTRL+F ). The text made a way that make instant location of requiested topcik. ------------------------------ Table of contenents: ------------------------------ !!!! -sirus warning for special options read it before use this function! !What this mod does: !Word of warnings, important things !!!! How to update - The Update Procces: !QuickGuide - how to use this mod very sort version of all things &&Adding slaves to workplace &&Removing slaves from workplace &&How to disable enemy spawns/npcs in the workplace: &&How to Restore enemy spawns/npcs: &&What is the production &&How to set up production &&Where, when i get production items? &&Can i change the production value? i wih my slaves produce more/less stuff! !WS Player menu !WanderingSlaves !Classic mode in details !Workpalces in details !Production in details !Explanation of addons !Appendix A - Classic wokrplace list !Appendix B - ChestAddon effected location list !Appendix C - Wandering Slaves item collection lists: ------------------------------ !What this mod does: ------------------------------ Makes possible to use anly location as wokrplace, where npcs can be stored and used to do force labor. produce goods for you. System curently support: PAHE, DOM slaves, and can store non slaves too but this very non perfect. With planed extension possible to organize giant orgie up to 20+ actor doing sex. This give production bonus for the next production run by the way. This sex extension make use sexlab or toys framework. ------------------------------ !About the mod files: ------------------------------ i break the mod multiple files to make more flexible, costumizible, and less resource hungry. WorkingSlaves.esp made a way that change 0 record of the origina skyrim so in theory compatible with evrything. WorkingSlaves-ChestAddon.esp is a bit different beast: this one adds new chest to potential workplaces, this means changing original skyrim location records. This may or may not cause compatiblity issues with other mods that may effect the same locations. To see effected locations go see Appendix B WorkingSlaves-FastSlaveTransfer.esp this one complite optional. Chenges how slave transfer working. This addon depends on Diary of Mine and Paradise Halls. Both required to use it, makes possible use a bit faster way to transfer slaves beatwen working slaves and the two supported slavery framework. Other addons avible for download, sort discription what they do can be found in download page. Modules get separate manuals as the modules are complex addons. More on addons in own chapter called: "Explanation of addons" ------------------------------ !Word of warnings, important things: ------------------------------ During design of this mode i fallowed the not limit player what can and cant do. This means i not limit where you can make wokrplace any location can work. This and other function can be used to ruin quests/scripted events ect. I trust the player know what does so no hard limiation on inside the mod to protect the user from self. I made this mod a way that capable restore it self to total 100% default state: that means no quest or script running. (okay one check running if you change locations but its very minimal.) The mod it self disgined light waight as possible, but this not means can be used to break things if miss used. ------------------------------ !Installatio requirements: ------------------------------ Skyrim.esm, i use 1.5.97 version greater or lower version expected to work to! SKSE version matches the skyrim version Supported mods/my mod bascily depends on these but not requiered any of this to be installed: Paradise halls 8.1.6 or greater Diary of mine 4.x.x versions or greater ( as long the old add/remove slave interface not changed!) ------------------------------ !!!! How to update - The Update Procces: ------------------------------ In case you updating new version of the mod please fallow the fallowing steps: 0-make a new separate save before anything done so if something go realy wrong, new version bugged ect you have a fall back point! 1-i suggest move your character near a chest where you can safely store lot of items 2-you need a "WS Acces Player Menu" item in your inventory, you can produce this item in any tamming rack( need 1 leather strip), or pick up from any production chest 3-make the "ws acces player menu" item favorite, latter this going to be important 4-Optional: use the "ws acces player menu" item to open up menu, navigate: settings, classic: chose here: "disable classic mode" option. This disables classic mode, so if you move your character and classic location cleared no new classic workplace tigger, get started. 5-open the player menu( use "ws acces player menu" item) chose the main menu: "Reset" (this options orders complite stop my mod) 5-A- drop the items you not need, but keep the "WS acces player menu" item that flagged as favorite item, if you have multiple workplace you have multiple version of this item now. 6-open agin the player menu, chose: Settings, MenuQuit option. (this resets the menu script message catch, yes the menu it self can be reseted! i not kidding when saying fully resetble :) ) 7-now install the new version files, let them owerite the existing one 8-start Skyrim agin, load save 9-agin open menu, chose: "Start Core", this options sett up the framework for workplaces, if you used before you can enable the classic workplaces 10-go your old wrokplaces and make a new one, the system automaticly detects old slaves, and add to workplace. ---------------------------------------------------------------------------- Updating addon modules: Same as normal update procces! 1-navigate in player menu to addons 2-stop the addon modul you going to update 3-install the new version 4-load game, use player menu, go addons here chose the addon you updated, start core 5-just to be safe stop the addon using player menu, chose addon you updated, chose stop Reset 6-start agin the core Why i need Step 5,6? Well reason is simple: skyrim love store propertys in the save file. if i change a quest propertys during update only way to this changes applyed to your save game is to reset the quest. I made the way all part of my mod that can be reseted and only the player menu run on object reference all other things run on quests so easy to reseted. okay and why i need then first stop the module if need start and reset agin? to make sure no active script running during update. active scripts store data in variables that sad variable may get removed, or changed. this may cause problems. Plese keep in mind modules mai work inside lot different than the base mod wit working slaves. ------------------------------ !QuickGuide: ------------------------------ After installation you have 2 way to activate this mod. Way 1: Clear a classic workplace, then change location, maybe need do 2-3 times but usualy works. ( fast travel other places ) This expected to tigger a classic quest start, if no other mod interfere. Way 2: locate a tamming rack, use 1 leather strip to make a new item called: "WS Player Menu Item" After item made simply activate it. This one pop up the player menu. Here chose: "Start core" then close all menu and inventory wait for notification: "WS Core Started". Now you ready to make own workplaces if you use the " WS Acces Menu" and chose "new WP" option. New workplace only can be made existing location, if location can be cleared then need to be cleared first! On active workplace: system detect any pre placed chest if fail to detect one the system ask you to place one. To do this you given a quest objective, and appropiate Spell(s). To place chest just need cast the chast placed the grund where you standing directly at your feets. Chest orientation copy the player orientation. &&Adding slaves to workplace: After all chest placed you given a new spell called: "WS Manage Slaves" Cast this spell on any npc and npc by added to workplace as slave. Yes ANY NPC. Even works on enemys, but the Test version 0 non perfect. Hostile npcs remain hostile just hostile activitys suspended. The system detects PAHE, DoM slaves and remove them from the frame work freeing up slots there. For DoM slaves need to be patient DoM Slaves complex things need time to procces it. &&Removing slaves from workplace: Just cast the same spell to the slaves. The script do the job in the back grund. For DoM slaves need to be patient DoM Slaves complex things need time to procces it. Removing Workplaces: Use the "WS Acces Menu", workplace option, remove workplace option. All Slaves attempted to give back their source frame work if any. All items that in production chest, or sample chest transported back to you. Al Disabled npc get re enabled. &&How to disable enemy spawns/npcs in the workplace: player menu item , wokrplace, disable npcs option !!!! Word of warnings: -this option only remove 3 closes enemy npc, the script dont care npc is live or dead -this function need a bit of time to run down -the system dont care the npc come from where if enemy to you the npc get disabled -disabled enemys, and corpses get removed no way to acces to it before using this function lootit! ---yes this way possible lose critical quest items. -this function may cause problems with other mods if other mods relay on the npc my code going to disable so use with caution You might wish use more safer option: a spell provided to player that do the same to npcs but can be manualy targeted invidualy to npcs. for more information look here: "Spells:" &&How to Restore enemy spawns/npcs: Curently 2 way to do this: 1 -Remove workplace where the enemy get disabled, this candone by player menu, workplace,restart workplace 2 -restart the whole mod using player menu, restart option &&What is the production: Your slaves do hard work on the workplace and ower time produce things. This production ability simbolized by items goldvalue for simplicity. This gold value used to produce items for you! &&How to set up production: Depends on in classic workplaces you canot set up or change the production from in game. This set to stone, only from outside using creation kit or Xedit ( SSE Edit ) can be changed in normal workplaces you have a sample chest, to make simple to find it i added a quest marker to it. simply put a sample item here ot multiple of items! Slaves start make copy of this items. More item you put here the slaves divide more attention and resources and attempt produce all type of items. This may leads 0 production runs. becuse not enught production value for so many items. &&Where, when i get production items? in the production chest, to make simple to find it i added a quest marker to it. All produced items placed here. Production run by cycles, the cycle time can be changed from creation kit or xedit (sse edit) how to do it explained in advanced user manual. &&Can i change the production value? i wih my slaves produce more/less stuff! open anywhere in game player menu, chose settings, chose production, here you can incrase or decrase the slaves production value. This value calculated by slaves. in other worlds one ( 1 ) slave produce this much value that seen here. ------------------------------ !WS Player menu ------------------------------ Detaild discription how player menu works what option where to find and what does exactly. To open menu need item called: "WS Acces Menu" item, this one need to be in your inventory and activate it. To accquire: go tamming rack use 1 leather strip to make one, or go any workplac look for production chest! Evry production chest has 1! Important note: ALL "WS Acces Menu" item run a script that loads the data they are disaplying. if you wish more resources i sugges use only one of these. if you chose drop this item i sugges before removing inventory go settings, chose MenuQuit option. This option delete the cash data from the script, this may save a littile computing resource. This going to display the Player Main menu Options here: -Exit - close menu system -Start core --start a hidden quest, this quest is my mod center pice that required to run to make use most of the menu options -Settings --mod settings -New WP --order the mod make a new workplace the curent location you are in, if location is cleared this do the job if you have avible workplace quest (final version planed 30 of them (yes 900 slaves storage capacity)) -Workplace --open workplace submenu, where can manage the curent workplace you are in -Reset --resets the mod restore all settings to default and close all active workplace. this one is a 100% resetion of the mod and no component left running. Same tiem this one restore all disabled npc. Priamry use in future for upgrading new version current usage stop evrything. &&Settings Menu: Mod settings, this changes effect how mod behave, and all workplace. Production - production settings Classic mode -classic mode related options Spells-additonal spells can be added/removed MenuQuit-Reset the menu item scriőt you are using, on next time you open up all message box refreshed &&Settings Submenus explained: Production: You can change how mutch gold produced by each working slave. you can incrase or decrase the production value of the slaves. Classic mode: You can enable ( default) or disable the classic mode. classic mode enabled by default for one simple reason: many player may not wish use the tamming rack to get "WS Acces Menu" item. So they can pick up from any production chest that get activated as conquering workplaces. Here is a special option: Validate. This one need a bit of explanation. All location allowed contain only 1 ACTIVE workplace( this is a self made rule by the way :) ). But you can make a active workplace in a classic workplace location, if the classic workplace not active! (workplaces they self can be deactivated any time, see workplace menu) This leads a problem: If classic mode enabled and you made a workplace let say in embershard mine you block the classic embersahard mine workplace activation. It is totaly okay, my system flag this case embersahard mine classic quest dummy/inactive active. in other words flag as activated workplace but not realy activate it. In case you remove your workplace from embersahard mine and wish use the classic workplace... well as Classic Embershard mine quest inactivated you cant start it. Until you use validate function: This function re run a check and make sure all activated classic workplace is running. If find one that flagged activated but the linked workplace not active, set the active flag default, not activated waiting for activation. in other words: make possible to use classic workplaces after they made inactive by a workplace that made the location where classic workplace ment to be made. &&Workplace menu: This one only avible if you are standing in a active workplace! Your dicisions only effect this specific workplace. Exit -go back procvius menu Remove - remove this workplace, realise all workers to their original source if any DisableNPC - Disables 3 closest Enemy loaded npc. Enemy npc = one who wish to attack you if able to. The search for npc run loaded areas. This can be dangerus becuse npcs may outside of the curent cell effected, as that area to loaded! info - Dispaly detailed workplace ifnormation: how many slaves here, how many can, information about production, and production reserve WanderingSlaves - send out a grup of wandering slaves ( R0 version case 1 slave ) tto wander around and locate varius resources. more information about this on wandering slaves section Move product-move the production chest that linked to the workplace you are in, to your curent position and copy your oritention! Useful to move chast around workplace Move Sample- move the sample chest that linked to this workplace to your current location and copy your oritentation! Useful to move chast around workplace Show Slaves - Start a quest that mark 30 working slaves near to you. Same quest that can be started via a spell: Show slaves. &&Spells: add manual/remove manual: add or removes manual npc disabler spell. This spell useful to clean up your workplace from unwanted npc spawn. This spell works any enemy npc that inside your workplace location, no question asked! Works on dead enemys to! The target must have hostile to player. The spell disables the target actor. This means all of the enemy equipment become unavible to you! To roll back this effect you need remove the workplace or restart working place mod. Show Slaves: add spell that as casted start the show slaves quest. On secund cast stop this quest. The quest it self can be started from workplace menu to or stoped from here. The quest it self mark 30 slaves in loaded area and keep it this way as long you let the quest active. The quest detect not only the active working slaves but the ex working slaves to! You can any time stop or start agin the quest so you always going to know where your slaves is. Addons: This option avible only if at least one addon installed. Give acces to the addon functions. this function in a separate chepter get explained in deep detail. look for: "Explanation of addons" in sort give otpion to stop all active addon, this basicly shut down all addons all runing operation and send them a ready to start state. Same as you can order reset in the rest of the mod. if modul avible you will see a 1 after its name. ------------------------------ !WanderingSlaves ------------------------------ 3 Slaves start wander around random locations, they have limite time to do this and collect random leveled items. After time passed the slaves return to the workplace and store all the collected items on prudction chest. The wandering slaves remain part of the workplace, if wokrplace where they assigned removed the slaves returns the player curent position. and give them the items. The slaves collecting varius items full list can be found Appendix C! Wandering slaves wander 72 hours with default settings. and spend 24 hour in single location before move on. ------------------------------ !Classic mode in details ------------------------------ Classic mdoe made mimic the original working slaves functionality of pre difined workplaces a way that comaptible evrything in theory. This mdoe enabled by default, that can be changed in player menu , settings, classic mode. the classic mdoe works as fallows: you player clear a specific potential workplace leave the location this way tigger a location change event... this one start the workplace quest. All classic workplaces has pre difined production list that canot be changed from inside the game, but from outside veray easy to change! Special situation if you made a workplace a location that assigned a classic wokrplace to. This case the linked classic workplace get disabled, and not start but flagged started. This way the skyrim engine not attempt to start that workpalce evry time you change locations and eate this way resources and wastes. To remove this flag need use validate option under settings/classic menu. Validate option restore the flag of active of all classic wokrplaces. Evry other aspect of the classic workplaces are same as the normal wokrplaces. ------------------------------ !Workpalces in details: ------------------------------ Workplace is a quest that linked to a location. You can add the location to: -pahe slaves -dom slaves -non ensalved npcs All slaves shuld be set protected The slaves going to produce you items, as they working. By default they doing sandboxing around where they get added to the workplace. Workplaces fully operational after production chest and sotrage chest added by specific spell that given the player if chest need to be added. After all chest set up player recive the "Manage Slaves" spell this one if casted a non working slave npc the npc get added to the workplace. if casted a active working slave the npc got removed and added back the original source. All wokrplace curently stores: 30 wokring slaves in case you chose to close a workplace fallowing things going to happen: -this location get marked free of active workplaces -all salves stored in wokrplace given back their original framework if any -production chest and sample chest get emptyed all item stored here added back to the player -all disabled npc get re enabled this may tigger npc instant respawn... ------------------------------ !Production in details: ------------------------------ Workplaces production can happen based on sample or based on pre difiend production list. List used in classic workplaces, normal wokrplaces uses sample system: you place any item to the sample chest and as longer sad item in here the slaves attemt to make a copy of it. Production done by cylces, the cycle time calculated in game hours, this can be changed from outside of the game using Xedig or Creation kit, more on that on advanced user guide. After each cycle the system checks what items placed to sample chest or in the production list. the the falowing happen: the system calculate the workplace oweral production value: = ( Slaves number X production value for 1 slave ) *(production bonus if any) then calcualte the current production run value: (oweral all production value ) + ( remaining production value ). Remaing production value come from earlyer production, the unused production value. see later here. now system calulate the item production value = ( curentproduction value ) / (number of item to produce ) this means if you have 10 item to produce the curent production value split beatwen them! now we know how mutch production value goes to one item type, need calucate how many item can be made: produced item number = ( item production value ) / ( item value seen in creation kit ) Now possible we canot use all the item production value or canot produce a item becuse item cost mroe than item production value. this cases the production value added to "remaining production value", this way not wasting any production effort. Palayer can change the slave production value using settings/production menu i think important to note here: if you stop a workplace all curent production value and remaining production value is get wasted. ------------------------------ !Explanation of addons: ------------------------------ I made lot of addon files. This files are complite opcional and change how the working slaves work. Primary reason not include all of the thing in one esp is this: if you not need these functions you not use them, but these functions eat resources. My goal is use only resources when needed as i made this mod and make compatible as possible. For this reasons lot of optional function ended up addon files. Addons are independent to each other and can be used any combination if not stated other whise. There is 2 type of addons: First type is that owerite workingslaves.esp or its functions this way make changes. Secund type is more tricky this one named like this: WorkingSlaves-Addon-XYZModul-Rxx This type not effect directly or owerite the workingslaves.esp. This ones are separate independent modules. Adding the mod complex functions, futures. This addons need separatly started by player and configured like the working slaves mod. To acces this options you need open the player menu, if addon installation detected you see far right a new option: addons. This option used to acces the addons one by one, or stop all at once. Becuse these modules independent mostly from the working slaves base modul, they going to get separate guides. The time of writing i canot tell what mod what going to do. Other modmakers can make addon modules to working slaves, and attach to the existing menu systems. For more information about this pls consult the Modmaker Guide. ------------------------------ !Appendix A - Classic wokrplace list ------------------------------ Clasic workplaces the moment of writing: 1 - Embershard Mine 2 - Silent Moon Camp ------------------------------ !Appendix B - ChestAddon effected location list ------------------------------ 1 - Embershard Mine 2 - Silent Moon Camp 3 - Halted Steam camp 4 - Fort Felhammer 5 - Kolskger Mine 6 - Cracked Tusk Keep 7 - Bilegulich Mine ------------------------------ !Appendix C - Wandering Slaves item collection lists: ------------------------------ Wandering slaves uses leveled lists to generate a random item that they found. Evry wanering slave find 1 item evry visited location. so if 3 slaves visit 2 location they going to find: 3x2 = 6 items Possible items to wanderers find: -All skyrim base game ingridients ( but no quest items ) -all normal solugems and black soulgem, non filled version, this one leveled for blance reasons. lvl 25 player has chance to get black soulgems... -all base game food items.