UFOpaedia - User contributions [en]

Soldier Names (OpenXcom)

2013-07-02T00:53:43Z

54x: /* Format */

OpenXcom allows customization of the [[Soldier Name Stats|soldier names]] used when generating new soldiers. They are stored in the ''Data\SoldierName'' folder with a .nam extension.

== Format ==

Each file contains a set of soldier names stored in YAML format.

<pre>
lookweights:
- 35
- 35
- 15
- 15
maleFirst:
- Austin
- Calvin
- Carl
...
femaleFirst:
- Barbara
- Catherine
- Evelyn
...
maleLast:
- Bradley
- Bryant
- Carr
- ...
femaleLast:
- ...
</pre>

When generating a name for a new soldier, a random first and last name are picked from a random set. If ''femaleFirst'' or ''femaleLast'' are omitted, then respectively ''maleFirst'' or ''maleLast'' are used for both genders.

Soldier names should only use [[Wikipedia:Romanisation|the basic Latin alphabet]], since they are shared among languages, to ensure everyone can read them.

Each .nam file also contains lookweights that effect the chance that each of the four default looks will be chosen- these follow the number order of the looks in the data files, so the first weight corresponds with look 0 for either gender, then look 1, etc...

== External Links ==

* [http://openxcom.org/forum/index.php/topic,205.0.html Soldier Names thread]
* [https://github.com/SupSuper/OpenXcom/tree/master/bin/data/SoldierName Latest Soldier Names in Github]

[[Category:OpenXcom]]

Options (OpenXcom)

2013-03-23T08:14:19Z

54x: /* Advanced Options */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''pauseMode''': Controls how the game behaves on loss of focus.
** 0,1 = Continue running normally on loss of focus.
** 2 = Slow down the game on loss of focus.
** 3 = Pause completely on loss of focus.
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated. This setting is only compatible with 320x200, 640x400 and 960x600 resolutions.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which smoothes pixel edges, but not quite to the extreme of useHQXFilter.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in a more subtle smoothing of pixel edges.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, aliens on any type of mission may detect your base if they are in very close range.
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''NewBattle_''': (...various options starting with this prefix) Stores your game settings from last time you started a random battle.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and opening the inventory screen resets TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-03-13T06:28:08Z

54x: /* Geoscape */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''pauseMode''': Controls how the game behaves on loss of focus.
** 0,1 = Continue running normally on loss of focus.
** 2 = Slow down the game on loss of focus.
** 3 = Pause completely on loss of focus.
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less extreme smoothing.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in much less smoothing.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, aliens on any type of mission may detect your base if they are in very close range.
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''NewBattle_''': (...various options starting with this prefix) Stores your game settings from last time you started a random battle.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and opening the inventory screen resets TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-03-05T09:48:15Z

54x: /* Debug mode */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''pauseMode''': Controls how the game behaves on loss of focus.
** 0,1 = Continue running normally on loss of focus.
** 2 = Slow down the game on loss of focus.
** 3 = Pause completely on loss of focus.
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less extreme smoothing.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in much less smoothing.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''NewBattle_''': (...various options starting with this prefix) Stores your game settings from last time you started a random battle.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and opening the inventory screen resets TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-03-05T09:45:44Z

54x:

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''pauseMode''': Controls how the game behaves on loss of focus.
** 0,1 = Continue running normally on loss of focus.
** 2 = Slow down the game on loss of focus.
** 3 = Pause completely on loss of focus.
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less extreme smoothing.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in much less smoothing.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''NewBattle_''': (...various options starting with this prefix) Stores your game settings from last time you started a random battle.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-27T00:39:11Z

54x: /* System */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less extreme smoothing.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in much less smoothing.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-27T00:35:28Z

54x: /* System */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader''' Applies both a dot grid effect and a bloom effect.
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less curvature.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Applies a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in dramatically less curvature.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-27T00:30:19Z

54x: /* Geoscape */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader'''
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less curvature.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Mimics a phosphor-based display by applying a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in dramatically less curvature.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canManufactureMoreItemsPerHour''': When enabled, very large amounts of engineers can reduce manufacturing time below one hour, occasionally producing extra items per hour in proportion to the number of engineers assigned.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-27T00:27:59Z

54x: /* Battlescape */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader'''
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less curvature.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Mimics a phosphor-based display by applying a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in dramatically less curvature.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, grenades are "hot". This means they do not need to be primed, and simply explode on impact. (previously battleAltGrenade)
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-27T00:26:33Z

54x: /* System */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled. This option takes a path relative to the OpenXcom DATA folder as an argument. Listed below are the available YAML filters that are packaged with recent nightly builds.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
** '''Shaders/Curvature.OpenGL.shader''': Simulates a rounded display.
** '''Shaders/dot_n_bloom.OpenGL.shader'''
** '''Shaders/heavybloom.OpenGL.shader''': Applies a very heavy bloom effect.
** '''Shaders/HQ2X.OpenGL.shader''': A double-scale version of '''useHQXFilter''', which results in less curvature.
** '''Shaders/Phosphor-simple.OpenGL.shader''' Mimics a phosphor-based display by applying a dot grid effect.
** '''Shaders/Pixellate.OpenGL.shader''': Default graphics behaviour, but using OpenGL.
** '''Shaders/SABR.OpenGL.shader''': Applies texel-based smoothing to the display.
** '''Shaders/Scale4xHQ.OpenGL.shader''': A quadruple-scale version of '''useHQXFilter''', which results in dramatically less curvature.
** '''Shaders/simplebloom.OpenGL.shader''': Applies a bloom effect.
*'''useOpenGLSmoothing''': When enabled, the game will use linear interpolation instead of whole-pixel scaling when no shader is enabled.
*'''useScaleFilter''': When enabled, passes the game through a software Scale2x filter. This option achieves similar results to HQX but with less overhead and slightly less quality.
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleAltGrenade''': When enabled, activates hot grenade behaviour.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, ?
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-26T22:30:55Z

54x: /* System */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': When enabled, disables all audio output. Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
*'''useOpenGLSmoothing''': When enabled, ?
*'''useScaleFilter''': When enabled, ?
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleAltGrenade''': When enabled, activates hot grenade behaviour.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, ?
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-25T23:25:50Z

54x: /* Battlescape */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': Disable all audio output (true/false). Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
*'''useOpenGLSmoothing''': When enabled, ?
*'''useScaleFilter''': When enabled, ?
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleAltGrenade''': When enabled, activates hot grenade behaviour.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, ?
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders.

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-25T23:14:21Z

54x: /* System */

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': Disable all audio output (true/false). Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when the '''useOpenGL''' option is enabled.
** '''Shaders/CRT-interlaced.OpenGL.shader''': Mimics a CRT monitor by adding interlaced lines and simulating a rounded display. (default)
*'''useOpenGLSmoothing''': When enabled, ?
*'''useScaleFilter''': When enabled, ?
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleAltGrenade''': When enabled, activates hot grenade behaviour.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, ?
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]

Options (OpenXcom)

2013-02-25T23:09:21Z

54x:

[[Image:OpenXcomOptions.png|right|thumb|OpenXcom Options screen]]

OpenXcom has a variety of game settings that can be customized through the Options screen in the Main Menu:

* '''Display Resolution:''' Resolution the game is rendered at. Note that the game always renders at 320x200 (original DOS resolution) and resizes to whatever you specify, so for a better picture use a resolution with the same ratio. 640x400 or 640x480 (if you like non-square pixels) are recommended. Use the arrows to scroll through the resolutions supported by your monitor, or click on the numbers to type in your own resolution. If you screw it up, edit or delete your ''options.cfg'' (see below) to revert the resolution.
* '''Display Mode:''' Display the game in a window or covering the whole screen. Windowed mode is recommended as monitors usually don't properly support OpenXcom's lo-fi nature in fullscreen.
* '''Music Volume:''' The volume of the background music (1 is lowest, 5 is highest).
* '''SFX Volume:''' The volume of the sound effects (1 is lowest, 5 is highest).
* '''Language:''' Change the language used to display all the game text.

More options may be added as development continues.

== User Folder ==
OpenXcom creates a User folder with all the screenshots, savegames and options in one of the following paths.

You can also specify your own path by passing the command-line argument "-user <user path>".

* <working directory>\user\
* <binary directory>\user\

=== Windows ===
* C:\Documents and Settings\<user>\My Documents\OpenXcom
* C:\Users\<user>\Documents\OpenXcom

=== Mac OS X ===
* ~/Library/Application Support/OpenXcom

=== Unix-like ===
* $XDG_DATA_HOME/openxcom (usually ~/.local/share/openxcom/data/)
* $XDG_CONFIG_HOME/openxcom (usually /usr/share/openxcom/data/:/usr/local/share/openxcom/data/)

== Advanced Options ==

OpenXcom stores its options in a ''options.cfg'' YAML file stored in the User folder, which can be easily edited with any text editor. You can also pass them as command line arguments in the form "-<option name> <option value>". These include the options shown in the Options screen as well as other advanced options.

'''WARNING:''' Invalid values can cause incorrect behaviour or game crashes. Options that accept true/false are marked by "When enabled", options that accept a range of numbers have this listed in brackets after their description, and options that accept a numeric flag have sub-bullets to describe the functionality of each option.

=== System ===

*'''allowResize''': When enabled and the game is in windowed mode, the game resolution can be dynamically resized by changing the window size.
*'''baseXResolution''': The available display width in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''baseYResolution''': The available display height in pixels. Defaults to 320. Enabling this setting may cause issues with some graphical features that have not yet been coded to scale with this setting.
*'''displayWidth''': Display width in pixels. The game will scale the base width to fit this value, so it should be greater than or equal to '''baseXResolution'''.
*'''displayHeight''': Display height in pixels. The game will scale the base height to fit this value, so it should be greater than or equal to '''baseYResolution'''.
*'''fullscreen''': When enabled, the game will run in fullscreen mode as opposed to windowed mode.
*'''musicVolume''': Background music volume (0-128).
*'''soundVolume''': Sound FX volume (0-128).
*'''mute''': Disable all audio output (true/false). Automatically enabled if no audio hardware is available.
*'''audioBitDepth''': Bit depth of the output audio. ''Only change this if you know what you're doing!''
*'''audioSampleRate''': Sample rate (in Hz) of the output audio. ''Only change this if you know what you're doing!''
*'''debug''': When enabled, provides features to make it easier for developers/contributors to debug their work.
*'''debugUi''': When enabled, shows text borders in UI elements to make it easier for developers/translators to debug their work.
*'''fpsCounter''': When enabled, shows FPS Counter on the top-left of the screen.
*'''language''': Filename of the language loaded at startup.
*'''keyboardMode''': Keyboard input mode.
** 0 = Keyboard enabled.
** 1 = Keyboard disabled, type in text boxes with the arrow keys (arcade style).
*'''useHQXFilter''': When enabled, applies a rendering filter that smoothes out diagonal edges, making the game look less pixelated.
*'''useOpenGL''': When enabled, applies a rendering filter corresponding to the '''useopenGLShader''' option.
*'''useOpenGLShader''': Selects which rendering filter to apply when OpenGL is enabled.
*'''useOpenGLSmoothing''': When enabled, ?
*'''useScaleFilter''': When enabled, ?
*'''vSyncForOpenGL''': When enabled, puts OpenGL into vertical synchronisation mode, ensuring OpenGL does not exceed your monitor's refresh rate, possibly causing less smooth animation and tearing.

=== Geoscape ===

*'''agressiveRetaliation''': When enabled, ?
*'''alienContainmentHasUpperLimit''': When enabled, restricts the amount of live aliens that can be held in each containment facility.
*'''allowAutoSellProduction''': When enabled, players may choose to automatically sell manufactured items.
*'''canSellLiveAliens''': When enabled, captured aliens can be sold for cash in the same fashion as alien corpses.
*'''changeValueByMouseWheel''': When enabled, scrolling the mouse wheel over increase and decrease buttons will change the value.
*'''craftLaunchAlways''': When enabled, allow crafts to take off without being READY.
*'''globeAllRadarsOnBaseBuild''': When enabled, hovering over a valid base location will also display the range in which small radars, large radars, and hyperwave decoders will detect UFOs.
*'''globeSeasons''': When enabled, the day/night cycle takes into account the time of year and tilts the edge between day and night appropriately.
*'''showFundsOnGeoscape''': When enabled, shows your available funds above the time of day on the geoscape toolbar.

=== Battlescape ===

*'''battleAlienSpeed''': Alien unit movement speed.
*'''battleAltGrenade''': When enabled, activates hot grenade behaviour.
*'''battleExplosionHeight''': A coefficient that controls how much vertical power explosions have.
** 0 = Explosions are completely flat, as per the original game.
** 1 = -30 damage units per level (this penalty is in addition to the horizontal penalty of -10 damage per tile)
** 2 = -10 damage units per level
** 3 = -5 damage units per level (default)
*'''battleInstantGrenade''': When enabled, ?
*'''battlePreviewPath''': When enabled, your first left-click displays the planned path, and your second confirms the move order.
*'''battleFireSpeed''': Bullet movement speed.
*'''battleNotifyDeath''': When enabled, displays a text notification of soldier deaths.
*'''battleRangeBasedAccuracy''': When enabled, targets at long range are harder to hit with snap and auto shots.
*'''battleScrollButton''': Controls which mouse button triggers scrolling in scrolling type 0.
*'''battleScrollDragButtion''': Controls which mouse button triggers dragging behaviour in scrolling type 2.
*'''battleScrollDragInvert''': When enabled, drag scrolling moves the camera towards the direction your mouse is moving in, rather than away from it.
*'''battleScrollSpeed''': Map scrolling speed.
*'''battleScrollType''': Map scrolling mode.
** 0 = Trigger Scroll
** 1 = Auto Scroll
** 2 = Drag Scroll
*'''battleXcomSpeed''': X-COM unit movement speed.
*'''showMoreStatsInInventoryView''': When enabled, the inventory screen displays the weight of equipment the soldier is currently wearing/carrying, and their maximum weight before TU reduction sets in, in addition to displaying the Time Units remaining once you have begun the battle.
*'''strafe''': When enabled, allows soldiers to move without changing their facing direction by holding control when issuing orders

== Debug mode ==

''Debug mode'' is a special feature that makes it easier for developers/contributors to test out game features without needing to play a new game from scratch. After setting "debug: true" in the ''options.cfg'' file (see above), you can enable it by pressing D in-game to access a variety of features:

'''Geoscape''': All research is unlocked, allowing you to easily test all features in the Geoscape without needing to manually unlock them yourself. This doesn't affect your saved game.

'''Battlescape''': Whole map is revealed and actions cost no TUs, allowing you to easily test out the map and any Battlescape features without being affected by game restrictions.

== Keyboard Shortcuts ==
*'''F5''' – Toggles a FPS counter in top-left corner.
*'''F12''' – Saves a PNG screenshot to the User folder.
*'''ALT-ENTER''' – Toggles fullscreen mode.

''(As of recent nightly builds, there are custom keyboard shortcuts available under a button in the options menu)''

== Custom Music ==

If you don't like or have trouble getting the original X-COM music to work, you can use your own (eg. the [http://www.xcomufo.com/x1music.html Playstation] or [http://lorcan.freelanzer.com/ Cydonia's Fall] soundtracks) by putting it in the SOUND subfolder of the [[Installing (OpenXcom)#Data Folder|Data folder]] with the same filenames as the original:

*'''GMDEFEND''' - Base Defense Briefing.
*'''GMENBASE''' - Mission Briefing.
*'''GMGEO1''' - Geoscape 1.
*'''GMGEO2''' - Geoscape 2.
*'''GMINTER''' - Interception / Dogfight.
*'''GMINTRO1''' - Intro 1.
*'''GMINTRO2''' - Intro 2.
*'''GMINTRO3''' - Intro 3.
*'''GMLOSE''' - Game Over.
*'''GMMARS''' - Debriefing.
*'''GMNEWMAR''' - Mars Briefing.
*'''GMSTORY''' - Title.
*'''GMTACTIC''' - Battlescape.
*'''GMWIN''' - Victory.

The formats supported are MIDI, MP3, OGG and MOD. You might need to delete the original music (including GM.CAT) for it to work.

[[Category:OpenXcom]]