============================================================================================================================
Modset tool for use with OpenMW + Mod Organizer + Tes3MP + Mlox
============================================================================================================================

Tool by: Polemos

date: 10-27-2017

version: 2.90

Special thanks to:
KOYK_GR.............. for bug testing.
IcePenguin .......... for his readme that I used as a template for mine.
Stackoverflow ....... for finding solutions in my python journey.

============================================================================================================================
Installation:
============================================================================================================================

Manual Install:
===============
-Extract the contents of the compressed file you have downloaded.
-Copy the "modset" folder from inside the extracted folder.
-Paste it to where you put your utilities for OpenMW/TES3mp.
=> Configure the modset.ini inside the folder you have installed Modset tool. <=
-Create a shortcut for the tool and you are done.

Mlox64:
=======
-To use mlox you need to download the mlox64 module from Modset page in Nexus.
-You do not need to download the original mlox.
-After you download it extract the folder "mlox64" from inside it and place the folder inside the "addons" folder which you
may find inside the folder you installed modset.
-For general usage refer to mlox64 readme.

Update:
=======
-Backup your "modset.ini"
-delete everything inside modset folder with the only exception being "addons" folder.
-run the new modset to get a default modset.ini
-compare your old modset.ini with the new and copy your entries.

Uninstallation:
-Just delete the modset folder.

============================================================================================================================
Introduction:
============================================================================================================================

Modset is a tool designed to work with OpenMW and Tes3mp (more info bellow). It also allows you to use Mod Organizer to
arrange your mods...

Now with mlox support by using the mlox64 module in the downloads section. More info below.

Forget copying paths, running/closing to get crc32s, going up and down in configs etc.

After a one time 5' configuration of Modset tool (Configuring paths and settings in modset.ini) you will be able to run
Modset to automatically configure your mods to work within one of the following scenarios:

1. With OpenMW and TES3mp.
==========================
a) Install your mods as you usually do in OpenMW.
b) Run OpenMW launcher and arrange your mods as usual.
c) You run Modset tool, all mod entries will be automatically inserted to TES3mp.
d) You are ready to play.


2. With Mod Organizer and OpenMW (No Tes3mp).
=============================================
a) Install and arrange your mods as you usually do in Mod Organizer.
b) Run Modset tool inside Mod Organizer, all mod entries will be automatically inserted into OpenMW.
c) You are ready to play.


3. With Mod Organizer, OpenMW and Tes3mp.
=========================================
a) Install and arrange your mods as you usually do in Mod Organizer.
b) Run Modset tool inside Mod Organizer, all mod entries will be automatically inserted into OpenMW and Tes3mp.
c) You are ready to play.

Depending on what of the above combinations you are using, you will be able (after you install/order your mods in OpenMW or MO)
to just run Modset tool once (you have to run it only when you install a new mod) and get ready to play.

============================================================================================================================
Faq:
============================================================================================================================

1. When Modset tool runs, does it make any backups of my configuration files?
-Modset tool automatically makes one "latest" backup of any configuration files it manipulates with an extension of .bck
(same folder as the manipulated file).
-Modset tool also automatically creates a backup for every manipulated configuration
file, with a timestamp and an extension of .bck, inside a folder named "confbck" were Modset tool resides.

2. When I run Modset tool it throws some messages and closes. Wtf?
-Every time Modset tool runs it creates a "log.txt" file. It contains any warning, errors or general messages you might have
missed.
-Set "exit_on_success = False" in modset.ini and Modset tool will wait for input to exit.

3. Will this mess my Morrowind/TES3mp/OpenMW folder?
-No, but it will mess with your configuration files. It does make backups of those files though.

4. Modset tool always runs and then closes, how do I know if it worked or not?
-See 2 above. Plus if any errors are encountered, Modset will pause for you to see them.

5. I see some warnings on "log.txt" and/or when I run Modset tool, wtf?
-That's ok, mostly. In most circumstances it is only to notify you about your decisions in modset.ini and things you might
have missed. For example it might be Bypassing default Data Files folder, because of your choices in modset.ini, it will
warn you, but that's ok. 99,9% of the time, warnings are just informational.

6. What's this about Russian crc32 values in modset.ini?
-If you are hosting a server you need this to allow people with the Russian version of Morrowind to participate. Enable it so
they can join your server.

7. Why it takes so long for Modset tool to run?
-You propably have an old PC. For now Modset tool automatically creates crc32 values for TES3mp. In the future I will add an
option to bypass this (crc32s are not needed if you play with people you trust not to cheat).

8. I am having problem to run Modset tool within Mod Organizer, wtf?
-I tested Modset tool with Mod Organizer 2 and it is working perfectly. I have implemented a way to bypass running Modset
tool inside Mod Organizer just in case though, so maybe you are in luck. Just set in modset.ini
Mod_Organizer "Mod_Organizer workaround_fix = True" and follow the instructions in modset.ini section in this guide.
-Be careful though that you need to have Mod Organizer closed for the workaround to work.

9. I am getting crazy with your modset.ini...
-I will build a wizard if I see that you need one. Just ask.

10. I breath Linux, I eat Linux, I am Linux, why is there not a Linux version you M$@%!QWD?
-Maybe, if you ask it may speed things up though.

11. Who made mlox? You?
-NO. Mlox is the work mainly of John Moonsugar and then Dragon32 and abot. Mlox is 100% their work. My work was only to
adapt mlox to work as a module (mlox64) for Modset tool.

12. Are you allowed to fork mlox?
-Yes, according to the MIT license of mlox (included in mlox64 and elsewhere, many copies).

13. Do I have to download the original mlox with your mlox64 module?
-No. You only need mlox64 for modset.

14. Can I use mlox64 with the original Morrowind?
-No, for the original Morrowind you need to use the original mlox.

============================================================================================================================
Modset.ini configuration:
============================================================================================================================

1. You need to have "TES3mp" or "Mod Organizer" or both "TES3mp and Mod Organizer" enabled in modset.ini. If none of them
is enabled the program will exit.

2. Define the settings and file paths of the configuration files, for example:
pluginlist.json = c:\games\openmw\mp-stuff\data

3. Don't use ' or " to declare the paths and be aware that letter capitalization doesn't matter.

4 The paths set below only serve as a guide. Set them according to your needs.

5. The information below can be found in the Nexus page, where it is much easier to read...


[Settings]
-If set to "True", the program will exit after a successful operation, WITHOUT asking for confirmation.
exit_on_success = True

[OpenMW settings]
-Set the path of "Openmw.cfg", WITH YOUR USERNAME, for example in windows 7 it is defined like below:
openmw.cfg = C:\Users\{USERNAME}\Documents\My Games\OpenMW

-Set the path of the folder where morrowind default data files reside.
data files = C:\games\Morrowind\data files

[TES3mp settings]
-If you are using TES3mp you need to set this to True.
TES3mp_enabled = True

-For compability with Russian version of Morrowind set to True.
insert Russian crc32 = True

-Set the path of "pluginlist.json". The file resides inside TES3mp folder in ".\mp-stuff\data\"
pluginlist.json = C:\Games\tes3mp\mp-stuff\data

[Mod Organizer settings]
-If you are using Mod Organizer to arrange your mod structure you need to set this to True.
Mod_Organizer enabled = False

-If you are using Mod Organizer you must have made a symbolic link pointing to your "data files" folder. Set the path here.
Mod_Organizer data_files_folder = C:\Games\tes3mp\Data

-Set here the folder where Mod Organizer executable resides.
Mod_Organizer root_folder = C:\Games\tes3mp\ModOrganizer

-Set here the folder path of your active Mod Organizer profile.
Mod_Organizer profile_folder = C:\Games\tes3mp\ModOrganizer\profiles\Default

[Mod Organizer fixes]
-Mod Organizer messes the order of mods whenever you run a program inside it. This is set to True by default to avoid that.
-If in the future Mod Organizer gets fixed you may consider disabling it. For now leave it set to True.
Mod_Organizer autolock_mods = True

-If you have problems running Modset tool from inside Mod Organizer set this to True.
-WARNING: When you run Modset tool, you must have Mod Organizer closed if you have this enabled.
Mod_Organizer workaround_fix = False

============================================================================================================================
Links:
============================================================================================================================

Mod Organizer 2:
https://www.nexusmods.com/skyrimspecialedition/mods/6194/?

OpenMW:
https://openmw.org/en/

TES3mp:
https://steamcommunity.com/groups/mwmulti

============================================================================================================================
Sidenotes:
============================================================================================================================

The list below is an "unordered list":
======================================
-I intend to make a guide about how to use Mod Organizer in OpenMw and I am going to try to make a version working without
hacks after I get a permission from LePresidente (or Tannin?).
-I will make a guide in Nexus on how to use Mod Organizer with OpenMw pretty soon, just wait.
-I intend on making a lock/unlock tool for Mod Organizer to increase flexibility.
-I also intend to make some small ini autopatchers for mods like SkiesIV to work as intended in OpenMW.
-I also intend adding support for mlox and wrye mash


============================================================================================================================
Version History:
============================================================================================================================
v2.90 -Added support for mlox in the form of a module (mlox64).
-Added automatic detection and importing of BSA files. For now Morrowind.bsa, Tribunal.bsa and Bloodmoon.bsa are
placed first In line (if found) and then the rest of the bsa files in the order they are scanned. In the future BSA
files will be cross referenced with the order mods are installed and placed in the same order.
v2.55 -Bug fix, removed "OpenMW data_mods folder" setting from modset.ini
v2.50 -Initial release.


Check included license.txt file for software permissions etc..

============================================================================================================================
============================================================================================================================