New Resources - kinggath/WorkshopFramework GitHub Wiki

New Resources

How to Create a New Workshop Item

Creating new workshop items is fairly simple. The best way is to take one of the existing and modify it, but I'll outline the most important things here. This assumes you have some basic knowledge of creating forms - if you don't, I'd recommend the Builder's Toolkit - which has a lot of information for beginners to get started on creating mods (even though the Builder's Toolkit is Sim Settlements focused, you'll learn tons of re-usable skills for modding other things).

  1. Must have the script WorkshopObjectScript attached, and at bare minimum the WorkshopParent property needs to be set. This means that Static types cannot be workshop items that alter values.
  2. Must have the actor value WorkshopResourceObject set to 1.

As long as those two things are true, then any of the workshop values described below can be added to the item to alter the way the settlement functions!

List of Workshop Level Values

Each of the below is available as a as resources for use on new workshop objects with the prefix "WSFW_WorkshopAV_".

They are also available as Globals with the prefix "WSFW_Workshop_", and finally they are available as workshop reference variables - see explanation under Settlement Level Options section of Editing Workshop Formulas for using those variables.

Any marked in italics are not available as resource values.

TODO: Document how each of these works in the grand scheme of things.

  • minProductivity
  • productivityHappinessMult
  • maxHappinessNoFood
  • maxHappinessNoWater
  • maxHappinessNoShelter
  • happinessBonusFood
  • happinessBonusWater
  • happinessBonusBed
  • happinessBonusShelter
  • happinessBonusSafety
  • minHappinessChangePerUpdate
  • happinessChangeMult
  • minHappinessThreshold
  • minHappinessWarningThreshold
  • minHappinessClearWarningThreshold
  • happinessBonusChangePerUpdate
  • maxStoredFoodBase
  • maxStoredFoodPerPopulation
  • maxStoredWaterBase
  • maxStoredWaterPerPopulation
  • maxStoredScavengeBase
  • maxStoredScavengePerPopulation
  • brahminProductionBoost
  • maxProductionPerBrahmin
  • maxBrahminFertilizerProduction
  • maxStoredFertilizerBase
  • minVendorIncomePopulation
  • maxVendorIncome
  • vendorIncomePopulationMult
  • vendorIncomeBaseMult
  • iMaxSurplusNPCs
  • attractNPCDailyChance
  • iMaxBonusAttractChancePopulation
  • iBaseMaxNPCs
  • attractNPCHappinessMult
  • attackChanceBase
  • attackChanceResourceMult
  • attackChanceSafetyMult
  • attackChancePopulationMult
  • minDaysSinceLastAttack
  • damageDailyRepairBase
  • damageDailyPopulationMult

Brand New Controls: While the above settings could have been edited by someone altering the numbers in the vanilla scripts, the following controls were specifically added to the workshop scripts for this framework to expand what can be done.

  • iBaseMaxBrahmin
  • iBaseMaxSynths
  • bAllowLinkedConsumption
  • RobotHappinessLevel
  • recruitmentBrahminChance
  • recruitmentSynthChance
  • recruitmentGuardChance
  • maxAttackStrength
  • maxDefenseStrength
  • actorDeathHappinessModifier