Springsettings.cfg

From Spring
Jump to: navigation, search

Springsettings.cfg

springsettings.cfg is the configuration file of the Spring Engine.

Below is a comprehensive list of all the values available. This page is an attempt to thoroughly document them all.

Such list can be created by starting Spring with --list-config-vars as commandline parameter. For example on windows: spring.exe --list-config-vars > cfgdoc.txt

A setting can be changed by starting spring (.exe) without parameters and clicking edit settings. Some changes require spring to be restarted.

Location

99.0+

The (non-default) contents of the config are now printed in users' infolog.txt. Deprecated locations are no longer read from, as follows:

  • Windows: AppData\Local\springsettings.cfg
  • Linux/MacOSX: ~/.config/spring/springsettings.cfg

95.0+

On Windows it's ../My Documents/My Games/Spring/springsettings.cfg, and on Linux/MacOSX it's ~/.config/spring/springsettings.cfg

< 95.0

On Windows it's %APPDATA%\Local\springsettings.cfg, and on Linux/MacOSX it has a different name and is ~/.springrc

Portable Mode

If spring detects springsettings.cfg next to spring.exe it runs in portable mode (meaning it writes config settings / infolog.txt / etc in the same directory where spring.exe exists).

Safemode

Spring supports a safemode, which can be enabled with spring --safemode. There is a startmenu link to it and some lobbies got an option for it, too. But it's not meant for regular gaming, it's just a debugmode to find out if runtime problems are caused by incorrect settings. So you can try it and discuss it with devs for further help.

Available Options

(last update: 104.0)

THIS SECTION IS AUTOMATICALLY GENERATED! DON'T EDIT IT!
alias
type default min max safemode
bool true false
Defines whether or not the trees generated by the engine (Default trees) will be shown as 3d or as cross sectioned ( + ) flat sides.
alias
type default min max safemode
bool true false
Enable shaders for terrain rendering.
alias
type default min max safemode
bool false
Enables High Resolution Clouds.
alias
type default min max safemode
bool true false
Determines whether specular highlights and other lighting effects are rendered for units.
alias
type default min max safemode
bool false false
source pos
alias
type default min max safemode
bool false false
source pos
alias
type default min max safemode
bool false false
source pos
alias
type default min max safemode
bool true
allow any unauthenticated clients to join as spectator with any name, name will be prefixed with ~
alias
type default min max safemode
int -1 -1 1
Enables graphics drivers workarounds for users with ATI video cards.
-1:=runtime detect, 0:=off, 1:=on
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool false
Controls whether or not units built by factories will inherit that factory's unit group.
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
string "127.0.0.1"
source pos
alias
type default min max safemode
int 0
source pos
alias
type default min max safemode
bool false true
Disables kwin compositing to fix tearing, possible fixes low FPS in windowed mode, too.
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float 0 0
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
int 24 16 32
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool true
Sets whether Bumpmapped water will be drawn beyond the map edge.
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
int 1 0 2
Determines the amount of objects reflected in Bumpmapped water.

0:=off, 1:=fast (skip terrain), 2:=full

alias
type default min max safemode
int 1 0 1
Determines the method of refraction with Bumpmapped water.

0:=off, 1:=screencopy, 2:=own rendering cycle (disabled)

alias
type default min max safemode
bool true false
Enables rendering of shorewaves.
alias
type default min max safemode
int 512 32
Sets the size of the framebuffer texture used to store the reflection in Bumpmapped water.
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 150
When free camera is locked, AutoTilt will point the camera in the direction of the ground's slope
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float 45
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float -500
When free camera is locked, Gravity will be used if you jump off of a ground ramp.
alias
type default min max safemode
float 16
Determines ground handling for the free camera.

0 - the camera can move anywhere, < 0 - the camera is always offset from the ground height by -CamFreeGroundOffset > 0 - the camera can be "locked" to the ground by using SHIFT UP_ARROW. (and will use CamFreeGroundOffset as the offset). To release the lock, simply press SHIFT DOWN_ARROW.

alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float 500
source pos
alias
type default min max safemode
float 0.5
source pos
alias
type default min max safemode
float 150
source pos
alias
type default min max safemode
float 1.5
source pos
alias
type default min max safemode
int 2 0 5
Defines the used camera. Options are:

0 = FPS 1 = Overhead 2 = Spring 3 = RotOverhead 4 = Free 5 = Overview

alias
type default min max safemode
string ""
source pos
alias
type default min max safemode
bool false
Rotate camera when cursor touches screen borders.
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
float 45
source pos
alias
type default min max safemode
bool true
Whether cardinal directions should be `locked` for a short time when rotating.
alias
type default min max safemode
int 10
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float 4 0
Camera transitions happen at lerp(old, new, timeNorm ^ CamTimeExponent).
alias
type default min max safemode
float 1 0
Scales the speed of camera transitions, e.g. zooming or position change.
alias
type default min max safemode
bool true
If heightmap (default hotkey [F1]) should be colored or not.
alias
type default min max safemode
bool false true
Runtime compress most textures to save VideoRAM.
alias
type default min max safemode
float 0.5
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 12
source pos
alias
type default min max safemode
int 128 1
source pos
alias
type default min max safemode
int 128 1
source pos
alias
type default min max safemode
bool false
Enables GL debug-context and output. (see GL_ARB_debug_output)
alias
type default min max safemode
bool false
Create a stacktrace when an OpenGL error occurs
alias
type default min max safemode
string ""
Sets the default menu to be used when spring is started.
alias
type default min max safemode
string ""
filename of script.txt to use when no command line parameters are specified.
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool false
Allow to play every replay file (may crash / cause undefined behaviour in replays)
alias
type default min max safemode
float 200
Double click time in milliseconds.
alias
type default min max safemode
bool false
When set, will make the left half of the screen the minimap when DualScreenMode is set.
alias
type default min max safemode
bool false
Sets whether to split the screen in half, with one half for minimap and one for main screen. Right side is for minimap unless DualScreenMiniMapOnLeft is set.
alias
type default min max safemode
bool false
Sets whether the clouds in the sky will be procedurally generated and moved. Resource heavy!
alias
type default min max safemode
bool true
If EdgeMove scrolling speed should fade with edge distance.
alias
type default min max safemode
float 0.02 0
The width (in percent of screen size) of the EdgeMove scrolling area.
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 45
EXTREME CPU-HEAVY ON MEDIUM/BIG MAPS! DON'T CHANGE DEFAULT!
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
float 45
source pos
alias
type default min max safemode
float 0.01
source pos
alias
type default min max safemode
int 10
source pos
alias
type default min max safemode
int 0 0 32
Deprecated, set MSAALevel instead.
alias
type default min max safemode
float 6000 0
Maximum distance at which features will be drawn.
alias
type default min max safemode
float 4500 0
Distance at which features will begin to fade from view.
alias
type default min max safemode
string "fonts/FreeSansBold.otf"
Sets the font of Spring engine text.
alias
type default min max safemode
float 25
Sets the opacity of Spring engine text, such as the title screen version number, clock, and basic UI. Does not affect LuaUI elements.
alias
type default min max safemode
int 3
Sets the width of the black outline around Spring engine text, such as the title screen version number, clock, and basic UI. Does not affect LuaUI elements.
alias
type default min max safemode
int 23
Sets the font size (in pixels) of the MainMenu and more.
alias
type default min max safemode
int 0 0 1
source pos
alias
type default min max safemode
int 0 0 1
source pos
alias
type default min max safemode
int 0 0 1
source pos
alias
type default min max safemode
int 1 0 1
source pos
alias
type default min max safemode
bool true
Sets whether the game will run in fullscreen, as opposed to a window. For Windowed Fullscreen of Borderless Window, set this to 0, WindowBorderless to 1, and WindowPosX and WindowPosY to 0.
alias
type default min max safemode
bool true
see WindowedEdgeMove, just for fullscreen mode
alias
type default min max safemode
int 3 3 4
source pos
alias
type default min max safemode
int 0 0 5
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 7 0
Sets how detailed the engine rendered grass will be on any given map.
alias
type default min max safemode
int 3
Controls whether ground decals underneath buildings and ground scars from explosions will be rendered. Values >1 define how long such decals will stay.
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 60 4 200
Controls how detailed the map geometry will be. On lowered settings, cliffs may appear to be jagged or "melting".
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
int 0
source pos
alias
type default min max safemode
float 0.8 0 1
Sets the opacity of the built-in Spring UI. Generally has no effect on LuaUI widgets. Can be set in-game using shift+, to decrease and shift+. to increase.
alias
type default min max safemode
int 10 -1 600
Number of seconds that, if spent in the same code segment, indicate a hang; -1 to disable.
alias
type default min max safemode
bool false
Sets hardware mouse cursor rendering. If you have a low framerate, your mouse cursor will seem "laggy". Setting hardware cursor will render the mouse cursor separately from spring and the mouse will behave normally. Note, not all GPU drivers support it in fullscreen mode!
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool false
Controls whether LOS ("L view") edges are rendered in high resolution. Resource heavy!
alias
type default min max safemode
string "localhost"
Default IP to use for hosting if not specified in script.txt
alias
type default min max safemode
int 8452 0 65535
Default Port to use for hosting if not specified in script.txt
alias
type default min max safemode
string "0.26 0.96 0.41 0.205"
source pos
alias
type default min max safemode
int 10
Timeout till old messages disappear from the ingame console.
alias
type default min max safemode
int 30 10
source pos
alias
type default min max safemode
string ""
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 0
source pos
alias
type default min max safemode
int 750 0
Timeout in milliseconds waiting for a key chain shortcut.
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
string "No map selected"
Stores the previously played map.
alias
type default min max safemode
string "No game selected"
Stores the previously played game.
alias
type default min max safemode
string "No script selected"
Stores the previously played AI.
alias
type default min max safemode
string ""
Stores the previously selected setting, when editing settings within the Spring main menu.
alias
type default min max safemode
int 64 0
source pos
alias
type default min max safemode
int 512 0
source pos
alias
type default min max safemode
int 32768 0
source pos
alias
type default min max safemode
int 2048 0
source pos
alias
type default min max safemode
int 65536 0
source pos
alias
type default min max safemode
int 0 0
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
int 50
Flush the logfile when a message's level exceeds this value. ERROR is flushed by default, WARNING is not.
alias
type default min max safemode
int 10
Allow at most this many consecutive identical messages to be logged.
alias
type default min max safemode
string ""
Comma-separated list of enabled logsections, see infolog.txt / console output for possible values.
alias
type default min max safemode
bool true false
source pos
alias
type default min max safemode
bool true
Enable LuaSocket support, allows a lua-widget to make TCP/UDP Connections
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 0 0 32
Enables multisample anti-aliasing; 'level' is the number of samples used.
alias
type default min max safemode
bool true
Draws a solid border at the edges of the map.
alias
type default min max safemode
int 1 0
source pos
alias
type default min max safemode
int 1 0
source pos
alias
type default min max safemode
float 5 1
in MilliSecs
alias
type default min max safemode
int 2000 1
source pos
alias
type default min max safemode
int 10000 1
source pos
alias
type default min max safemode
int 512 64
Maximum memusage (in MByte) of multithreaded pathcache generator at loading time.
alias
type default min max safemode
int 128 1
Maximum parallel played sounds.
alias
type default min max safemode
int 1400 400
source pos
alias
type default min max safemode
string "Spring Bitmaps"
Archive name for the default Menu.
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
float 0.01
source pos
alias
type default min max safemode
int 16
source pos
alias
type default min max safemode
float -0.5
source pos
alias
type default min max safemode
int 1 0
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
string "2 2 200 200"
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 0 0
The refresh rate of the async MiniMap texture. Needs MiniMapRenderToTexture to be true. Value of "0" autoselects between 10-60FPS.
alias
type default min max safemode
bool true false
Asynchronous render MiniMap to a texture independent of screen FPS.
alias
type default min max safemode
float 0.25
source pos
alias
type default min max safemode
float 2.5 0
source pos
alias
type default min max safemode
int 0 0 1
When set to 1 minimize Window if it loses key focus when in fullscreen mode.
alias
type default min max safemode
float 0.3
source pos
alias
type default min max safemode
int 0 0 2
source pos
alias
type default min max safemode
int 120 0
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
float 45
source pos
alias
type default min max safemode
float 1
float multiplier for maximum overhead camera height
alias
type default min max safemode
int 10
source pos
alias
type default min max safemode
float 1
source pos
alias
type default min max safemode
int 0 0 1
source pos
alias
type default min max safemode
bool false
When enabled adjust sound speed/pitch to game speed.
alias
type default min max safemode
int 1 0 3 2
Use ROAM for terrain mesh rendering: 0 to disable, {1=VBO,2=DL,3=VA}-mode to enable.
alias
type default min max safemode
int 15 0
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
float 45
source pos
alias
type default min max safemode
float 0.01
source pos
alias
type default min max safemode
int 10
source pos
alias
type default min max safemode
bool false
Rotate logfiles, old logfiles will be moved into the subfolder "log".
alias
type default min max safemode
float 4 0
source pos
alias
type default min max safemode
float 4 0
source pos
alias
type default min max safemode
int 0
source pos
alias
type default min max safemode
float 25 -255 255
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
int 5
number of milliseconds to sleep per tick
alias
type default min max safemode
unsigned 0 1
Defines a bitmask indicating which CPU cores the main-thread should use.
alias
type default min max safemode
unsigned 0 1
Defines a bitmask indicating which CPU cores the sim-thread should use.
alias
type default min max safemode
int 2048 32
Sets the resolution of shadows. Higher numbers increase quality at the cost of performance.
alias
type default min max safemode
int 1
source pos
alias
type default min max safemode
int 2 -1 -1
Sets whether shadows are rendered.

-1:=forceoff, 0:=off, 1:=full, 2:=fast (skip terrain)

alias
type default min max safemode
bool true
Displays a clock on the top-right corner of the screen showing the elapsed time of the current game.
alias
type default min max safemode
bool false
Displays current framerate.
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 1
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool false
Displays current game speed.
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
string "fonts/FreeSansBold.otf"
Sets the font of Spring engine small text.
alias
type default min max safemode
float 10
see FontOutlineWeight
alias
type default min max safemode
int 2
see FontOutlineWidth
alias
type default min max safemode
int 14
Sets the font size (in pixels) of the engine GUIs and more.
alias
type default min max safemode
bool true
Select the Sound driver, true = OpenAL, false = NullAudio
alias
type default min max safemode
int 0
source pos
alias
type default min max safemode
int 1 1 2
Sets how server adjusts speed according to player's load (CPU), 1: use average, 2: use highest
alias
type default min max safemode
string "."
source pos
alias
type default min max safemode
string ""
List of addidional data-directories, separated by ';' on windows, ':' on other OSs
alias
type default min max safemode
string "*"
source pos
alias
type default min max safemode
string "*"
source pos
alias
type default min max safemode
int 1 0 2
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
float 0 -4 4
source pos
alias
type default min max safemode
string "0.0 0.0 0.41 0.1"
source pos
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
int 1408 0
source pos
alias
type default min max safemode
string ""
source pos
alias
type default min max safemode
string "*"
source pos
alias
type default min max safemode
bool false
source pos
alias
type default min max safemode
int 200
source pos
alias
type default min max safemode
int 1000
source pos
alias
type default min max safemode
float 0.7
source pos
alias
type default min max safemode
float 0.95
source pos
alias
type default min max safemode
bool true false
source pos
alias
type default min max safemode
bool false
On Windows, sets whether Spring will use low- or high-resolution timer functions for tasks like graphical interpolation between game frames.
alias
type default min max safemode
bool true
Whether Lua VM memory allocations are made from pools.
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool true false
source pos
alias
type default min max safemode
bool true
If already compiled shaders should be shared via a cache, reducing compiles of already compiled shaders.
alias
type default min max safemode
bool true false
source pos
alias
type default min max safemode
int 0 -6 6
Synchronize buffer swaps with vertical blanking interval. Modes are -N (adaptive), +N (standard), or 0 (disabled).
alias
type default min max safemode
int 1 0 4 0
Defines the type of water rendering. Can be set in game. Options are: 0 = Basic water, 1 = Reflective water, 2 = Reflective and Refractive water, 3 = Dynamic water, 4 = Bumpmapped water
alias
type default min max safemode
bool true
source pos
alias
type default min max safemode
bool false
When set and Fullscreen is 0, will put the game in Borderless Window mode, also known as Windowed Fullscreen. When using this, it is generally best to also set WindowPosX and WindowPosY to 0
alias
type default min max safemode
int 32
Sets the horizontal position of the game window, if Fullscreen is 0. When WindowBorderless is set, this should usually be 0.
alias
type default min max safemode
int 32
Sets the vertical position of the game window, if Fullscreen is 0. When WindowBorderless is set, this should usually be 0.
alias
type default min max safemode
bool true
Sets whether moving the mouse cursor to the screen edge will move the camera across the map.
alias
type default min max safemode
int -1 -1 0
Number of workers (including the main thread!) used by ThreadPool.
alias
type default min max safemode
int 0 0
Sets the width of the game screen. If set to 0 Spring will autodetect the current resolution of your desktop.
alias
type default min max safemode
int 0 0
See XResolution, just for windowed.
alias
type default min max safemode
int 0 0
Sets the height of the game screen. If set to 0 Spring will autodetect the current resolution of your desktop.
alias
type default min max safemode
int 0 0
See YResolution, just for windowed.
alias
type default min max safemode
string ""
Last Ip/hostname used as direct connect in the menu.
alias
type default min max safemode
string "UnnamedPlayer"
Sets your name in the game. Since this is overridden by lobbies with your lobby username when playing, it usually only comes up when viewing replays or starting the engine directly for testing purposes.
alias
type default min max safemode
float 0.1
source pos
alias
type default min max safemode
string ""
Sets the used output device. See "Available Devices" section in infolog.txt.
alias
type default min max safemode
int 100 0 200
Volume for "battle" sound channel.
alias
type default min max safemode
int 100 0 200
Volume for "general" sound channel.
alias
type default min max safemode
int 60 0 200
Master sound volume.
alias
type default min max safemode
int 100 0 200
Volume for "music" sound channel.
alias
type default min max safemode
int 100 0 200
Volume for "ui" sound channel.
alias
type default min max safemode
int 100 0 200
Volume for "unit reply" sound channel.