MWSE Dynamic Object Replacer

MWSE Dynamic Object Replacer

Inspired by powerOfThree's amazing Base Object Swapper for Skyrim, this mod adds a (fairly simple) MWSE framework for loading config files to dynamically replace object references at runtime. No lua coding knowledge is required!

As of 1. 1. 0, the old way of loading config files still works, but there is an additional API included for your own lua mods.



Requirements

• MWSE

Details

Config files go into Data Files/MWSE/mods/_OR_/ and require a specific format (we'll get to that later!). On startup, this mod loads all config files and merges any conflicting entries.

As of 1. 1. 0, you can now simply include the DOR library in your lua mods as an additional way to load config files.

-- simply place something like this in your lua file

local objectReplacer = require("DOR. GPObjectReplacer")

-- and then call objectReplacer.loadORFile(filepath) to load your config file (can be located anywhere and named anything)

objectReplacer.loadORFile(yourConfigFilePathHere)

Then every time an object is loaded (referenceActivated) this mod checks for objects to replace and calculates the chances (if given) accordingly. The mod doesn't actually replace the base object of the reference, but simply creates a new reference with the same scale, position, and orientation and disables the old one. Therefore, it is best to replace objects with similar mesh structures.

File Structure

Note that the _OR_ prefix and .lua extension are required. (Unless you are loading a config file through your own lua mod)

Here is an example of such a file for replacing gold coins with different coins (from my now released mod Wealth Beyond Measure) comments are added for clarity.

IMPORTANT: You must structure your file identically to this example, including naming convention

_OR_GPBank.lua

objectsToReplace = {

objectToReplace0 = {

oldObject = "Gold_001",

newObjects = {

newObject0 = {

newObject = "GPBankSeptimSilver",

replaceChance = 0. 25,

excludedCell = {

{cellName = "Addamasartus"},