Generates fully functional openmw.cfg
and settings.cfg
files for any mod list
from Modding-OpenMW.com.
Runs modding tools with appropriate handling for your selected mod list, including:
Intended to be used with the website's Automatic Installation Guide.
Table of contents
- How Does It Work?
- Requirements
- Installation
- Configuration File
-
Usage
- Configurate a mod list
- Configurate a mod list with dev build only mods
- Use beta.modding-openmw.com to configurate
- Configurate a mod list and give verbose output
- Configurate a mod list and set the output files
- Configurate a mod list and skip running tools
- Configurate a mod list and generate a navmesh cache
- Configurate a mod list and validate the results
- View available mod lists
- Edit one or more Configurator config file values
- Re-run the Configurator setup
- Generate fish completions
- View program usage
-
Customize the
openmw.cfg
file - Run OpenMW in a portable configuration
- Credits
- Report A Problem
- Development
→ How Does It Work?
- The Configurator checks the mod list you gave it against a list of mod lists from the Modding-OpenMW.com website
- If it's a valid mod list, it then fetches CFG Generator data for that list from the Modding-OpenMW.com website
-
If an existing
openmw.cfg
orsettings.cfg
file are found, they are backed up (backed up files will be right next to the normal files with a.backup.XXXXX
suffix) -
A totally fresh
openmw.cfg
file is generated from aMorrowind.ini
file using the OpenMW INI Importer executable -
The mod list CFG Generator data provided by the Modding-OpenMW.com
website is inserted into the freshly-generated
openmw.cfg
-
Your mod installation folder (used by
umo
) is inserted into eachdata=
path in place of the default one provided by Modding-OpenMW.com -
Your Morrowind installation path is also inserted into your
openmw.cfg
in place of the default -
The Configurator then takes
settings.cfg
data gotten from Modding-OpenMW.com and ensures those values are set in yours - Any relevant extra tooling is ran against your mod list while ensuring the necessary changes are made beforehand
- Optional: the OpenMW Navmeshtool executable is ran against your mod list
Read on for a full description of all features!
→ Requirements
The MOMW Tools Pack is required in order to use this! It provides MOMW Configurator itself as well as:
It's strongly advised to put the MOMW Tools Pack into an unprivileged location (e.g., NOT in Program Files for Windows users).
Linux users: The Flatpak version of OpenMW is not supported!
→ Installation
Most people probably want to get this as part of the MOMW Tools Pack for the Modding-OpenMW.com Automatic Installation Guide.
Otherwise:
- Download a zip from the top of this page
-
Extract it to a folder of your choosing, for example:
-
Linux:
/home/username/games/OpenMWMods/Tools/MOMWConfigurator/
-
macOS:
/Users/username/games/OpenMWMods/Tools/MOMWConfigurator/
-
Windows:
C:\games\OpenMWMods\Tools\MOMWConfigurator\
-
Linux:
Arch Linux users may also install the AUR package.
→ Configuration File
The configuration file for MOMW Configurator (called momw-configurator.toml
) is created after the
first time setup is ran. It lives in the OpenMW cfg file location,
please see this
page to find its location on your computer.
→ Usage
→ Configurate a mod list
NOTE: The first time you run MOMW Configurator you'll be prompted to enter several values that are needed by the program so it can do its thing.
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config i-heart-vanilla
Also note:
-
For mod lists with the MOMW
Post Processing Pack, the Configurator will install the
shaders.yaml
file provided by the pack (opt out of this with--no-shaders-yaml
if you know what you're doing). -
The Configurator will also ensure that recommended values are set in
your
settings.cfg
file (opt out of this with--no-settings-cfg
if you know what you're doing). - The Configurator will make backups of any existing file before it changes them.
→ Configurate a mod list with dev build only mods
NOTE: Command line arguments will supercede any values from the configuration file!
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config just-good-morrowind --dev
→ Use beta.modding-openmw.com to configurate
NOTE: Sometimes the beta version of Modding-OpenMW.com is more up-to-date or contains not yet released features.
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config expanded-vanilla --beta
→ Configurate a mod list and give verbose output
This is useful in cases where one of the underlying tools fails and you want more information about it (e.g., when Delta Plugin fails to merge).
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config starwind-modded --verbose
→ Configurate a mod list and set the output files
This is useful for playing with a portable
installation, it allows writing the openmw.cfg
, settings.cfg
, and shaders.yaml
files to an arbitrary
directory:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config total-overhaul --portable-dir C:\games\MyPortableOpenMWDir
Alternatively you can specify arbitrary paths and file names for all three files like this:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config total-overhaul --openmw-cfg-out my-cool-openmw.cfg --settings-cfg-out my-cool-settings.cfg --shaders-yaml-out my-cool-shaders.yaml
Note: The --portable-dir
argument may not be used with
--openmw-cfg-out
, --settings-cfg-out
, or --shaders-yaml-out
.
→ Configurate a mod list and skip running tools
You can skip running any of the handled tooling as desired:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config just-good-morrowind --no-delta-plugin
./momw-configurator config just-good-morrowind --no-groundcoverify
./momw-configurator config just-good-morrowind --no-lightfixes
./momw-configurator config just-good-morrowind --no-delta-plugin --no-groundcoverify --no-lightfixes
NOTE: Only do this if you really know what you're doing!
→ Configurate a mod list and generate a navmesh cache
NOTE: This process may take a long time!
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config expanded-vanilla --run-navmeshtool
→ Configurate a mod list and validate the results
Requires OpenMW-Validator
to be installed and set in the momw-configurator.toml
file.
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config expanded-vanilla --run-validator
→ View available mod lists
Fetches data from Modding-OpenMW.com:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator list
→ Edit one or more Configurator config file values
You can edit Configurator config file values as follows:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator edit-cfg --mod-basedir C:\NewModBaseDir --groundcoverify-exe C:\games\OpenMWMods\Tools\Groundcoverify/groundcoverify.exe
→ Re-run the Configurator setup
You can re-run the Configurator setup at any time:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator setup
NOTE: This will overwrite any existing config file you may have!
→ Generate fish completions
If you use fish shell, you can generate a completions file for MOMW Configurator:
# Change the path and executable name below as needed
# for your system.
cd ~/games/OpenMWMods/Tools/MOMWConfigurator
./momw-configurator completions
With this installed you can then get tab completions for all Configurator commands and arguments. Note: if the Configurator updates and adds new args, you'll need to regenerate this file
NOTE: You will need to add your MOMW Configurator
executable to PATH
in order for
completions to work!
You can also tell the Configurator to print completions to stdout:
# Change the path and executable name below as needed
# for your system.
cd ~/games/OpenMWMods/Tools/MOMWConfigurator
./momw-configurator completions --stdout
This is useful for when you want to dynamically inject completions versus writing them to a file that needs to be updated.
You can for example add this to your fish config: momw-configurator completions --stdout | source
And completions will be added dynamically when you launch your shell (note that this may take longer than reading a file on some setups).
Support for Powershell is planned but contributions to add support for other shells is most welcomed!
→ View program usage
You can view usage information for this tool by using the --help
argument with any command:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config --help
→ Customize the openmw.cfg
file
WARNING: This is an experimental feature that is intended for advanced users! Please note that custom configurations are not supported by the Modding-OpenMW.com team, you are on your own to ensure that any customizations you make are valid and don't break your setup!
The Configurator allows for emitting a customized openmw.cfg
file using rules defined in the momw-customizations.toml
configuration file
(create this file if one doesn't already exist), for example:
[[Customizations]]
listName = "i-heart-vanilla"
removeData = [
"s3lightfixes",
]
removeContent = [
"LightFixes.esp",
]
removeFallback = [
"OMWAyembedt",
]
removeGroundcover = [
"lush_synthesis_AI.esp",
]
[[Customizations.insert]]
insert = """$HOME/games/openmw/umo/custom/Gameplay/GoHome"""
after = "CantonsontheGlobalMap"
[[Customizations.insert]]
insert = "go-home.omwscripts"
before = "Cantons_on_the_Global_Map_v1.1.esp"
[[Customizations.replace]]
source = "Dynamic Distant Details"
dest = """$HOME/games/openmw/umo/custom/Fixes/DistantFixesLuaEdition"""
[[Customizations.replace]]
source = "HM_DDD_Strongholds_T_v1.0.esp"
dest = "distant-fixes-lua-edition.omwscripts"
Please note the above is just a sample and should not be used in your own setup! See further down below for some functional examples.
The above snippet does the following for the i-heart-vanilla
mod list:
-
Removes a
data=
path that containss3lightfixes
-
Removes a
content=
line that containsLightFixes.esp
-
Removes a
fallback=
line that containsOMWAyembedt
-
Removes a
groundcover=
line that containslush_synthesis_AI.esp
-
Inserts
data="$HOME/games/openmw/umo/custom/Gameplay/GoHome"
after an entry containingCantonsontheGlobalMap
-
It knows to add the
data=
prefix and quotes because the line it inserts after has these -
Environment variables such as
$HOME
will be expanded (but they must be enclosed with triple quotes)
-
It knows to add the
-
Inserts
content=go-home.omwscripts
before an entry containingCantons_on_the_Global_Map_v1.1.esp
-
Replaces a line containing
Dynamic Distant Details
withdata="$HOME/games/openmw/umo/custom/Fixes/DistantFixesLuaEdition"
-
As above, it knows to add the
data=
prefix and quotes because the line it inserts after has these
-
As above, it knows to add the
-
Replaces a line containing
HM_DDD_Strongholds_T_v1.0.esp
withcontent=distant-fixes-lua-edition.omwscripts
-
Similar to above, it knows to add the
content=
prefix and quotes because the line it inserts before has these
-
Similar to above, it knows to add the
Customizations must be valid TOML, please use a text editor with error-checking capabilities when writing them.
Also note that all backslashes (\
) MUST be escaped e.g., \\
.
If you have defined customizations but do not wish to apply them, you
may skip them with the --no-customizations
option:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config expanded-vanilla --no-customizations
→ Detailed explanations for each customization option
-
[[Customizations]]
Each set of customizations for a given mod list must be under a top-level
[[Customizations]]
heading. You may have multiple, one for each mod list you wish to customize. -
listName
Required. Specifies which mod list you intend to customize.
The value must be a string under a top-level
[[Customizations]]
heading. -
removeData
/removeContent
/removeFallback
As the names imply, they remove
data=
,content=
, and/orfallback=
lines.The value must be an array of strings under a top-level
[[Customizations]]
heading. -
[[Customizations.insert]]
Inserts a
fallback=
,data=
, orcontent=
line (theinsert
value) either before or after another line that matches the givenafter
orbefore
value.One of
after
orbefore
are required (but not both!) as well as aninsert
orinsertBlock
entry.Use
insert
for single line inserts andinsertBlock
for multi-line inserts. NOTE: Multi-line inserts should be enclosed in triple quotes (see the example below).NOTE: You should not include the
fallback=
,data=
, orcontent=
part of the thing you wish to insert, this will be added by the Configurator.The
[[Customizations.insert]]
heading must be under a top-level[[Customizations]]
heading that defines thelistName
of the mod list you wish to apply the insertions to. -
[[Customizations.replace]]
Replaces a
fallback=
,data=
, orcontent=
line (thesource
value) with another line that matches the givendest
value.You should not include the
fallback=
,data=
, orcontent=
part of the thing you wish to replace something with, this will be added by the Configurator.The
[[Customizations.replace]]
heading must be under a top-level[[Customizations]]
heading that defines thelistName
of the mod list you wish to apply the insertions to.
→ Customization ordering
Customizations are applied in this order, every time:
- Insertions
- Replacements
- Removals
Please keep this in mind when writing yours!
→ Customization rules of thumb
Below is a list of things to keep in mind when writing Customizations. Many of these have already been mentioned but are worth highlighting again.
-
The
momw-customizations.toml
file must be valid TOML syntax- Please use a text editor that has a TOML linter, or use an online checker such as this one
-
Backslashes (
\
) must be escaped (e.g., written twice like this:\\
)-
It's also perfectly valid to use forward slashes (
/
) on Windows
-
It's also perfectly valid to use forward slashes (
-
Environment variables such as
$HOME
may be used, but they must be enclosed in triple quotes (e.g.,"""$HOME/your/path"""
) -
It may in rare cases be necessary to provide a very specific line to
match when doing a customization (versus a small part of a
data=
path or what have you). An error will be emitted when this is the case, specifying the line that has more than one match-
For example, in an example below we use
MonochromeUserInterface
as asource
value for a replacement. If there were multipledata=
paths that containedMonochromeUserInterface
you'd need to contain a larger portion of the source line to be replaced
-
For example, in an example below we use
- As mentioned above, Customizations are applied in a specific order
→ Functional customization examples
This snippet removes the Bethesda/Zenimax intro videos so that you go straight to the main menu when loading OpenMW:
[[Customizations]]
listName = "total-overhaul"
removeFallback = [
"Movies_Company_Logo,bethesda logo.bik",
"Movies_Morrowind_Logo,mw_logo.bik",
]
This snippet would replace Monochrome User Interface mod with Chocolate UI for Total Overhaul and Graphics Overhaul:
[[Customizations]]
listName = "total-overhaul"
removeFallback = [
"FontColor_color_normal,255,255,255",
"FontColor_color_normal_over,192,192,192",
"FontColor_color_normal_pressed,128,128,128",
"FontColor_color_active,255,255,255",
"FontColor_color_active_over,192,192,192",
"FontColor_color_active_pressed,128,128,128",
"FontColor_color_disabled,128,128,128",
"FontColor_color_disabled_over,192,192,292",
"FontColor_color_disabled_pressed,255,255,255",
"FontColor_color_link,105,129,255",
"FontColor_color_link_over,91,112,222",
"FontColor_color_link_pressed,97,106,156",
"FontColor_color_journal_link,37,49,112",
"FontColor_color_journal_link_over,58,77,175",
"FontColor_color_journal_link_pressed,112,126,207",
"FontColor_color_journal_topic,0,0,0",
"FontColor_color_journal_topic_over,58,77,175",
"FontColor_color_journal_topic_pressed,112,126,207",
"FontColor_color_answer,230,80,80",
"FontColor_color_answer_over,181,58,58",
"FontColor_color_answer_pressed,155,80,80",
"FontColor_color_header,255,255,255",
"FontColor_color_notify,100,100,100",
"FontColor_color_big_normal,200,200,200",
"FontColor_color_big_normal_over,255,255,255",
"FontColor_color_big_normal_pressed,150,150,150",
"FontColor_color_big_link,255,255,255",
"FontColor_color_big_link_over,255,255,255",
"FontColor_color_big_link_pressed,150,150,150",
"FontColor_color_big_answer,200,200,200",
"FontColor_color_big_answer_over,255,255,255",
"FontColor_color_big_answer_pressed,150,150,150",
"FontColor_color_big_header,200,200,200",
"FontColor_color_big_notify,200,200,200",
"FontColor_color_background,0,0,0",
"FontColor_color_focus,80,80,80",
"FontColor_color_health,198,65,57",
"FontColor_color_magic,83,91,112",
"FontColor_color_fatigue,111,128,111",
"FontColor_color_misc,255,255,255",
"FontColor_color_weapon_fill,198,65,57",
"FontColor_color_magic_fill,83,91,112",
"FontColor_color_positive,111,128,111",
"FontColor_color_negative,198,65,57",
"FontColor_color_count,255,255,255",
]
[[Customizations.replace]]
source = "MonochromeUserInterface"
dest = "C:\\games\\OpenMWMods\\UserInterface\\ChocolateUI"
[[Customizations]]
listName = "graphics-overhaul"
removeFallback = [
"FontColor_color_normal,255,255,255",
"FontColor_color_normal_over,192,192,192",
"FontColor_color_normal_pressed,128,128,128",
"FontColor_color_active,255,255,255",
"FontColor_color_active_over,192,192,192",
"FontColor_color_active_pressed,128,128,128",
"FontColor_color_disabled,128,128,128",
"FontColor_color_disabled_over,192,192,292",
"FontColor_color_disabled_pressed,255,255,255",
"FontColor_color_link,105,129,255",
"FontColor_color_link_over,91,112,222",
"FontColor_color_link_pressed,97,106,156",
"FontColor_color_journal_link,37,49,112",
"FontColor_color_journal_link_over,58,77,175",
"FontColor_color_journal_link_pressed,112,126,207",
"FontColor_color_journal_topic,0,0,0",
"FontColor_color_journal_topic_over,58,77,175",
"FontColor_color_journal_topic_pressed,112,126,207",
"FontColor_color_answer,230,80,80",
"FontColor_color_answer_over,181,58,58",
"FontColor_color_answer_pressed,155,80,80",
"FontColor_color_header,255,255,255",
"FontColor_color_notify,100,100,100",
"FontColor_color_big_normal,200,200,200",
"FontColor_color_big_normal_over,255,255,255",
"FontColor_color_big_normal_pressed,150,150,150",
"FontColor_color_big_link,255,255,255",
"FontColor_color_big_link_over,255,255,255",
"FontColor_color_big_link_pressed,150,150,150",
"FontColor_color_big_answer,200,200,200",
"FontColor_color_big_answer_over,255,255,255",
"FontColor_color_big_answer_pressed,150,150,150",
"FontColor_color_big_header,200,200,200",
"FontColor_color_big_notify,200,200,200",
"FontColor_color_background,0,0,0",
"FontColor_color_focus,80,80,80",
"FontColor_color_health,198,65,57",
"FontColor_color_magic,83,91,112",
"FontColor_color_fatigue,111,128,111",
"FontColor_color_misc,255,255,255",
"FontColor_color_weapon_fill,198,65,57",
"FontColor_color_magic_fill,83,91,112",
"FontColor_color_positive,111,128,111",
"FontColor_color_negative,198,65,57",
"FontColor_color_count,255,255,255",
]
[[Customizations.replace]]
source = "MonochromeUserInterface"
dest = "C:\\games\\OpenMWMods\\UserInterface\\ChocolateUI"
This snippet would remove NCGDMW Lua Edition from Expanded Vanilla and Total Overhaul (with dev build options enabled):
[[Customizations]]
listName = "expanded-vanilla"
removeData = [
"NCGDMWLuaEdition/00 Core",
"NCGDMWLuaEdition/01 NCGD - Normal",
"NCGDMWLuaEdition/02 OpenMW DevBuild",
]
removeContent = [
"ncgdmw.omwaddon",
"ncgdmw.omwscripts",
"ncgdmw-dev.omwscripts",
]
[[Customizations]]
listName = "total-overhaul"
removeData = [
"NCGDMWLuaEdition/00 Core",
"NCGDMWLuaEdition/01 NCGD - Normal",
"NCGDMWLuaEdition/02 OpenMW DevBuild",
]
removeContent = [
"ncgdmw.omwaddon",
"ncgdmw.omwscripts",
"ncgdmw-dev.omwscripts",
]
This snippet adds Go Home! to Just Good Morrowind:
[[Customizations]]
listName = "just-good-morrowind"
[[Customizations.insert]]
insert = "C:\\games\\OpenMWMods\\Gameplay\\GoHome"
after = "AttendMe/AttendMe_1.8"
[[Customizations.insert]]
insert = "go-home.omwscripts"
after = "AttendMe.omwscripts"
[[Customizations.insert]]
insert = "go-home.omwaddon"
after = "go-home.omwscripts"
This snippet replaces Monochrome User
Interface with Kezyma's UI
Remastered and adds Gonzo's custom FontColor fallback=
values for Total Overhaul:
[[Customizations]]
listName = "total-overhaul"
removeData = [
"MonochromeUserInterface",
]
[[Customizations.insert]]
insert = "D:\\OpenMW Mods\\UserInterface\\KezymasUIRemastered"
after = "04 WareyaOpenMWShaders"
[[Customizations.insert]]
insert = "D:\\OpenMW Mods\\Fixes\\KezymasUIGonzoColorFix"
after = "KezymasUIRemastered"
[[Customizations.insert]]
insertBlock = """FontColor_color_normal,202,165,96
FontColor_color_normal_over,142,116,68
FontColor_color_normal_pressed,96,79,46
FontColor_color_active,112,126,207
FontColor_color_active_over,74,84,135
FontColor_color_active_pressed,175,184,228
FontColor_color_disabled,142,116,68
FontColor_color_disabled_over,96,79,46
FontColor_color_disabled_pressed,68,56,33
FontColor_color_link,74,84,135
FontColor_color_link_over,112,126,207
FontColor_color_link_pressed,175,184,228
FontColor_color_journal_link,74,84,135
FontColor_color_journal_link_over,47,54,86
FontColor_color_journal_link_pressed,28,32,51
FontColor_color_journal_topic,27,22,12
FontColor_color_journal_topic_over,47,54,86
FontColor_color_journal_topic_pressed,28,32,51
FontColor_color_answer,181,58,58
FontColor_color_answer_over,230,80,80
FontColor_color_answer_pressed,155,80,80
FontColor_color_header,202,165,96
FontColor_color_notify,202,165,96
FontColor_color_big_normal,202,165,96
FontColor_color_big_normal_over,142,116,68
FontColor_color_big_normal_pressed,96,79,46
FontColor_color_big_link,74,84,135
FontColor_color_big_link_over,112,126,207
FontColor_color_big_link_pressed,47,54,86
FontColor_color_big_answer,181,58,58
FontColor_color_big_answer_over,230,80,80
FontColor_color_big_answer_pressed,155,80,80
FontColor_color_big_header,142,116,68
FontColor_color_big_notify,142,116,68
FontColor_color_background,0,0,0
FontColor_color_focus,80,80,80
FontColor_color_health,200,60,30
FontColor_color_magic,53,69,159
FontColor_color_fatigue,0,150,60
FontColor_color_misc,204,116,204
FontColor_color_weapon_fill,198,65,57
FontColor_color_magic_fill,198,65,57
FontColor_color_positive,142,116,68
FontColor_color_negative,198,65,57
FontColor_color_count,142,116,68"""
after = "Weather_Rain_Rain_Diameter,1200"
→ Run OpenMW in a portable configuration
You can use MOMW Configurator as a helper for running OpenMW in a portable configuration.
Portable means that OpenMW will use an arbitrary directory for cfg files, save games, screenshots, and other important files instead of the normal location.
In order for this to work, the portable directory needs to have at
least a valid openmw.cfg
file, but you can
use the Configurator itself to prepare everything you need for a mod
list.
→ Generate files for a portable directory
The below snippet demonstrates using the --portable-dir
argument for the config
command to generate all required files,
including a navmesh cache, in a portable directory:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator config expanded-vanilla --portable-dir C:\games\OpenMWPortable --run-validator --run-navmeshtool
→ Use your portable installation
Once the required files are generated, you're ready to run
:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator run C:\games\OpenMWPortable
→ Run OpenMW in testing mode
The run
command makes it easy to
initiate testing mode:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator run C:\games\OpenMWPortable --test
This will bypass the main menu and put you right into the game with a basic character for testing.
→ Testing mode with a script and start cell
Additional arguments allow you to pass in a script to be ran as well as set your starting cell:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator run C:\games\OpenMWPortable --test --cell "Balmora, Guild of Mages" --script C:\games\OpenMWMods\Tools\test-script.mwscript
You can find a sample testing script by Settyness here.
→ Advanced usage
It's also possible to copy in pre-generated cfg files and more:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator run C:\games\OpenMWPortable --openmw-cfg-from C:\games\OpenMWMods\my-openmw.cfg
You can pass in multiple settings.cfg
files and the Configurator will merge them before copying them into your
portable directory:
# Change the path and executable name below as needed
# for your system.
cd C:\games\OpenMWMods\Tools\MOMWConfigurator
./momw-configurator run C:\games\OpenMWPortable --settings-cfg-from C:\games\OpenMWMods\total-overhaul-settings.cfg --settings-cfg-from C:\games\OpenMWMods\4K-settings.cfg
In the above example I give the Configurator two settings.cfg
files:
- The first is one generated by the Configurator using data from Modding-OpenMW.com
- The second is one that contains data not set by Modding-OpenMW.com, such as screen resolution
This allows you to easily run mod lists with different settings. Note that any values that exist in more than one supplied settings file will be overwritten by the last one given.
→ Credits
Author: johnnyhostile
Special Thanks:
- The OpenMW team, including every contributor for making OpenMW and OpenMW-CS
- The Modding-OpenMW.com team for being amazing
- All the users in the modding-openmw-dot-com Discord channel on the OpenMW server for their dilligent testing and feedback ❤️
- Bethesda for making Morrowind
→ Report A Problem
If you've found an issue with this tool, or if you simply have a question, please use one of the following ways to reach out:
- Open an issue on GitLab
-
Email
momw-configurator@modding-openmw.com
-
Contact the author on Discord:
@johnnyhostile
-
Contact the author on Libera.chat IRC:
johnnyhostile
→ Development
How to work with the MOMW Configurator codebase including building it from source.
→ Requirements
MOMW Configurator expects to be built with Go 1.23.0 and should build on any platforrm supported by it.
In order to work with this codebase it's advised to have bash and GNU make installed and available.
→ Compiling Source
On systems with bash
and GNU make
present,
you can build binaries for all supported platforms like this:
make build-all
See the Makefile
and build.sh
files for
more information about building.
→ Tests
Every part of the codebase is covered by either unit or integration tests (or both), or should be. Unit tests can be ran like this:
make test
The integration tests can be ran via docker like this:
# Move into the MOMW Configurator source directory
cd path/to/momw-configurator
# Start up the docker container
docker run -it --rm -v $(pwd):/mnt debian:bookworm-20240904-slim bash
# Run the integration test helper script
/mnt/integration-test-local-setup.sh
Please see the integration-test.sh
file in the root of
this repository for more information about the tests and what they
do.