From cffd2bdd3075151ee18699a89d88d95e33adff97 Mon Sep 17 00:00:00 2001 From: Ryan Tucker Date: Tue, 18 Oct 2016 21:46:16 -0700 Subject: [PATCH] skeleton for full settings list --- docs/source/openmw-mods/settings/GUI.rst | 104 +++++++++++++++++++ docs/source/openmw-mods/settings/HUD.rst | 13 +++ docs/source/openmw-mods/settings/game.rst | 25 +++++ docs/source/openmw-mods/settings/general.rst | 9 ++ docs/source/openmw-mods/settings/index.rst | 16 ++- docs/source/openmw-mods/settings/input.rst | 9 ++ docs/source/openmw-mods/settings/saves.rst | 9 ++ docs/source/openmw-mods/settings/sound.rst | 9 ++ docs/source/openmw-mods/settings/video.rst | 9 ++ docs/source/openmw-mods/settings/water.rst | 9 ++ docs/source/openmw-mods/settings/windows.rst | 9 ++ 11 files changed, 220 insertions(+), 1 deletion(-) create mode 100644 docs/source/openmw-mods/settings/GUI.rst create mode 100644 docs/source/openmw-mods/settings/HUD.rst create mode 100644 docs/source/openmw-mods/settings/game.rst create mode 100644 docs/source/openmw-mods/settings/general.rst create mode 100644 docs/source/openmw-mods/settings/input.rst create mode 100644 docs/source/openmw-mods/settings/saves.rst create mode 100644 docs/source/openmw-mods/settings/sound.rst create mode 100644 docs/source/openmw-mods/settings/video.rst create mode 100644 docs/source/openmw-mods/settings/water.rst create mode 100644 docs/source/openmw-mods/settings/windows.rst diff --git a/docs/source/openmw-mods/settings/GUI.rst b/docs/source/openmw-mods/settings/GUI.rst new file mode 100644 index 000000000..945d660c7 --- /dev/null +++ b/docs/source/openmw-mods/settings/GUI.rst @@ -0,0 +1,104 @@ +GUI Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 + +This floating point 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. + +The default value is 1.0. This setting can only be configured by editing the settings configuration file. + +menu transparency +----------------- + +:Type: floating point +:Range: 0.0 (transparent) to 1.0 (opaque) +:Default: 0.84 + +This floating point setting controls the transparency of the GUI windows. The value should be between 0.0 (transparent) and 1.0 (opaque). +The default value is 0.84. This setting can be adjusted in game with the Menu Transparency slider in the Prefs panel of the Options menu. + +tooltip delay +------------- + +:Type: floating point +:Range: > 0.0 +:Default: 0.0 + +This floating point 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. + +The default value is 0.0. This setting can be adjusted between 0.0 and 1.0 in game with the Menu Help Delay slider in the Prefs panel of the Options menu. + +stretch menu background +----------------------- + +:Type: boolean +:Range: True/False +:Default: False + +Stretch or shrink the main menu screen, loading splash screens, introductory movie, and cut scenes to fill the specified video resolution, distorting their aspect ratio. The Bethesda provided assets have a 4:3 aspect ratio, but other assets are permitted to have other aspect ratios. If this setting is false, the assets will be centered in their correct aspect ratio, with black bars filling the remainder of the screen. + +The default value is false. This setting can only be configured by editing the settings configuration file. + +subtitles +--------- + +:Type: boolean +:Range: True/False +:Default: False + +Enable or disable subtitles for NPC spoken dialog (and some sound effects). Subtitles will appear in a tool tip box in the lower center of the screen. + +The default value is false. This setting can be toggled in game with the Subtitles button in the Prefs panel of Options menu. + +hit fader +--------- + +:Type: boolean +:Range: True/False +:Default: True + +This boolean setting enables or disables the "red flash" overlay that provides a visual clue when the character has taken damage. + +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. + +werewolf overlay +---------------- + +:Type: boolean +:Range: True/False +:Default: True + +Enable or disable the werewolf overlay. + +The default value is true. 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 + +The following two settings determine the background color of the tool tip and the crosshair when hovering over an item owned by an NPC. The color definitions are composed of four floating point values between 0.0 and 1.0 inclusive, 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. + +color crosshair owned +--------------------- + +:Type: RGBA floating point +:Range: 0.0 to 1.0 +:Default: 1.0 0.15 0.15 1.0 + +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. \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/HUD.rst b/docs/source/openmw-mods/settings/HUD.rst new file mode 100644 index 000000000..9a15e3aba --- /dev/null +++ b/docs/source/openmw-mods/settings/HUD.rst @@ -0,0 +1,13 @@ +HUD Settings +############ + +crosshair +--------- + +:Type: boolean +:Range: True/False +:Default: True + +This boolean setting determines whether the crosshair or reticle is displayed. 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 that is currently the focus of actions. + +The default value is true. This setting can be toggled with the Crosshair button in the Prefs panel of the Options menu. \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/game.rst b/docs/source/openmw-mods/settings/game.rst new file mode 100644 index 000000000..1feb3f7e9 --- /dev/null +++ b/docs/source/openmw-mods/settings/game.rst @@ -0,0 +1,25 @@ +Game Settings +############ + +show owned +---------- + +:Type: integer +:Range: 0, 1, 2, 3 +:Default: 0 + +Enable visual clues for items owned by NPCs when the crosshair is on the object. If the setting is 0, no clues are provided which is the default Morrowind behavior. If the setting is 1, the background of the tool tip for the object is highlight in the color specified by the color background owned setting in the GUI Settings Section. If the setting is 2, the crosshair is the color of the color crosshair owned setting in the GUI Settings section. 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. + +best attack +----------- + +:Type: boolean +:Range: True/False +:Default: False + +If this boolean setting is true, the player character will always use the most powerful attack when striking with a weapon (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. + diff --git a/docs/source/openmw-mods/settings/general.rst b/docs/source/openmw-mods/settings/general.rst new file mode 100644 index 000000000..f81a33ccc --- /dev/null +++ b/docs/source/openmw-mods/settings/general.rst @@ -0,0 +1,9 @@ +General Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/index.rst b/docs/source/openmw-mods/settings/index.rst index 3702556ab..86c7316da 100644 --- a/docs/source/openmw-mods/settings/index.rst +++ b/docs/source/openmw-mods/settings/index.rst @@ -18,4 +18,18 @@ Although this guide attempts to be comprehensive and up to date. You will always .. toctree:: :caption: Table of Contents - :maxdepth: 2 \ No newline at end of file + :maxdepth: 2 + + camera + cells + map + GUI + HUD + game + general + input + saves + sound + video + water + windows \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/input.rst b/docs/source/openmw-mods/settings/input.rst new file mode 100644 index 000000000..0ffcbc30d --- /dev/null +++ b/docs/source/openmw-mods/settings/input.rst @@ -0,0 +1,9 @@ +Input Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/saves.rst b/docs/source/openmw-mods/settings/saves.rst new file mode 100644 index 000000000..01fe9e68d --- /dev/null +++ b/docs/source/openmw-mods/settings/saves.rst @@ -0,0 +1,9 @@ +Saves Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/sound.rst b/docs/source/openmw-mods/settings/sound.rst new file mode 100644 index 000000000..8d11307f3 --- /dev/null +++ b/docs/source/openmw-mods/settings/sound.rst @@ -0,0 +1,9 @@ +Sound Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/video.rst b/docs/source/openmw-mods/settings/video.rst new file mode 100644 index 000000000..ba345a6e9 --- /dev/null +++ b/docs/source/openmw-mods/settings/video.rst @@ -0,0 +1,9 @@ +Video Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/water.rst b/docs/source/openmw-mods/settings/water.rst new file mode 100644 index 000000000..0d115f943 --- /dev/null +++ b/docs/source/openmw-mods/settings/water.rst @@ -0,0 +1,9 @@ +Water Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file diff --git a/docs/source/openmw-mods/settings/windows.rst b/docs/source/openmw-mods/settings/windows.rst new file mode 100644 index 000000000..1580ac220 --- /dev/null +++ b/docs/source/openmw-mods/settings/windows.rst @@ -0,0 +1,9 @@ +Windows Settings +############ + +scaling factor +-------------- + +:Type: floating point +:Range: > 0.0 +:Default: 1.0 \ No newline at end of file