Skyrim Special Edition
0 of 0

File information

Last updated

Original upload

Created by

Kezyma

Uploaded by

Kezyma

Virus scan

Safe to use

Tags for this mod

About this mod

Tired of having to install mods manually because they need files in your install folder and not just your data folder? Wish you could just add them all through Mod Organizer (2)? Well now you can, sort of.

Requirements
Permissions and credits
Changelogs
Donations
Kezyma's Root Builder 3 for Mod Organizer 2
v3 Readme

Root Builder allows you to manage mod files that go inside the base game folder instead of the Data (or Data Files for Morrowind) folder. It provides functions that allow you to copy mod files to the game folder, synchronise them with the files in Mod Organizer and to clean up and restore the original game folder.

Mod Setup

When packaging mods for mod organizer, you must move any files intended to go into the base game folder into a new folder called Root that sits alongside other Data folders such as Meshes or Textures. 

For example, if your original mod is packaged like this;
SomeModDll.dll
SomeModExe.exe
Data\SomeModEsp.esp
Data\Textures\ASpecialTexture.dds
Data\Meshes\VeryPrettyModel.nif


You would need to rearrange it for Mod Organizer as follows;
Root\SomeModDll.dll
Root\SomeModExe.exe
SomeModEsp.esp
Textures\ASpecialTexture.dds
Meshes\VeryPrettyModel.nif


Where the esp file and the Meshes and Textures will be picked up by Mod Organizer as usual, but the files intended for the base game folder are now in a subfolder called Root.

Plugin Setup

If you would like to use Root Builder as a plugin, copy the entire RootBuilder folder into your Mod Organizer's plugin folder.
Assuming Mod Organizer is installed at `D:/MO/` the plugin folder is at `D:/MO/plugins`
When you launch Mod Organizer, Root Builder will be added to your tools menu.

There are four options;
-GUI- which launches Root Builder using the current profile.
Build, Sync and Clear which run Root Builder with different command line arguments.
There are also settings to enable cache, backup and debug mode (these only matter for the Build, Sync and Clear commands).

Root Builder Setup

If you are not using Root Builder as a Mod Organizer plugin, you only need the RootBuilder3.exe file, the python scripts and icon file are exclusively for the Mod Organizer plugin.

Run RootBuilder3.exe, you can do this inside or outside of Mod Organizer, it should work either way.
Select your ModOrganizer.ini file in the window that opens.
If you are running a portable Mod Organizer install, the ini file will be located in the Mod Organizer folder.
If you're running a local instance, it'll be the folder you selected to set the instance up in, by default it'll be in the following location;
C:\Users\%USER%\AppData\Local\ModOrganizer\


Root Builder should now automatically detect the location of your currently loaded game and the profile you have loaded in Mod Organizer.
The game will also be added to the list of games, which you can switch between. 
These are tied to the game install, not the Mod Organizer install, so you can not have multiple ModOrganizer.ini files for the same game.

Build

Build is used to copy the files from your mods folders into your base game folder.

When you click on Build, the following things will happen.
- All current files in the base game folder will be scanned and recorded. 
- If you have already clicked Build, this step is skipped and currently recorded data is used.
- All currently active mods will be scanned and any Root files will be recorded, overwriting based on your load order.
- Any files that would be overwritten by mod files are temporarily backed up.
- Root mod files are copied into the base game directory.

Sync

Sync is used to update the files in your mods folders with any changes that have occurred since the last Build.

When you click on Sync, the following things will happen.
- All files in the base game folder will be scanned.
- Your current modlist will be updated.
- Any files that came from mods and that have changed will be copied back to the original mod folder.
- Any original game files that have changed and that have a backup available will be copied to the overwrite folder.
- Files without a backup available will be left where they are, to prevent possible complications later.
- Any new files that have been created will be copied to the overwrite folder.

Clear

Clear is the same as Sync, except that it will also restore the base game folder to (as close as possible to) its original state. 

When you click on Clear, the following things will happen.
- Root Builder will run the Sync function.
- All files in the base game folder will be scanned.
- Any original game files that have changed and that have a backup available will be restored.
- Any mod files or new files will be deleted.
- Any created folders will be deleted.
- Any backed up files will be deleted.
- Recorded data is cleared.

Cache

If Cache is enabled, during the initial scanning of game files, a copy of the scanned data for these files is recorded. These scan results are then used in place of scanning again for any future builds. This is ideal if you have a perfectly vanilla installation.

If Cache is disabled and there is already an existing cache for this game, it will be deleted on the next Build.

Backup

If Backup is enabled, after the initial scanning of game files, a backup of all root files will be taken instead of only known conflicts. This is ideal if you have a perfectly vanilla installation as it means you can pick up on every change made. It also assists in identifying changing base game files outside of Root Builder, such as ini edits and 4gb patches. 

If Backup is enabled, it will prevent the Clear function from clearing the backed up files.

Command Line Usage

RootBuilder3.exe can also be called from the command line with the following parameters;
-ini "C:\Absolute\Path\To\ModOrganizer.ini"
Specifies the ModOrganizer install to use.

-cache
-backup

Enables cache and/or backup modes.
If these flags are not specified but you have enabled cache or backup for this game in the GUI, it will use those settings. Otherwise they both default to false.

-build
-sync
-clear

Specifies which of the three actions to run. If you use one of these, Root Builder will run in a headless mode.

-debugIf combined with the build, sync or clear command, will leave the log window open after completing.

So you can create a shortcut that looks something like this;
RootBuilder3.exe -build -cache -backup -ini "D:\MO2\ModOrganizer.ini"
and like this;
RootBuilder3.exe -clear -cache -backup -ini "D:\MO2\ModOrganizer.ini"
And use them to quickly build, clear or sync.


Root Builder Version 1 & 2 (Obsolete)
This is the readme for the old versions of Root Builder, for anyone still using them.

Kezyma's Root Builder 2.0 for Mod Organizer 2

The purpose of this tool is to (ironically) resolve the problem of having too many different tools and utilities to manage outside of MO2. 

Normally we're used to just downloading mods from Nexus Mods and having an easy one click install in MO2 with everything getting placed neatly into the Data folder. For tools and utilities however, we normally have to manually install them, either in their own folder or in the game installation folder directly, something that MO2 normally helps to prevent.

This utility allows you to restructure your utilities, tools and other mods that don't go into the Data folder and have them copied into their appropriate places as well as removing them or updating the original files in MO2.
----------------------------------------------------
Usage Guide
----------------------------------------------------

Setup
----------
Before anything else, you'll need .Net Core 3.1 installed, if you don't have it, you can find it here; https://dotnet.microsoft.com/download

Copy RootBuilder.exe to any folder you'd like, I normally suggest giving it a separate folder within the main Mod Organizer folder (but not Tools) and leave it there to make it easier to find.

Add RootBuilder.exe to the executables in MO2, hopefully you already know how to do this if you're using Mod Organizer enough to want this tool in the first place, if not, I'd suggest looking for a beginners guide to MO2, it's quite easy and comes up fairly early in most guides.

Arranging Files
----------
Next up is the fun part, you want to install all of your utilities and other mods through Mod Organizer like normal, it'll most likely tell you that they're incorrectly packaged and ask you to sort them out.

Next, you're going to create a new folder at the top level of the mod (the same level that you normally find folders like textures or meshes) and copy the contents of the mod into that folder. If it's a tool and loosely packed, you might want to make a second folder named after the tool to put all the different files in.

If the files need to go into the game's installation folder, the new folder you create should be called Root.
If the files are tools and you want to use them in MO2, the new folder you create should be called Utils.

This means, when you run the game through MO2, the files you just arranged will be in GameName\Data\Root\ and GameName\Data\Utils\ and easily picked up by RootBuilder.

Using RootBuilder
----------
Now, launch RootBuilder through MO2.
The first thing you're going to want to do is select the game you're using, a single RootBuilder install can track one copy of each game at a time, so you don't need to have multiple copies of RootBuilder for multiple games.
Next, you need to select the install location of the game, this is whatever folder contains the main exe file for the game you're modding.
Then, select the folder where your current Mod Organizer 2 installation is, the one that you're running right now.
Optionally, you can also enable Wabbajack support.
Once you've done that, you have three buttons available to you.

Copy Root Files
When pressed, anything in the Root folder will be copied to the game install folder, if there's already files there, they'll be overwritten. Everything that's been copied over is then stored in RootBuilder's settings file.
Everything in the Utils folder will be copied to a folder in Mod Organizer 2 called Tools, just as with the Root files, a complete list is stored in the RootBuilder settings file. You can then add them as executables in MO2 to use later on.
If Wabbajack support is enabled, everything in the root folder is instead c copied to a folder in Mod Organizer 2 called Game Folder Files, Wabbajack uses this to determine which files should be in the game's install folder when compiling a modlist.

Sync Root Files
When pressed, every file that has been copied by RootBuilder will then be copied back, anything in Mod Organizer 2's Tools folder will be copied back into the mod's folder and everything in the game install folder will be copied back to their mod's folder. Updating the versions you have in Mod Organizer with any changes that have been made since you first copied them.

Clear Root Files
When pressed, every file copied by RootBuilder will be deleted and RootBuilder will delete references to them from its settings file.