Merge pull request #1057 from rhtucker/master

Began documentation on mod installation

docs/source/index.rst

@@ -10,6 +10,7 @@ Components
 
     openmw/index
     openmw-cs/index
+    openmw-mods/index
 
 
 Indices and tables

docs/source/openmw-mods/differences.rst

@@ -0,0 +1,58 @@
+Modding OpenMW vs Morrowind
+#################################
+
+A brief overview of the differences between the two engines.
+============================================================
+
+OpenMW is designed to be able to use all the normal Morrowind mod files such as .esm/.esp plugins, texture replacers, mesh replacers, etc.
+
+.. warning::
+	All external programs and libraries that depend on ''morrowind.exe'' cannot function with OpenMW. This means you should assume mods dependent on Morrowind Graphics Extender, Morrowind Code Patch, Morrowind Script Extender, etc, will *not* work correctly, nor will the tools themselves.
+
+Multiple Data Folders
+---------------------
+
+The largest difference between OpenMW and Morrowind in terms of data structure is OpenMW's support of multiple data folders. This has many advantages, especially when it comes to unistalling mods and preventing unintentional overwrites of files.
+
+.. warning::
+	Most mods can still be installed into the root OpenMW data folder, but this is not recommended.
+
+To install mods via this new feature:
+
+#.	Open ''openmw.cfg'' with your preffered text editor. It is located as described in https://wiki.openmw.org/index.php?title=Paths and *not* in your OpenMW root directory.
+#.	Find or search for ''data=''. This is located very near the bottom of the file.
+#.	Add a new line below this line and make a new entry of the format ''data=path/to/your/mod''
+#.	Make as many of these entries as you need for each mod folder you want to include.
+#.	Save ''openmw.cfg''
+
+.. note::
+	All mod folders must adhere to the same file structure as ''~/Morrowind/Data Files/''.
+
+.. TODO create a PATHS ReST file that I can reference instead of the Wiki.
+
+To uninstall these mods simply delete that mod's respective ''data='' entry.
+The mods are loaded in the order of these entries, with the top being overwritten by mods added towards the bottom.
+
+.. note::
+	Mods that depend on .esm/.esp plugins can be rearranged within the OpenMW Launcher, but mesh/texture replacer mods can only be reordered by moving their ''data='' entry.
+
+OpenMW Launcher
+---------------
+
+The launcher included with OpenMW is similar to the original Morrowind Launcher. Go to the Data Files tab to enable and disable plugins. You can also drag list items to modify the load order. Content lists can be created at the bottom by clicking the New Content List button, creating a list name, then setting up a new modlist. This is helpful for different player profiles and testing out different load orders.
+
+.. TODO use a substitution image for the New Content List button.
+
+Settings.cfg
+------------
+
+The ''settings.cfg'' file is essentially the same as the .ini files for Morrowind. It is located in the same directory as ''openmw.cfg''. This is where many video, audio, GUI, input, etc. settings can be modified. Some are available in-game, but many are only available in this configuration file. Please see https://wiki.openmw.org/index.php?title=Settings for the complete listing.
+
+.. TODO Create a proper ReST document tree for all the settings rather than Wiki.
+
+Open Source Resources Support
+-----------------------------
+
+While OpenMW supports all of the original files that Morrowind supported, we've expanded support to many open source file formats. These are summarized below:
+
+<this will be a table of the type of file, the morrowind supported file, and the OpenMW supported file formats>

docs/source/openmw-mods/foreword.rst

@@ -0,0 +1,4 @@
+Foreword
+########
+
+OpenMW is a complete game engine built to be content agnostic. The majority of this guide is applicable to any non-Morrowind project using its engine. That being said, it was designed with the extensive modding community of Morrowind in mind. Therefore, if you are already familiar with modding in Morrowind, you will likely be able to start modding in OpenMW with little to no instruction. We do recommend you at least refer to :doc:'differences' to find out about what's different between OpenMW and the original Morrowind engine. For everyone else, or just a good refresher, read on!

docs/source/openmw-mods/index.rst

@@ -0,0 +1,16 @@
+########################
+OpenMW Modding Reference
+########################
+
+The following document is the complete reference guide to modifying, or modding, your OpenMW setup. It does not cover content creation itself, only how to alter or add to your OpenMW gameplay experience. To learn more about creating new content for OpenMW, please refer to :doc:'../openmw-cs/index'.
+
+.. warning::
+   OpenMW is still software in development. This manual does not cover any of its shortcomings. It is written as if everything was working as inteded. Please report any software problems as bugs in the software, not errors in the manual.
+
+.. toctree::
+   :caption: Table of Contents
+   :maxdepth: 2
+
+   foreword
+   differences
+   mod-install

docs/source/openmw-mods/mod-install.rst

@@ -0,0 +1,6 @@
+How To Install Mods
+###################
+
+The following is a detailed guide on how to install mods in OpenMW using best practices.
+
+#. 

docs/source/tutorial-style-guide.txt

@@ -0,0 +1,51 @@
+####################
+Tutorial Style Guide
+####################
+
+Please contact Ravenwing about any questions relating to this guide.
+
+Foreword
+--------
+
+I shall try to be as brief as possible without sacrificing clarity, just as you should be when writing documentation. The SCOPE of this guide is limited to all non-source code documentation.
+
+References
+----------
+
+-Syntax: reStructuredText (ReST): http://docutils.sourceforge.net/rst.html
+-Parser: Sphinx: http://www.sphinx-doc.org/en/stable/
+-British and English Spelling: https://www.spellzone.com/pages/british-american.cfm
+
+Language
+--------
+
+British English
+Sorry, I'm American and I'll probably have a million relapses, but this seems to have been decided and uniformity is key!
+
+Text Wrapping
+-------------
+
+DO NOT manually decide where each line ends! Enable text wrapping in your text editor! (usually under View) Even Notepad allows automatic text wrapping, so use it. If you program, you may be used to keeping your lines under 80 characters wide and manually pressing enter, but don't. This is because we are writing mostly prose. When someone has to come in and edit portions of text that puts all this out of alignment, it takes FOREVER to readjust everything. Plus, indentation is very important in ReST, and you may forget to indent properly.
+
+Indentations
+------------
+
+This isn't as important, especially since Sphinx converts tabs to spaces, but I find it much easier to keep large blocks of things aligned if you just tab. If you can edit your tab width, please set it to 4 spaces.
+
+Spaces
+------
+
+Use only one space after each sentence. Some people were taught two spaces, but this is a carry-over from typewriters. Even though your text editor is probably using monospaced characters like a typewriter, the formats Sphinx is converting into will make all the adjustments they need to be beautifully legible.
+
+Commas
+------
+
+Oxford comma. Use it. I know this goes against using British English, but this is technical writing. You cannot assume our audience will know from context if the last two items in a list are grouped or not.
+I also prefer parentheticals to commas around gerund phrases.
+
+Files and Extensions
+--------------------
+
+When referring to a filename or filepath use the double single quotes as for inline literals. (e.g. ''morrowind.exe'')
+When referring to a file extension by itself use all caps without the dot beforehand. (e.g. ZIP instead of .zip or .ZIP)
+