Base Object Swapper Mod

SKSE plugin and framework for swapping base objects and references, using config files.

Description

SKSE utility plugin that allows modders to swap base objects with others, using config files.

With this mod, you could...

1. assign different models to farmhouses in each region, without worrying about compatibility or patches.
2. make statics harvestable/lootable, like Dynamic Things Alternative, but without scripts.

and more!

How To Use

Distributed records should be written to an ini file containing the suffix "_SWAP", in the Data folder (for example, MyMod_SWAP.ini).

They should follow this general format:

[Forms]

origBaseID|swapBaseID|propertyOverrides|chance

origBaseID,origBase2ID,origBase3ID|swapBaseID|propertyOverrides|chance

origBaseID|swapBaseID,swapBase2ID,swapBase3ID|propertyOverrides|chance

[References]

origRefID|swapBaseID|propertyOverrides|chance

[Forms|LocationEDID,CellEDID,KeywordEDID,RegionEDID]

origBaseID|swapBaseID|propertyOverrides|chance

ID can be either formID or editorID of the object

ObjectFormID~ModName.esp OR ObjectFormID OR ObjectEditorID

origBase is the base object you're trying to replace (eg. all farmhouse statics).

origRef is the specific object reference you're trying to replace (ie. a specific farmhouse in Riverwood).

swapBase is the replacement object you're replacing it with (eg. your farmhouse static with new model).

Locational replacements

1. Location based form swaps
2. Requires location/cell/worldspace or keyword ID (for location)
3. To exclude a location/keyword, add - in front (ie. -WhiterunLocation)

;this swaps all WalkwayBend02 statics in Riverwood and Falkreath for snow variants

[Forms|RiverwoodLocation,FalkreathLocation]

WalkwayBend02|WalkwayBend02Snow

;this swaps all WalkwayBend02 statics everywhere EXCEPT Riverwood for snow variants

[Forms|-RiverwoodLocation]

WalkwayBend02|WalkwayBend02Snow

;this swaps all caskets in locations with LocTypeInn keyword

[Forms|LocTypeInn]

Casket|CasketInn

;this swaps all caskets in all locations EXCEPT inns

[Forms|-LocTypeInn]

Casket|CasketInn

Property Overrides

Transforms

1. Change the position, rotation and scale of swapped objects
2. pos - position
3. rot - rotation
4. scale - scale
5. units must be in floats (20.0)

1. A/R suffixes for setting relative vs absolute transform. For position/rotation
2. posR(1.0,5.0,100.0) will set new position relative to reference base position
3. posA(300.0,100.0,200.0) will override reference base position

1. scale is multiplicative/absolute.
2. scale randomization is possible
3. scale(1.0/2.0) will multiply existing scale between 1.0 to 2.0 units
4. scaleA(100/200) will override existing scale value

Record Flags

1. Set/clear record flags on references (flags/flagsC)
2. See https://en.uesp.net/wiki/Skyrim_Mod:Mod_File_Format#Records for all possible record flags

1. flags(0x20000000) to set the Don't Havok Settle flag
2. flagsC(0x20000000) to clear the Don't Havok Settle flag

1. Leave as NONE if you don't want property overrides

;swaps WalkwayBend02 statics to snow variants with relative position + random Z position of 50 to 100, and random scale between 1.0 and 1.50, and mark this as initially disabled

[Forms]

WalkwayBend02|WalkwayBend02Snow|posR(10.0,5.0,50.0/100.0),scale(1.0/1.50),flags(0x00000800)

1. It is also possible to directly set a property override without swapping objects. Requires [Properties] or [Transforms] section

[Transforms]

origBaseID|propertyOverrides|chance

origRefID|propertyOverrides|chance

[Transforms|LocationEDID,CellEDID,KeywordEDID,RegionEDID]

origBaseID|propertyOverrides|chance

1. Affects swapped objects

[Forms]

FarmBench|DestructibleFarmBench

Barrel|DestructibleBarrel|scale(2.0)

[Transforms]

;Works even though the farm bench was swapped for destructible bench

FarmBench|rotR(-90,0,0),scale(2.0)

;Does not work because the swapped object transform takes priority

Barrel|rotR(-90,0,0)

Chance

1. Randomly swap between multiple swap objects/percentage chance to not swap at all
2. chance (0.0 - 100.0)
3. Default is 100
4. S/R/L suffixes
5. chanceS(50) - fixed random chance (persists across game sessions; object refs will be always swapped or not)
6. chanceL(50) - fixed random chance based on location/original base ID (objects of the same type and location will always swap the same way)
7. chanceR(50) - chance is rerolled on each new game session (object ref may or may not be swapped each time you load the game)
8. Default is S
9. Optional RNG seed parameter to specifically control swap chance
10. chance(0.0-100.0, 1234567)

[Forms]

;Randomly swaps between Base1, Base2, Base3

Base|Base1,Base2,Base3

;50% chance to swap to Barrel2

Barrel|Barrel2|NONE|chanceS(50)

;25% chance to swap to Barrel3

Barrel|Barrel3|NONE|chanceS(25)

;50% chance (rerolls each game session)

Crate|Crate02|NONE|chanceR(50)

;ALL crates in the same location will either swap or not

Crate|Crate02|NONE|chanceL(50)

Examples

[Forms]

;Barrel02Static|Barrel02Dynamic

0x10C0E3~Skyrim.esm|0x800~DynamicObjectMod.esp

OR

;0x10C0E3~Skyrim.esm|0x800~DynamicObjectMod.esp

Barrel02Static|Barrel02Dynamic

[Forms|WinterholdLocation]

;swap all mammoth skulls in Winterhold, Z angle offset by 90.0 degrees and random scale between 1.0 and 1.50

;BoneMammothSkullSnowy|BoneMammothSkullDynamic

0x73CE8~Skyrim.esm|0x801~DynamicObjectMod.esp|rotR(0.0,0.0,90.0),scale(1.0/1.50)

[References]

;SomeSpecificMammothSkull|BoneMammothSkullDynamic

0x1234~Skyrim.esm|0x801~DynamicObjectMod.esp|scale(1.0/1.50)

Check po3_BaseObjectSwapper.log in My Documents/My Games/Skyrim Special Edition/SKSE, for more information about the process.

Credits

Source

1. Ryan (SniffleMan) for CommonLibSSE
2. alandtse and NickStefan for their contributions to this project
3. wSkeever and r/skyrimmods for help with testing