Merge pull request #1187 from rhtucker/master

Added fonts and paths documents.
8 years ago · ec19938367
parent a30dfac388 b02bbe2bf4
commit ec19938367
8 changed files with 145 additions and 13 deletions
--- a/docs/source/openmw-mods/differences.rst
+++ b/docs/source/openmw-mods/differences.rst
@ -19,7 +19,7 @@ The largest difference between OpenMW and Morrowind in terms of data structure i

 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.
+#.	Open ``openmw.cfg`` with your preffered text editor. It is located as described in :doc:`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.
--- a/docs/source/openmw-mods/font.rst
+++ b/docs/source/openmw-mods/font.rst
@ -0,0 +1,77 @@
+Fonts
+#####
+
+Morrowind .fnt fonts
+--------------------
+
+Morrowind uses a custom ``.fnt`` file format. It is not compatible with the Windows Font File ``.fnt`` format, nor compatible with ``.fnt`` formats from any other Bethesda games. To our knowledge, the format is undocumented and no tools for viewing or editing these fonts exist.
+
+OpenMW can load this format and convert it on the fly into something usable (see font loader `source code <https://github.com/OpenMW/openmw/blob/master/components/fontloader/fontloader.cpp#L210>`_). In OpenMW 0.32, an --export-fonts command line option was added to write the converted font (a PNG image and an XML file describing the position of each glyph in the image) to the current directory.
+
+TrueType fonts
+--------------
+
+Unlike vanilla Morrowind, OpenMW directly supports TrueType (``.ttf``) fonts. This is the recommended way to create new fonts.
+
+-	To replace the primary "Magic Cards" font:
+
+	#.	Download `Pelagiad <http://isaskar.github.io/Pelagiad/>`_ by Isak Larborn (aka Isaskar).
+	#.	Install the ``openmw_font.xml`` file into ``resources/mygui/openmw_font.xml`` in your OpenMW installation.
+	#.	Copy ``Pelagiad.ttf`` into ``resources/mygui/`` as well.
+	#.	If desired, you can now delete the original ``Magic_Cards.*`` files from your Data Files/Fonts directory.
+-	You can also replace the Daedric font:
+
+	#.	Download `Ayembedt <https://github.com/georgd/OpenMW-Fonts>`_ by Georg Duffner.
+	#.	Install ``OMWAyembedt.otf`` into ``/resources/mygui/`` folder in your OpenMW installation.
+	#.	Add the following lines to openmw_font.xml::
+
+			<Resource type="ResourceTrueTypeFont" name="Daedric">
+				<Property key="Source" value="OMWAyembedt.otf"/>
+				<Property key="Size" value="24"/>
+				<Property key="Resolution" value="50"/>
+				<Property key="Antialias" value="false"/>
+				<Property key="TabWidth" value="8"/>
+				<Property key="OffsetHeight" value="0"/>
+				<Codes>
+					<Code range="32"/>
+					<Code range="65 90"/>
+					<Code range="97 122"/>
+				</Codes>
+			</Resource>
+
+	#.	This font is missing a few glyphs (mostly punctuation), but is complete in the primary glyphs. If desired, you can now delete the original ``daedric.*`` files from your Data Files/Fonts directory.
+
+-	Another replacement for the Daedric font is `Oblivion <http://www.uesp.net/wiki/File:Obliviontt.zip>`_ by Dongle.
+
+	#.	Install the ``Oblivion.ttf`` file resources/mygui/.
+	#.	The openmw_fonts.xml entry is::
+
+			<Resource type="ResourceTrueTypeFont" name="Daedric">
+				<Property key="Source" value="Oblivion.ttf"/>
+				<Property key="Size" value="30"/>
+				<Property key="Resolution" value="50"/>
+				<Property key="Antialias" value="false"/>
+				<Property key="TabWidth" value="8"/>
+				<Property key="OffsetHeight" value="0"/>
+				<Codes>
+					<Code range="32 34"/>
+					<Code range="39"/>
+					<Code range="44 46"/>
+					<Code range="48 59"/>
+					<Code range="63"/>
+					<Code range="65 90"/>
+					<Code range="97 122"/>
+					<Code range="172 173"/>
+					<Code range="255"/>
+					<Code range="376"/>
+					<Code range="894"/>
+					<Code range="8211 8212"/>
+					<Code range="8216 8217"/>
+					<Code range="8220 8221"/>
+				</Codes>
+			</Resource>
+
+Bitmap fonts
+------------
+
+Morrowind ``.fnt`` files are essentially a bitmap font, but using them is discouraged because of no Unicode support. MyGUI has its own format for bitmap fonts. An example can be seen by using the --export-fonts command line option (see above), which converts Morrowind ``.fnt`` to a MyGUI bitmap font. This is the recommended format to use if you wish to edit Morrowind's bitmap font or create a new bitmap font.
--- a/docs/source/openmw-mods/index.rst
+++ b/docs/source/openmw-mods/index.rst
@ -16,3 +16,4 @@ The following document is the complete reference guide to modifying, or modding,
   mod-install
   settings/index
   convert_bump_mapped_mods
+   paths
--- a/docs/source/openmw-mods/mod-install.rst
+++ b/docs/source/openmw-mods/mod-install.rst
@ -11,10 +11,11 @@ Install

 	#.	Locate the plugin files, ``.esp`` or ``.omwaddon``. The folder containing the plugin files we will call your *data folder*
 	#.	Check that all resource folders (``Meshes``, ``Textures``, etc.) containing additional resource files (the actual meshes, textures, etc.) are in the *data folder*.
-   
-.. note::
-	There may be multiple levels of folders, but the location of the plugins must be the same as the resource folders.
-3.	Open your ``openmw.cfg`` file in your preferred plain text editor. It is located as described in https://wiki.openmw.org/index.php?title=Paths and *not* in your OpenMW root directory.
+	
+	.. 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.
 #.	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*.
 #.	Save your ``openmw.cfg`` file.
--- a/docs/source/openmw-mods/paths.rst
+++ b/docs/source/openmw-mods/paths.rst
@ -0,0 +1,28 @@
+Paths
+#####
+
+The following describes the locations for the various OpenMW file paths for different types of files on different operating systems.
+
+.. note::
+	Actual location depends on your computer's setup. Username, harddrive, and language may vary.
+
+Configuration files and log files
+---------------------------------
+
+:Linux:		``$HOME/.config/openmw``
+:Mac:		``$HOME/Library/Preferences/openmw``
+:Windows:	``C:\Users\Username\Documents\my games\openmw``
+
+Savegames
+---------
+
+:Linux:		``$HOME/.local/share/openmw/saves``
+:Mac:		``$HOME/Library/Application Support/openmw/saves``
+:Windows:	``C:\Users\Username\Documents\my games\openmw\saves``
+
+Screenshots
+-----------
+
+:Linux:		``$HOME/.local/share/openmw``
+:Mac:		``$HOME/Library/Application Support/openmw``
+:Windows:	``C:\Users\Username\Documents\my games\openmw``
--- a/docs/source/openmw-mods/settings/game.rst
+++ b/docs/source/openmw-mods/settings/game.rst
@ -23,3 +23,24 @@ If this boolean setting is true, the player character will always use the most p

 The default value is false. This setting can be toggled with the Always Use Best Attack button in the Prefs panel of the Options menu.

+difficulty
+----------
+
+:Type:		integer
+:Range:		-500 to 500
+:Default:	0
+
+This integer setting adjusts the difficulty of the game and is intended to be in the range -100 to 100 inclusive. Given the default game setting for fDifficultyMult of 5.0, a value of -100 results in the player taking 80% of the usual damage, doing 6 times the normal damage. A value of 100 results in the player taking 6 times as much damage, but inflicting only 80% of the usual damage. Values less than -500 will result in the player receiving no damage, and values greater than 500 will result in the player inflicting no damage.
+
+The default value is 0. This setting can be controlled in game with the Difficulty slider in the Prefs panel of the Options menu.
+
+show effect duration
+--------------------
+
+:Type:		boolean
+:Range:		True/False
+:Default:	False
+
+Show the remaining duration of magic effects and lights if this boolean setting is true. The remaining duration is displayed in the tooltip by hovering over the magical effect.
+
+The default value is false. This setting can only be configured by editing the settings configuration file.
--- a/docs/source/openmw-mods/settings/index.rst
+++ b/docs/source/openmw-mods/settings/index.rst
@ -2,14 +2,7 @@
 Advanced Settings Configuration
 ###############################

-This part of the guide will cover how to make modifications to the more arcane settings in OpenMW, most of which are not available from in-game menus, to optimize or customize your OpenMW experience. If you are familiar with ``.ini`` tweaks in Morrowind or the other games, this will be quite similar. All settings described in this section are changed in ``settings.cfg``, located in your OpenMW user directory. This directory is located differently depending on your operating system, shown below:
-
-Windows:
-	``C:\Users\<username>\Documents\my games\openmw`` (hard drive, username and language may vary)
-Mac OSX:
-	``$HOME/Library/Preferences/openmw``
-Linux:
-	``$HOME/.config/openmw``
+This part of the guide will cover how to make modifications to the more arcane settings in OpenMW, most of which are not available from in-game menus, to optimize or customize your OpenMW experience. If you are familiar with ``.ini`` tweaks in Morrowind or the other games, this will be quite similar. All settings described in this section are changed in ``settings.cfg``, located in your OpenMW user directory. See :doc:`paths` for this location.

 Although this guide attempts to be comprehensive and up to date. You will always be able to find the full list of settings available and their default values in ``settings-default.cfg`` in your main OpenMW installation directory. The ranges I have included with each setting are the physically possible ranges, not recommendations.

--- a/docs/source/openmw-mods/settings/sound.rst
+++ b/docs/source/openmw-mods/settings/sound.rst
@ -80,6 +80,17 @@ This integer setting determines the minimum size of the sound buffer cache in me

 The default value is 14. This setting can only be configured by editing the settings configuration file. This setting was added in OpenMW version 0.38.

+buffer cache max
+----------------
+
+:Type:		integer
+:Range:		> 0
+:Default:	16
+
+This integer setting determines the maximum size of the sound buffer cache in megabytes. When the cache reaches this size, old buffers will be unloaded until it reaches the size specified by the buffer cache min setting. This setting must be greater than or equal to the buffer cache min setting.
+
+The default value is 16. This setting can only be configured by editing the settings configuration file. This setting was added in OpenMW version 0.38.
+
 hrtf enable
 -----------