mod-install.rst 3.38 KB
Newer Older
Ryan Tucker's avatar
Ryan Tucker committed
1
2
How To Install and Use Mods
###########################
3

Ryan Tucker's avatar
Ryan Tucker committed
4
The following is a detailed guide on how to install and enable mods in OpenMW using best practices.
5

Ryan Tucker's avatar
Ryan Tucker committed
6
7
8
Install
-------

9
10
11
#.	Your mod probably comes in some kind of archive, such as ``.zip``, ``.rar``, ``.7z``, or something along those lines. Unpack this archive into its own folder.
#.	Ensure the structure of this folder is correct.

12
	#.	Locate the plugin files, ``.esp`` or ``.omwaddon``, or possibly ``.esm``. The folder containing the plugin files we will call your *data folder*
rhtucker's avatar
rhtucker committed
13
	#.	Check that all resource folders (``Meshes``, ``Textures``, etc.) containing additional resource files (the actual meshes, textures, etc.) are in the *data folder*.
14
	#.	Note that not all mods have a plugin, and not all mods have resources, but they must at minimum have one or the other.
15
16
17
18
19
	
	.. note::
		There may be multiple levels of folders, but the location of the plugins must be the same as the resource folders.

#.	Open your ``openmw.cfg`` file in your preferred plain text editor. It is located as described in :doc:`paths` and *not* in your OpenMW root directory.
Ryan Tucker's avatar
Ryan Tucker committed
20
21
#.	Find or search for ``data=``. This is located very near the bottom of the file. If you are using Morrowind, this first entry should already point to your Morrowind data directory, ``Data Files``; otherwise it will point to your game file, ``.omwgame``.
#.	Create a new line underneath and type: ``data="path/to/your/data folder"`` Remember, the *data folder* is where your mod's plugin files are. The double quotes around this path name are *required*.
22
#.	If your mod contains resources in a ``.bsa`` file, go to near the top of the file, locate the entries like ''fallback-archive=Morrowind.bsa'' and create a new line underneath and type: ``fallback-archive=<name of your bsa>.bsa''``.
23
24

.. note::
25
26
	Some text editors, such as TextEdit on Mac, will auto-correct your double quotes to typographical "curly"
	quotes instead of leaving them as the proper neutral vertical quotes ``""``.
27

Ryan Tucker's avatar
Ryan Tucker committed
28
29
#.	Save your ``openmw.cfg`` file.

30
31
32
You have now installed your mod. Any simple replacer mods that only contain resource files such as meshes or 
textures will now automatically be loaded in the order of their ``data=*`` entry. 
This is important to note because replacer mods that replace the same resource will overwrite previous ones as you go down the list.
Ryan Tucker's avatar
Ryan Tucker committed
33
34
35
36

Enable
------

37
38
Any mods that have plugin files must be enabled to work. 
Master game files and plugin files can only be enabled if they have been properly installed within a *data folder* as described above.
Ryan Tucker's avatar
Ryan Tucker committed
39

40
41
42
#.	Open the OpenMW Launcher.
#.	Click on the Data Files tab.
#.	In the Content List box, select the content list you wish to modify in the dropdown menu, or make a new one by:
43

44
45
	#.	Click the New Content List button and enter the name of your content list, then click OK. New lists are useful for keeping track of the mods used for different characters or for different games if you play more than one game using OpenMW.
	#.	In the Content box, select your game file (``.esm`` or ``.omwgame``) from the dropdown menu.
46
	
47
48
#.	Now you must activate the plugins you wish to use by checking the box next to their entry in the Content box list.
#.	Load order can be changed simply by dragging the entries around within the list. Mods are loaded from the top down, so if one plugin depends on another, it must be lower on the list.
49
#.	Click Play to run OpenMW with your game and enabled mods!