Improve settings documentation

pull/389/head
scrawl 7 years ago
parent 95a07bdc77
commit ea028a2076
No known key found for this signature in database
GPG Key ID: 2E6CC3676024C402

@ -9,11 +9,7 @@ scaling factor
:Default: 1.0
This setting scales the GUI interface windows.
The value must be greater than 0.0. A value of 1.0 results in the normal scale.
Values much larger than 2.0 may result in user interface components being inaccessible.
Until a gamepad interface is created,
increasing this setting is helpful for simulating the larger interface used in console games.
A value of 1.0 results in the normal scale. Larger values are useful to increase the scale of the GUI for high resolution displays.
This setting can only be configured by editing the settings configuration file.
menu transparency
@ -24,7 +20,6 @@ menu transparency
:Default: 0.84
This setting controls the transparency of the GUI windows.
The value should be between 0.0 (transparent) and 1.0 (opaque).
This setting can be adjusted in game with the Menu Transparency slider in the Prefs panel of the Options menu.
tooltip delay
@ -36,7 +31,6 @@ tooltip delay
This value determines the number of seconds between when you begin hovering over an item and when its tooltip appears.
This setting only affects the tooltip delay for objects under the crosshair in GUI mode windows.
There does not appear to be a setting to control the tool tip delay in outside of GUI mode.
The tooltip displays context sensitive information on the selected GUI element,
such as weight, value, damage, armor rating, magical effects, and detailed description.
@ -82,7 +76,7 @@ This setting enables or disables the "red flash" overlay that provides a visual
If this setting is disabled, the player will "bleed" like NPCs do.
The default value is true. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
werewolf overlay
----------------
@ -91,16 +85,16 @@ werewolf overlay
:Range: True/False
:Default: True
Enable or disable the werewolf overlay.
Enable or disable the werewolf visual effect in first-person mode.
The default value is true. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
color background owned
----------------------
:Type: RGBA floating point
:Range: 0.0 to 1.0
:Default: 0.15 0.0 0.0 1.0
:Default: 0.15 0.0 0.0 1.0 (dark red)
The following two settings determine the background color of the tool tip and the crosshair
when hovering over an item owned by an NPC.
@ -108,7 +102,6 @@ The color definitions are composed of four floating point values between 0.0 and
representing the red, green, blue and alpha channels. The alpha value is currently ignored.
The crosshair color will have no effect if the crosshair setting in the HUD section is disabled.
The default value is "0.15 0.0 0.0 1.0", which is a dark red color.
This setting can only be configured by editing the settings configuration file.
This setting has no effect if the show owned setting in the Game Settings Section is false.
@ -117,13 +110,12 @@ color crosshair owned
:Type: RGBA floating point
:Range: 0.0 to 1.0
:Default: 1.0 0.15 0.15 1.0
:Default: 1.0 0.15 0.15 1.0 (bright red)
This setting sets the color of the crosshair when hovering over an item owned by an NPC.
The value is composed of four floating point values representing the red, green, blue and alpha channels.
The alpha value is currently ignored.
The default value is "1.0 0.15 0.15 1.0" which is a bright red color.
This setting can only be configured by editing the settings configuration file.
This setting has no effect if the crosshair setting in the HUD Settings Section is false.
This setting has no effect if the show owned setting in the Game Settings Section is false.

@ -8,9 +8,10 @@ crosshair
:Range: True/False
:Default: True
This setting determines whether the crosshair or reticle is displayed.
This setting determines whether the crosshair or reticle is displayed. Enabling the crosshair provides more immediate feedback about which object is currently the focus of actions.
Some players perceive that disabling the crosshair provides a more immersive experience.
Another common use is to disable the crosshair for screen shots.
Enabling the crosshair provides more immediate feedback about which object is currently the focus of actions.
As an alternative to this setting, the complete GUI, including the crosshair, may be toggled at runtime with the F11 key.
This setting can be toggled with the Crosshair button in the Prefs panel of the Options menu.

@ -13,8 +13,7 @@ Values greater than approximately 18.0 will occasionally clip objects in the wor
Values greater than approximately 8.0 will clip the character's hands in first person view
and/or the back of their head in third person view.
The default value is 1.0. This setting can only be configured by editing the settings configuration file.
The value must be greater than 0.0, but it's unclear if the engine enforces this limitation.
This setting can only be configured by editing the settings configuration file.
small feature culling
---------------------
@ -28,7 +27,7 @@ It generally improves performance to enable this feature,
and by definition the culled objects will be very small on screen.
The size in pixels for an object to be considered 'small' is controlled by a separate setting.
The default value is true. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
small feature culling pixel size
--------------------------------
@ -88,7 +87,6 @@ Enabling the distant terrain setting is an alternative to increasing exterior ce
Note that the distant land setting does not include rendering of distant static objects,
so the resulting visual effect is not the same.
The default value is 6666.0.
This setting can be adjusted in game from the ridiculously low value of 2000.0 to a maximum of 6666.0
using the View Distance slider in the Detail tab of the Video panel of the Options menu.
@ -105,8 +103,7 @@ while large values cause distortion at the edges of the screen.
The "field of view" setting interacts with aspect ratio of your video resolution in that more square aspect ratios
(e.g. 4:3) need a wider field of view to more resemble the same field of view on a widescreen (e.g. 16:9) monitor.
The default value is 55.0. This setting can be changed in game using the Field of View slider
from the Video tab of the Video panel of the Options menu.
This setting can be changed in game using the Field of View slider from the Video tab of the Video panel of the Options menu.
first person field of view
--------------------------
@ -120,4 +117,4 @@ It is not recommended to change this value from its default value
because the Bethesda provided Morrowind assets do not adapt well to large values,
while small values can result in the hands not being visible.
The default value is 55.0. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.

@ -9,8 +9,9 @@ exterior cell load distance
:Default: 1
This setting determines the number of exterior cells adjacent to the character that will be loaded for rendering.
Values greater than 1 may significantly affect loading times when exiting interior spaces
or loading additional exterior cells. Caution is advised when increasing this setting.
.. Warning::
Values greater than 1 will significantly affect the frame rate and loading times. This setting is mainly intended for making screenshots of scenic vistas and not for real-time gameplay. Loading more cells can break certain scripts or quests in the game that expect cells to not be loaded until the player is there. These limitations will be addressed in a future version with a separate technique for rendering distant cells.
This setting interacts with viewing distance and field of view settings.
@ -193,4 +194,4 @@ pointers cache size
:Range: >0
:Default: 40
The count of object pointers, that will be saved for a faster search by object ID.
The count of object pointers that will be saved for a faster search by object ID. This is a temporary setting that can be used to mitigate scripting performance issues with certain game files. If your profiler (press F3 twice) displays a large overhead for the Scripting section, try increasing this setting.

@ -16,7 +16,7 @@ If the setting is 2, the crosshair is the color of the color crosshair owned set
If the setting is 3, both the tool tip background and the crosshair are colored.
The crosshair is not visible if crosshair is false.
The default value is 0 (no clues). This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
show projectile damage
----------------------
@ -25,9 +25,9 @@ show projectile damage
:Range: True/False
:Default: False
If this setting is true, damage bonus of arrows and bolts will be showed on item tooltip.
If this setting is true, the damage bonus of arrows and bolts will show on their tooltip.
The default value is false. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
show melee info
---------------
@ -36,9 +36,9 @@ show melee info
:Range: True/False
:Default: False
If this setting is true, melee weapons reach and speed will be showed on item tooltip.
If this setting is true, the reach and speed of melee weapons will show on their tooltip.
The default value is false. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
show enchant chance
-------------------
@ -49,7 +49,7 @@ show enchant chance
Whether or not the chance of success will be displayed in the enchanting menu.
The default value is false. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
best attack
-----------
@ -62,7 +62,6 @@ If this setting is true, the player character will always use the most powerful
(chop, slash or thrust). If this setting is false,
the type of attack is determined by the direction that the character is moving at the time the attack begins.
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.
can loot during death animation
@ -79,7 +78,7 @@ This is how original Morrowind behaves.
If this setting is false, player has to wait until end of death animation in all cases.
This case is more safe, but makes using of summoned creatures exploit (looting summoned Dremoras and Golden Saints for expensive weapons) a lot harder.
The default value is true. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
difficulty
----------
@ -107,7 +106,7 @@ show effect duration
Show the remaining duration of magic effects and lights if this 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.
This setting can only be configured by editing the settings configuration file.
prevent merchant equipping
--------------------------
@ -118,6 +117,8 @@ prevent merchant equipping
Prevents merchants from equipping items that are sold to them.
This setting can only be configured by editing the settings configuration file.
followers attack on sight
-------------------------
@ -127,3 +128,6 @@ followers attack on sight
Makes player followers and escorters start combat with enemies who have started combat with them or the player.
Otherwise they wait for the enemies or the player to do an attack first.
Please note this setting has not been extensively tested and could have side effects with certain quests.
This setting can only be configured by editing the settings configuration file.

@ -75,7 +75,7 @@ camera sensitivity
This setting controls the overall camera/mouse sensitivity when not in GUI mode.
The default sensitivity is 1.0, with smaller values requiring more mouse movement,
and larger values requiring less. This setting is multiplicative in magnitude.
and larger values requiring less.
This setting does not affect mouse speed in GUI mode,
which is instead controlled by your operating system mouse speed setting.

@ -8,9 +8,7 @@ global
:Range: True/False
:Default: False
If this setting is true, a world map on a map window will be displayed, otherwise a local map will be displayed.
This setting can be toggled with the local/world map switch button on the map window.
If this value is true, the map window will display the world map, otherwise the local map. The setting updates automatically when pressing the local/world map switch button on the map window.
global map cell size
--------------------
@ -112,5 +110,4 @@ local map cell distance
:Range: >= 1
:Default: 1
Similar to "[Cells] exterior cell load distance", controls how many cells are rendered on the local map.
Values higher than the default may result in longer loading times.
Similar to "exterior cell load distance" in the Cells section, controls how many cells are rendered on the local map. Values higher than the default may result in longer loading times. Please note that only loaded cells can be rendered, so this setting must be lower or equal to "exterior cell load distance" to work properly.

@ -8,10 +8,7 @@ character
:Range:
:Default: ""
This setting contains the default character name for loading saved games.
The default value is the empty string, which results in no character being selected by default.
This setting is automatically updated from the Load menu when a different character is selected.
This contains the default character for the Load Game menu and is automatically updated when a different character is selected.
autosave
--------
@ -32,6 +29,6 @@ timeplayed
:Default: False
This setting determines whether the amount of the time the player has spent playing will be displayed
for each saved game in the Load menu.
for each saved game in the Load menu. Currently, the counter includes time spent in menus, including the pause menu, but does not include time spent with the game window minimized.
This setting can only be configured by editing the settings configuration file.

@ -12,6 +12,8 @@ Force rendering with shaders. By default, only bump-mapped objects will use shad
Enabling this option may cause slightly different visuals if the "clamp lighting" option is set to false.
Otherwise, there should not be a visual difference.
Please note enabling shaders has a significant performance impact on most systems.
force per pixel lighting
------------------------
@ -21,7 +23,7 @@ force per pixel lighting
Force the use of per pixel lighting. By default, only bump mapped objects use per-pixel lighting.
Has no effect if the 'force shaders' option is false.
Enabling per-pixel lighting can result in visual differences to the original MW engine.
Enabling per-pixel lighting results in visual differences to the original MW engine.
It is not recommended to enable this option when using vanilla Morrowind files,
because certain lights in Morrowind rely on vertex lighting to look as intended.
@ -34,9 +36,10 @@ clamp lighting
Restrict the amount of lighting that an object can receive to a maximum of (1,1,1).
Only affects objects that render with shaders (see 'force shaders' option).
Always affects terrain. Setting this option to 'true' results in fixed-function compatible lighting,
but the lighting may appear 'dull' and there might be color shifts.
Setting this option to 'false' results in more realistic lighting.
Always affects terrain.
Leaving this option at its default makes the lighting compatible with Morrowind's fixed-function method,
but the lighting may appear dull and there might be color shifts. Setting this option to 'false' results in more dynamic lighting.
auto use object normal maps
---------------------------
@ -119,4 +122,4 @@ terrain specular map pattern
:Range:
:Default: _diffusespec
The filename pattern to probe for when detecting terrain specular maps (see 'auto use terrain specular maps')
The filename pattern to probe for when detecting terrain specular maps (see 'auto use terrain specular maps')

@ -13,67 +13,62 @@ which should usually be sufficient, but if you need to explicitly specify a devi
The names of detected devices can be found in the openmw.log file in your configuration directory.
The default value is the empty string. This setting can only be configured by editing the settings configuration file.
This setting can only be configured by editing the settings configuration file.
master volume
-------------
:Type: floating point
:Range: 0.0 to 1.0
:Range: 0.0 (silent) to 1.0 (maximum volume)
:Default: 1.0
This setting controls the overall volume.
The master volume is multiplied with all other volume settings to determine the final volume.
The master volume is multiplied with specific volume settings to determine the final volume.
The default value is 1.0. Valid values range from 0.0 (silent) to 1.0 (maximum volume).
This setting can be changed in game using the Master slider from the Audio panel of the Options menu.
footsteps volume
----------------
:Type: floating point
:Range: 0.0 to 1.0
:Range: 0.0 (silent) to 1.0 (maximum volume)
:Default: 0.2
This setting controls the volume of footsteps from the character and other actors.
Valid values range from 0.0 (silent) to 1.0 (maximum volume).
This setting can be changed in game using the Footsteps slider from the Audio panel of the Options menu.
music volume
------------
:Type: floating point
:Range: 0.0 to 1.0
:Range: 0.0 (silent) to 1.0 (maximum volume)
:Default: 0.5
This setting controls the volume for music tracks.
The default value is 0.5. Valid values range from 0.0 (silent) to 1.0 (maximum volume).
This setting can be changed in game using the Music slider from the Audio panel of the Options menu.
sfx volume
----------
:Type: floating point
:Range: 0.0 to 1.0
:Range: 0.0 (silent) to 1.0 (maximum volume)
:Default: 1.0
This setting controls the volume for special sound effects such as combat noises.
Valid values range from 0.0 (silent) to 1.0 (maximum volume).
This setting can be changed in game using the Effects slider from the Audio panel of the Options menu.
voice volume
------------
:Type: floating point
:Range: 0.0 to 1.0
:Range: 0.0 (silent) to 1.0 (maximum volume)
:Default: 0.8
This setting controls the volume for spoken dialog from NPCs.
Valid values range from 0.0 (silent) to 1.0 (maximum volume).
This setting can be changed in game using the Voice slider from the Audio panel of the Options menu.
buffer cache min
@ -129,5 +124,5 @@ This setting specifies which HRTF profile to use when HRTF is enabled. Blank mea
This setting has no effect if HRTF is not enabled based on the hrtf enable setting.
Allowed values for this field are enumerated in openmw.log file is an HRTF enabled ausio system is installed.
The default value is the empty string, which uses the default profile.
The default value is empty, which uses the default profile.
This setting can only be configured by editing the settings configuration file.

@ -8,9 +8,11 @@ distant terrain
:Range: True/False
:Default: False
Controls whether the engine will use paging and LOD algorithms to render the terrain of the entire world at all times.
Otherwise, only the terrain of the loaded cells is displayed.
This setting is best used together with the 'viewing distance' setting in the camera section.
Controls whether the engine will use paging and LOD algorithms to load the terrain of the entire world at all times.
Otherwise, only the terrain of the surrounding cells is loaded.
.. note::
When enabling distant terrain, make sure the 'viewing distance' in the camera section is set to a larger value so that you can actually see the additional terrain.
To avoid frame drops as the player moves around, nearby terrain pages are always preloaded in the background,
regardless of the preloading settings in the 'Cells' section,

@ -10,7 +10,7 @@ resolution x
This setting determines the horizontal resolution of the OpenMW game window.
Larger values produce more detailed images within the constraints of your graphics hardware,
but also significantly reduce the frame rate.
but may reduce the frame rate.
The window resolution can be selected from a menu of common screen sizes
in the Video tab of the Video Panel of the Options menu, or in the Graphics tab of the OpenMW Launcher.
@ -25,7 +25,7 @@ resolution y
This setting determines the vertical resolution of the OpenMW game window.
Larger values produce more detailed images within the constraints of your graphics hardware,
but also significantly reduce the frame rate.
but may reduce the frame rate.
The window resolution can be selected from a menu of common screen sizes
in the Video tab of the Video Panel of the Options menu, or in the Graphics tab of the OpenMW Launcher.
@ -128,9 +128,9 @@ vsync
This setting determines whether frame draws are synchronized with the vertical refresh rate of your monitor.
Enabling this setting can reduce screen tearing,
a visual defect caused by updating the image buffer in the middle of a screen draw.
Enabling this option typically implies limiting the framerate to 60 frames per second,
Enabling this option typically implies limiting the framerate to the refresh rate of your monitor,
but may also introduce additional delays caused by having to wait until the appropriate time
(the vertical blanking interval) to draw a frame.
(the vertical blanking interval) to draw a frame, and a loss in mouse responsiveness known as 'input lag'.
This setting can be adjusted in game using the VSync button in the Video tab of the Video panel in the Options menu.
It can also be changed by toggling the Vertical Sync check box in the Graphics tab of the OpenMW Launcher.
@ -170,8 +170,7 @@ contrast
This setting controls the contrast correction for all video in the game.
This setting can only be configured by editing the settings configuration file.
This setting does not currently work under Linux.
This setting can only be configured by editing the settings configuration file. It has been reported to not work on some Linux systems.
gamma
-----
@ -184,4 +183,4 @@ This setting controls the gamma correction for all video in the game.
Gamma is an exponent that makes colors brighter if greater than 1.0 and darker if less than 1.0.
This setting can be changed in the Detail tab of the Video panel of the Options menu.
This setting does not currently work under Linux, and the in-game setting in the Options menu has been disabled.
It has been reported to not work on some Linux systems, and therefore the in-game setting in the Options menu has been disabled on Linux systems.

@ -25,7 +25,7 @@ Hand editing the configuration file might result in some fine tuning for alignme
but the settings will be overwritten if a window is moved.
.. note::
To scale the windows, making the widgets proportionally larger, see the scaling factor setting instead.
To scale the windows, making the widgets proportionally larger, see the scaling factor setting in the GUI section instead.
:Type: boolean
:Range: True/False
@ -40,9 +40,6 @@ For example, to pin only the map window, the actual settings will be::
The pinnable window can be pinned/unpinned by clicking on a button in the right upper corner of the window.
.. note::
A world/local map switch button on the map window will be shown only in GUI mode.
stats
-----

Loading…
Cancel
Save