Settings: Difference between revisions

From OpenMW Wiki
Jump to navigation Jump to search
m (Fix typo.)
(More details on the file format.)
Line 1: Line 1:
This page documents OpenMW configuration settings in the settings.cfg file.   
This page documents OpenMW configuration settings in the settings.cfg file.   
==Location==
The location of the settings.cfg file operating system dependent.  See [[Paths]] for more information.


==Format==
==Format==
Line 5: Line 9:
The settings.cfg file uses a variation of the [https://en.wikipedia.org/wiki/INI_file Windows INI file format].  The OpenMW variation uses hash marks (#) as the comment character instead of semicolons.
The settings.cfg file uses a variation of the [https://en.wikipedia.org/wiki/INI_file Windows INI file format].  The OpenMW variation uses hash marks (#) as the comment character instead of semicolons.


==Location==
Settings are divided into sections of related settings that begin with a declaration composed of the section name inside square brackets.  Settings follow one per line, with the setting name, an equals sign (=), and the value.  An example '''Video''' section looks like this:
 
  [Video]
  # Set the resolution to 800x600
  resolution x = 800
  resolution y = 600
  # Run in full screen mode
  fullscreen = true
  # Limit framerate to 60.0 frames per second.
  framerate = 60.0


The location of the settings.cfg file operating system dependentSee [[Paths]] for more information.
Settings value types are boolean, integer, floating point and string.  Comments are not allowed on the line following a setting value assignment.  The sections and the settings may be in any order.  Duplicate setting assignments are not permitted.  While multiple declarations of the same section are permitted, this configuration is not recommended, and future code might reorder the settings or disallow this featureSetting assignments are allowed to follow the section declaration on the same line, but this configuration is not recommended.


==Sections==
==Sections==
Descriptions of individual settings are divided into separate pages according to the section in which they appear:


* [[Camera Settings Section]] - Clipping, view distance, culling, etc.
* [[Camera Settings Section]] - Clipping, view distance, culling, etc.

Revision as of 18:50, 24 November 2015

This page documents OpenMW configuration settings in the settings.cfg file.

Location

The location of the settings.cfg file operating system dependent. See Paths for more information.

Format

The settings.cfg file uses a variation of the Windows INI file format. The OpenMW variation uses hash marks (#) as the comment character instead of semicolons.

Settings are divided into sections of related settings that begin with a declaration composed of the section name inside square brackets. Settings follow one per line, with the setting name, an equals sign (=), and the value. An example Video section looks like this:

 [Video]
 # Set the resolution to 800x600
 resolution x = 800
 resolution y = 600
 # Run in full screen mode
 fullscreen = true
 # Limit framerate to 60.0 frames per second.
 framerate = 60.0

Settings value types are boolean, integer, floating point and string. Comments are not allowed on the line following a setting value assignment. The sections and the settings may be in any order. Duplicate setting assignments are not permitted. While multiple declarations of the same section are permitted, this configuration is not recommended, and future code might reorder the settings or disallow this feature. Setting assignments are allowed to follow the section declaration on the same line, but this configuration is not recommended.

Sections

Descriptions of individual settings are divided into separate pages according to the section in which they appear: