Difference between revisions of "MG/INI"

From MegaGlest
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
There are two categories of game settings, a) 'visible' settings which can also be changed by options in the game itself and b) 'invisible' settings which are typically intended to be changed by more knowledgeable users who understand the consequences of changing them and can only be changed by editing the ''glestuser.ini'' configuration file in the main MegaGlest directory.
+
[[MegaGlest]] settings can be changed by modifying its INI. While there is a <tt>glest.ini</tt> file in the installation folder, this should not be edited. Instead, edit the <tt>glestuser.ini</tt> file in the user data folder.
  
==Visible settings==
+
==Location of the INI==
{| class="wikitable"
+
Since the user data folder is very variable, the INI can be located in a variety of locations. The <tt>glestuser.ini</tt> (and <tt>glest.ini</tt>) file tells where it is in the <tt>UserData_Root</tt> value, and it can be changed by adding/modifying that string to/in <tt>glestuser.ini</tt>. By default, locations include:
!Property Name
+
 
!Default Value
+
{| class="wikitable" style="empty-cells: show;"
!Description
+
!Operating System
|-
+
!Location
|AutoMaxFullScreen
 
|false
 
|When set to true this tells the game to set the video mode to the maximum fullscreen resolution (spanning all monitors)
 
|-
 
|ColorBits
 
|16
 
|
 
|-
 
|DepthBits
 
|16
 
|
 
|-
 
|DisableBattleEndColorCoding
 
|false
 
|True tells the game to not use special colour coding in the game end statistics
 
|-
 
|DisableScreenshotConsoleText
 
|false
 
|True tells the game to not display an in game message showing where a screenshot was saved
 
|-
 
|DisableVBO
 
|false
 
|True tells the game to NOT use Vertex Buffer Objects
 
|-
 
|EnableTextureCompression
 
|false
 
|True tells the game to attempt using GPU texture compression for less memory use and better performance
 
|-
 
|EnableVSynch
 
|false
 
|True tells the game to enable Verticle Synchronization
 
|-
 
|FactionPreview
 
|true
 
|True tells the game to display preview screens of the selected factions in the game lobbies
 
|-
 
|FactorySound
 
|OpenAL
 
|The sound API to use, for Windows this includes: DirectSound8, OpenAL or None, for all other platforms: OpenAL or None
 
|-
 
|Filter
 
|Bilinear
 
|
 
|-
 
|FilterMaxAnisotropy
 
|1
 
|
 
|-
 
|FontSizeAdjustment
 
|0
 
|This makes font sizes larger (+) or smaller (-)
 
|-
 
|Lang
 
|english
 
|The default language to display game text
 
|-
 
|MapPreview
 
|true
 
|True tells the game to display a preview of the selected map in the game lobby
 
|-
 
|MaxLights
 
|3
 
|
 
|-
 
|NetPlayerName
 
|newbie
 
|Your Player name for network games
 
|-
 
|RefreshFrequency
 
|75
 
|
 
|-
 
|ScreenHeight
 
|768
 
|
 
|-
 
|ScreenWidth
 
|1024
 
|
 
|-
 
|ServerIp
 
|
 
|This is the last Server IP Address that you connected to
 
 
|-
 
|-
|Shadows
+
|Windows XP
|Projected
+
|C:\Documents and Settings\'''Your Name'''\Application Data\megaglest
|
 
 
|-
 
|-
|SoundVolumeAmbient
+
|Windows Vista/7
|80
+
|C:\Users\'''Your Name'''\appdata\roaming\megaglest
|
 
 
|-
 
|-
|SoundVolumeFx
+
|Linux
|80
+
|~/.megaglest <!-- THIS COULD BE TOTALLY WRONG, PLEASE VERIFY AND CHANGE IF NECESSARY -->
|
 
|-
 
|SoundVolumeMusic
 
|90
 
|
 
|-
 
|StencilBits
 
|0
 
|
 
|-
 
|Textures3D
 
|1
 
|
 
|-
 
|UnitParticles
 
|true
 
|When set to true this enables special graphical eye-candy particles for Units that support them
 
|-
 
|Windowed
 
|false
 
|When set to false the game runs fullscreen, otherwise it is a Window on your desktop
 
 
|}
 
|}
  
==Invisible settings==
+
==INI documentation==
{| class="wikitable"
+
{| class="wikitable sortable" style="empty-cells: show;"
!Property Name
+
!INI Value
!Default Value
+
!Default
!Description
+
! class="unsortable" |Description
 
|-
 
|-
 
|AiLog
 
|AiLog
 
|0
 
|0
|The log level when logging AI (CPU Player) activity
+
|The log level when logging AI activity.
 
|-
 
|-
 
|AiRedir
 
|AiRedir
 
|false
 
|false
|Redirect AI activity to the conole
+
|Redirect AI activity to the console.
 
|-
 
|-
 
|AllowDownloadDataSynch
 
|AllowDownloadDataSynch
 
|false
 
|false
|Do not use, untested download of network game content
+
|Do not use. Untested download of network game content.
 
|-
 
|-
 
|AllowAltEnterFullscreenToggle
 
|AllowAltEnterFullscreenToggle
 
|false
 
|false
|When true this allows players to press Alt-Enter to toggle between fullscreen and window mode
+
|When true this allows players to press Alt-Enter to toggle between fullscreen and window mode.
 
|-
 
|-
 
|AllowGameDataSynchCheck
 
|AllowGameDataSynchCheck
 
|false
 
|false
|When true this will check map, tileset and techtree between client and server (for network games) to determine in the lobby if the xml's match or not and display the synch status in the lobby
+
|When true this will check [[map]], [[tileset]], and [[techtree]] between client and server (for network games) to determine in the lobby if the [[XMLs]] match or not and display the synch status in the lobby.
 
|-
 
|-
 
|AnnouncementURL
 
|AnnouncementURL
Line 157: Line 51:
 
|false
 
|false
 
|
 
|
 +
|-
 +
|AutoMaxFullScreen
 +
|false
 +
|When set to true this tells the game to set the video mode to the maximum fullscreen resolution (spanning all monitors).
 
|-
 
|-
 
|CheckGlCaps
 
|CheckGlCaps
 
|true
 
|true
|
+
|Check for a compatible OpenGL version.
 
|-
 
|-
 
|ConsoleMaxLines
 
|ConsoleMaxLines
 
|7
 
|7
|The maximum # text lines to display in the game text console
+
|The maximum number of text lines to display in the in-game console.
 
|-
 
|-
 
|ConsoleMaxLinesStored
 
|ConsoleMaxLinesStored
 
|20
 
|20
|The maximum # text lines to store for recall in the text console
+
|The maximum number of text lines to store for recall in the console.
 
|-
 
|-
 
|ConsoleTimeout
 
|ConsoleTimeout
 
|20
 
|20
|# seconds before text disappears from the Text Console
+
|Number of seconds before text disappears from the console.
 
|-
 
|-
 
|DayTime
 
|DayTime
 
|1000
 
|1000
|
+
|Length of the day/night cycle in seconds.
 
|-
 
|-
 
|DebugLogFile
 
|DebugLogFile
|debug.log
+
|
|This is where normal game debug data will be logged
+
|The name for a file that will be created containing a debug log.
 
|-
 
|-
 
|DebugLogFileNetwork
 
|DebugLogFileNetwork
 
|
 
|
|This is where network game debug data will be logged
+
|The name for a file that will be created containing a network debug log.
 
|-
 
|-
 
|DebugLogFilePerformance
 
|DebugLogFilePerformance
 
|
 
|
|This is where performance game debug data will be logged
+
|The name for a file that will be created containing a performance debug log.
 
|-
 
|-
 
|DebugLogFileWorldSynch
 
|DebugLogFileWorldSynch
 
|
 
|
|This is where network world synch game debug data will be logged
+
|The name for a file that will be created containing a world debug log.
 
|-
 
|-
 
|DebugMode
 
|DebugMode
 
|false
 
|false
|When true this enables normal debug logging
+
|When true this enables normal debug logging.
 
|-
 
|-
 
|DebugNetwork
 
|DebugNetwork
 
|false
 
|false
|When true this enables network debug logging
+
|When true this enables network debug logging.
 
|-
 
|-
 
|DebugPerformance
 
|DebugPerformance
 
|false
 
|false
|When true this enables performance debug logging
+
|When true this enables performance debug logging.
 
|-
 
|-
 
|DebugWorldSynch
 
|DebugWorldSynch
 
|false
 
|false
|When true this enables network world synch debug logging
+
|When true this enables network world synch debug logging.
 
|-
 
|-
 
|DEFAULT_HTTP_TIMEOUT
 
|DEFAULT_HTTP_TIMEOUT
 
|10
 
|10
|This is the # seconds before HTTP requests will timeout
+
|This is the number of seconds before HTTP requests will timeout.
 +
|-
 +
|ColorBits
 +
|16
 +
|Number of bits used for the color buffer (also known as the pixel buffer). This determines the number of colors available.
 +
|-
 +
|DepthBits
 +
|16
 +
|Number of bits used for the depth buffer (also known as the Z-buffer). This determines the distances from the camera objects are and influences shadows.
 +
|-
 +
|DisableBattleEndColorCoding
 +
|false
 +
|True tells the game to not use special color coding in the game end statistics.
 +
|-
 +
|DisableScreenshotConsoleText
 +
|false
 +
|True tells the game to not display an in-game console message showing where a screenshot was saved.
 +
|-
 +
|DisableVBO
 +
|false
 +
|True tells the game to '''not''' use Vertex Buffer Objects.
 
|-
 
|-
 
|DisableUPNP
 
|DisableUPNP
 
|false
 
|false
|Disables attempts to open game ports during game play using universal plug and play for your router
+
|Disables attempts to open game ports during game play using universal plug and play for your router.
 +
|-
 +
|DisableWaterSounds
 +
|false
 +
|True tells the game to '''not''' play water sounds when units walk in water.
 
|-
 
|-
 
|EnableFTPServer
 
|EnableFTPServer
 
|true
 
|true
|True tells the game that the server can send files (via ftp) to players as requested
+
|True tells the game that the server can send files (via ftp) to players as requested.
 +
|-
 +
|EnableFTPServerInternetTilesetXfer
 +
|true
 +
|True tells the game that the server can send tilesets (via ftp) to internet players (published games) as requested.
 +
|-
 +
|EnableFTPServerInternetTechtreeXfer
 +
|true
 +
|True tells the game that the server can send tilesets (via ftp) to internet players (published games) as requested.
 +
|-
 +
|EnableFTPXfer
 +
|true
 +
|True tells the game to allow sending files over networked games between peers.
 +
|-
 +
|EnableGameServerLoadCancel
 +
|false
 +
|True tells the game to display a cancel button for the hosting user during network game startup.
 +
|-
 +
|EnableScenarioTexturePreview
 +
|true
 +
|True tells the game to display preview images for selected scenarios (if they exist).
 +
|-
 +
|EnableTextureCompression
 +
|false
 +
|True tells the game to attempt using GPU texture compression for less memory use and better performance.
 +
|-
 +
|EnableVSynch
 +
|false
 +
|True tells the game to enable vertical synchronization. This can help prevent vertical tearing, but can cause frame rate to suffer if the frame rate is not always above the screen's refresh rate.
 +
|-
 +
|FactionPreview
 +
|true
 +
|True tells the game to display preview screens of the selected factions in the game lobbies.
 
|-
 
|-
 
|FactoryGraphics
 
|FactoryGraphics
 
|OpenGL
 
|OpenGL
|
+
|The graphics renderer used to render all graphics. Only OpenGL is still supported.
 
|-
 
|-
|EnableFTPXfer
+
|FactorySound
|true
+
|OpenAL
|True tells the game to allow sending files over networked games between peers
+
|The sound API to use, either OpenAL, DirectSound8 (Windows only), or None.
 
|-
 
|-
 
|FastSpeedLoops
 
|FastSpeedLoops
 
|2
 
|2
|
+
|Speed of the game's highest speed setting.
 +
|-
 +
|FileArchiveExtension
 +
|.7z
 +
|This is the file extension of the default archive format used (currently 7z is used in the release installation).
 +
|-
 +
|FileArchiveExtractCommand
 +
|7z
 +
|This is the file extract binary command for the default archive format used (currently 7z is used).
 +
|-
 +
|FileArchiveExtractCommandParameters
 +
|x -o{outputpath} {archivename}
 +
|This is the commandline parameters to append to the above command.
 +
|-
 +
|FileArchiveExtractCommandSuccessResult
 +
|0
 +
|This is the expected return value from the extract command indicating success.
 +
|-
 +
|Filter
 +
|Bilinear
 +
|Selects from Bilinear and Trilinear filter. This is the smoothing of a texture when you zoom in or out of its regular size. Trilinear will increase the quality when zoomed more than half or twice the size, as well as perform linear interpolation between mipmaps.
 +
|-
 +
|FilterMaxAnisotropy
 +
|1
 +
|Sets degree of anisotropic filtering, which increases quality from filtered graphics greatly, but is heavy on system resources.
 
|-
 
|-
 
|FirstTime
 
|FirstTime
 
|false
 
|false
|
+
|If true, runs auto-config at startup. Don't edit this, this is automatic, and WILL overwrite all other settings.
 
|-
 
|-
 
|FocusArrows
 
|FocusArrows
 
|true
 
|true
|
+
|Toggles the display of arrows on units showing their target.
 
|-
 
|-
 
|FogOfWarSmoothing
 
|FogOfWarSmoothing
 
|true
 
|true
|
+
|Toggles on or off smoothing of the appearance or disappearance of fog of war.
 
|-
 
|-
 
|FogOfWarSmoothingFrameSkip
 
|FogOfWarSmoothingFrameSkip
 
|3
 
|3
|
+
|Frame skip for fog of war smoothing. Higher makes fog of war disappear and reappear smoother, but uses more system resources.
 
|-
 
|-
 
|FONT_CHARCOUNT
 
|FONT_CHARCOUNT
 
|256
 
|256
|This is the # characters expected for the selected font type
+
|This is the number of characters expected for the selected font type.
|-
 
|FONT_TYPENAME
 
|Times New Roman
 
|This is the Font Type to use
 
 
|-
 
|-
 
|FontConsoleBaseSize
 
|FontConsoleBaseSize
 
|18
 
|18
|
+
|Size of the font in the console.
 
|-
 
|-
 
|FontConsolePostfix
 
|FontConsolePostfix
Line 272: Line 246:
 
|FontDisplayBaseSize
 
|FontDisplayBaseSize
 
|12
 
|12
|
+
|Size of the font in normal usage in the game.
 
|-
 
|-
 
|FontDisplayPostfix
 
|FontDisplayPostfix
Line 284: Line 258:
 
|FontDisplaySmallBaseSize
 
|FontDisplaySmallBaseSize
 
|12
 
|12
|
+
|"Small" font size.
 
|-
 
|-
 
|FontMenuBigBaseSize
 
|FontMenuBigBaseSize
 
|20
 
|20
|
+
|"Big" font size in menus.
 
|-
 
|-
 
|FontMenuBigPostfix
 
|FontMenuBigPostfix
Line 300: Line 274:
 
|FontMenuNormalBaseSize
 
|FontMenuNormalBaseSize
 
|14
 
|14
|
+
|"Normal" font size in menus.
 
|-
 
|-
 
|FontMenuNormalPostfix
 
|FontMenuNormalPostfix
Line 312: Line 286:
 
|FontMenuVeryBigBaseSize
 
|FontMenuVeryBigBaseSize
 
|25
 
|25
|
+
|"Very big" font size in menus.
 +
|-
 +
|FontSizeAdjustment
 +
|0
 +
|This makes font sizes larger (+) or smaller (-).
 +
|-
 +
|FONT_TYPENAME
 +
|Times New Roman
 +
|The name of the font to use.
 +
|-
 +
|FTPServerPort
 +
|61358
 +
|The starting port number for ftp clients to connect (data ports for FTP start at this port number +1 to +8).
 
|-
 
|-
 
|FullScreenAntiAliasing
 
|FullScreenAntiAliasing
 
|false
 
|false
|When true this enables OpenGL full screen anti-aliasing
+
|When true this enables OpenGL fullscreen anti-aliasing.
 
|-
 
|-
 
|HardwareAcceleration
 
|HardwareAcceleration
 
|false
 
|false
|When true this enables OpenGL hardware acceleration
+
|When true this enables OpenGL hardware acceleration.
 +
|-
 +
|Lang
 +
|english
 +
|Language files that will be used for language strings. Will use the language file of the same name in the lang data folder with the *.lng extension.
 +
|-
 +
|MapPreview
 +
|true
 +
|True tells the game to display a preview of the selected map in the game lobby.
 +
|-
 +
|MasterServerExternalPortList
 +
|61357, 61358, 61359, 61360, 61000, 80, 1080, 8000, 8080, 443, 21, 22, 25, 110, 143, 587, 993, 995
 +
|This is a comma seperated list of allowed External Network ports supported.
 +
|-
 +
|MaxClientLagTimeAllowed
 +
|20
 +
|This is the maximum number seconds that a client is allowed to fall behind before action is taken.
 
|-
 
|-
 
|Masterserver
 
|Masterserver
 
|http://master.megaglest.org/
 
|http://master.megaglest.org/
|This is the master server location
+
|This is the master server location.
|-
 
|MasterServerExternalPortList
 
|
 
61357,61358,61359,61360,61000,
 
 
 
80,1080,8000,8080,443,21,22,25,
 
 
 
110,143,587,993,995
 
|This is a comma seperated list of allowed External Network ports supported
 
 
|-
 
|-
 
|MaxExploredCellsLookupItemCache
 
|MaxExploredCellsLookupItemCache
 
|5000
 
|5000
|This is the maximum cache size for cell explorered / visible lookup (0 disables)
+
|This is the maximum cache size for cell explored/visible lookup (0 disables).
 
|-
 
|-
 
|MaxFrameCountLagAllowed
 
|MaxFrameCountLagAllowed
 
|30
 
|30
|This is the maximum # of network frames that a client is allowed to fall behind before action is taken
+
|This is the maximum number of network frames that a client is allowed to fall behind before action is taken.
 +
|-
 +
|MaxFrameCountLagAllowedEver
 +
|35
 +
|This is the maximum number of network frames that a client is allowed to fall behind before they are disconnected.
 
|-
 
|-
|MaxClientLagTimeAllowed
+
|MaxLights
|20
+
|3
|This is the maximum # seconds that a client is allowed to fall behind before action is taken
+
|The maximum number of light sources there can be at one time.
 
|-
 
|-
 
|MaxUnitSelectCount
 
|MaxUnitSelectCount
 
|16
 
|16
|This is the maximum # of units that can be selected at one time
+
|This is the maximum number of units that can be selected at one time.
 +
|-
 +
|NetPlayerName
 +
|newbie
 +
|The player nickname for network games.
 
|-
 
|-
 
|NetworkConsistencyChecks
 
|NetworkConsistencyChecks
 
|true
 
|true
|When true this enforces client and server to have the same data for network games
+
|When true this enforces client and server to have the same data for network games.
 
|-
 
|-
 
|NetworkFramePeriod
 
|NetworkFramePeriod
 
|20
 
|20
|This is the # of frames that commands are sent out for network games
+
|This is the number of frames that commands are sent out for network games.
 
|-
 
|-
 
|No2DMouseRendering
 
|No2DMouseRendering
 
|false
 
|false
|When true this forces the use of ONLY the operating system mosue (no mouse rendering is done in game)
+
|When true this forces the use of only the operating system mouse (no mouse rendering is done in game).
 
|-
 
|-
 
|PhotoMode
 
|PhotoMode
 
|false
 
|false
|When true this disables things like the minimap and chat console text so that nice screenshots can be taken
+
|When true this disables GUI for enhanced screenshots.
 
|-
 
|-
 
|PlatformConsistencyChecks
 
|PlatformConsistencyChecks
 
|true
 
|true
|When true it enforces the same version to be used for all platforms for network play
+
|When true it enforces the same version to be used for all platforms for network play.
 
|-
 
|-
 
|PreCacheCRCThread
 
|PreCacheCRCThread
 
|true
 
|true
|When true it enables background threads which attempt to update game data CRC values
+
|When true it enables background threads which attempt to update game data CRC values.
 
|-
 
|-
 
|PrivacyPlease
 
|PrivacyPlease
 
|false
 
|false
|When true it tells the game NOT to send country information to other players
+
|When true it tells the game not to send country information to other players (such as the flag denoting where the server lives).
 +
|-
 +
|RefreshFrequency
 +
|75
 +
|Times to fresh the display per second (hertz).
 +
|-
 +
|ScreenHeight
 +
|600
 +
|Height of the window, in pixels.
 +
|-
 +
|ScreenWidth
 +
|800
 +
|Width of the window, in pixels.
 
|-
 
|-
 
|ServerControlledAI
 
|ServerControlledAI
 
|true
 
|true
|When true it tells the game that the player's computer hosting the game will control AI players
+
|When true it tells the game that the player's computer hosting the game will control AI players.
 +
|-
 +
|ServerIp
 +
|
 +
|The last server IP address that you connected to.
 
|-
 
|-
 
|ServerPort
 
|ServerPort
 
|61357
 
|61357
|The port to use when hosting games
+
|The port to use when hosting games.
 
|-
 
|-
 
|ShadowAlpha
 
|ShadowAlpha
 
|0.2
 
|0.2
|
+
|Transparency of shadow map shadows. This is a percentage in decimal form where 0 is fully transparent and 1 is fully opaque. Ignored if shadows are disabled.
 
|-
 
|-
 
|ShadowFrameSkip
 
|ShadowFrameSkip
 
|2
 
|2
|
+
|Frameskip for shadows. Lower will get smoother shadow movement, but use more system resources. Ignored if shadows are disabled.
 +
|-
 +
|Shadows
 +
|Projected
 +
|The method of projecting the shadows to use, if any. Either <tt>None</tt> (no shadows), <tt>Projected</tt> (fast, but can't project onto other objects), or <tt>Shadow Mapping</tt> (slow and blocky, but can project onto other objects).
 
|-
 
|-
 
|ShadowTextureSize
 
|ShadowTextureSize
 
|512
 
|512
|
+
|Size of shadow maps, must be a power of 2 but always under the screen size, higher values result in more accurate shadows and slower performance. Ignored if shadows are disabled. If larger than the game's resolution, shadows become buggy and stretched.
 
|-
 
|-
 
|SoundStaticBuffers
 
|SoundStaticBuffers
 
|16
 
|16
|
+
|Number of buffers for static sounds.
 
|-
 
|-
 
|SoundStreamingBuffers
 
|SoundStreamingBuffers
 
|4
 
|4
|
+
|Number of steaming buffers.
 +
|-
 +
|SoundVolumeAmbient
 +
|80
 +
|Volume of ambience sounds such as the chirp of birds from 0-100.
 +
|-
 +
|SoundVolumeFx
 +
|80
 +
|The volume of sound effects such as the clash of swords from 0-100.
 +
|-
 +
|SoundVolumeMusic
 +
|90
 +
|The volume of the background music from 0-100.
 +
|-
 +
|StencilBits
 +
|0
 +
|The number of stencil buffer bits, which can enhance shadow rendering when combined with Shadow Mapping, though are ignored on Projected shadows. Should be 8 or 16 if using, but can be heavy on system resources.
 +
|-
 +
|Textures3D
 +
|true
 +
|Allows the usage of 3D textures, required for water textures.
 
|-
 
|-
 
|ThreadedSoundStream
 
|ThreadedSoundStream
 
|false
 
|false
|When true this enables sound handling in a seperate thread (offloading some of the work from main game processing)
+
|When true this enables sound handling in a separate thread (offloading some of the work from main game processing).
 +
|-
 +
|TilesetParticles
 +
|true
 +
|True enables display of particles in [[tilesets]] where the tileset uses this feature.
 +
|-
 +
|UnitParticles
 +
|true
 +
|When set to true this enables particle systems for units that support them.
 
|-
 
|-
 
|UserData_Root
 
|UserData_Root
|mydata/
+
|'''[[#Location of the INI|See above]]'''
|This is the folder where user created maps, tilesets, techtrees, scenarios and tutorials are to be stored. This is the folder where user created content should go meaning game data that does not come with the Mega-Glest install packages. It is very important to keep user data seperate so that users making changes to their user data do not affect their ability to play network games with other players. Each time a network game is played a CRC check is done to ensure all players have the same data so that the game is fair and does not go "out of synch" with each other. User data should use UNIQUE naming and not use duplicate names that are already used in the main Maga-Glest folders. For example the main Mega-Glest folders contain a faction in the megapack techtree called tech. This same techtree and faction combination should NOT be reproduced in the mydata folder.
+
|This is the folder where user created [[maps]], [[tilesets]], [[techtrees]], [[scenarios]], [[tutorials]], and user INIs are to be stored.
|-
 
|UserOverrideFile
 
|
 
|This optional parameter specifies the path and location of the glestuser.ini and glestuserkeys.ini files (if different than the default)
 
 
|-
 
|-
 
|VersionURL
 
|VersionURL
 
|http://master.megaglest.org/files/versions/
 
|http://master.megaglest.org/files/versions/
|Information regarding the currently run game version is loaded from the given location and displayed next to the server list
+
|Information regarding the currently run game version is loaded from the given location and displayed next to the server list.
 
|-
 
|-
 
|WarnFrameCountLagPercent
 
|WarnFrameCountLagPercent
 
|0.65
 
|0.65
|This is the % of the maximum threshold of the above reached when a client is warned they are falling too far behind
+
|This is the percentage of the maximum threshold of the above reached when a client is warned they are falling too far behind.
 +
|-
 +
|Windowed
 +
|false
 +
|If true, the game is windowed, if false, it is run fullscreen.
 
|}
 
|}
  

Revision as of 22:17, 27 April 2011

MegaGlest settings can be changed by modifying its INI. While there is a glest.ini file in the installation folder, this should not be edited. Instead, edit the glestuser.ini file in the user data folder.

Location of the INI

Since the user data folder is very variable, the INI can be located in a variety of locations. The glestuser.ini (and glest.ini) file tells where it is in the UserData_Root value, and it can be changed by adding/modifying that string to/in glestuser.ini. By default, locations include:

Operating System Location
Windows XP C:\Documents and Settings\Your Name\Application Data\megaglest
Windows Vista/7 C:\Users\Your Name\appdata\roaming\megaglest
Linux ~/.megaglest

INI documentation

INI Value Default Description
AiLog 0 The log level when logging AI activity.
AiRedir false Redirect AI activity to the console.
AllowDownloadDataSynch false Do not use. Untested download of network game content.
AllowAltEnterFullscreenToggle false When true this allows players to press Alt-Enter to toggle between fullscreen and window mode.
AllowGameDataSynchCheck false When true this will check map, tileset, and techtree between client and server (for network games) to determine in the lobby if the XMLs match or not and display the synch status in the lobby.
AnnouncementURL http://master.megaglest.org/files/announcement.txt Game related announcements are loaded from the given location and displayed next to the server list.
AutoTest false
AutoMaxFullScreen false When set to true this tells the game to set the video mode to the maximum fullscreen resolution (spanning all monitors).
CheckGlCaps true Check for a compatible OpenGL version.
ConsoleMaxLines 7 The maximum number of text lines to display in the in-game console.
ConsoleMaxLinesStored 20 The maximum number of text lines to store for recall in the console.
ConsoleTimeout 20 Number of seconds before text disappears from the console.
DayTime 1000 Length of the day/night cycle in seconds.
DebugLogFile The name for a file that will be created containing a debug log.
DebugLogFileNetwork The name for a file that will be created containing a network debug log.
DebugLogFilePerformance The name for a file that will be created containing a performance debug log.
DebugLogFileWorldSynch The name for a file that will be created containing a world debug log.
DebugMode false When true this enables normal debug logging.
DebugNetwork false When true this enables network debug logging.
DebugPerformance false When true this enables performance debug logging.
DebugWorldSynch false When true this enables network world synch debug logging.
DEFAULT_HTTP_TIMEOUT 10 This is the number of seconds before HTTP requests will timeout.
ColorBits 16 Number of bits used for the color buffer (also known as the pixel buffer). This determines the number of colors available.
DepthBits 16 Number of bits used for the depth buffer (also known as the Z-buffer). This determines the distances from the camera objects are and influences shadows.
DisableBattleEndColorCoding false True tells the game to not use special color coding in the game end statistics.
DisableScreenshotConsoleText false True tells the game to not display an in-game console message showing where a screenshot was saved.
DisableVBO false True tells the game to not use Vertex Buffer Objects.
DisableUPNP false Disables attempts to open game ports during game play using universal plug and play for your router.
DisableWaterSounds false True tells the game to not play water sounds when units walk in water.
EnableFTPServer true True tells the game that the server can send files (via ftp) to players as requested.
EnableFTPServerInternetTilesetXfer true True tells the game that the server can send tilesets (via ftp) to internet players (published games) as requested.
EnableFTPServerInternetTechtreeXfer true True tells the game that the server can send tilesets (via ftp) to internet players (published games) as requested.
EnableFTPXfer true True tells the game to allow sending files over networked games between peers.
EnableGameServerLoadCancel false True tells the game to display a cancel button for the hosting user during network game startup.
EnableScenarioTexturePreview true True tells the game to display preview images for selected scenarios (if they exist).
EnableTextureCompression false True tells the game to attempt using GPU texture compression for less memory use and better performance.
EnableVSynch false True tells the game to enable vertical synchronization. This can help prevent vertical tearing, but can cause frame rate to suffer if the frame rate is not always above the screen's refresh rate.
FactionPreview true True tells the game to display preview screens of the selected factions in the game lobbies.
FactoryGraphics OpenGL The graphics renderer used to render all graphics. Only OpenGL is still supported.
FactorySound OpenAL The sound API to use, either OpenAL, DirectSound8 (Windows only), or None.
FastSpeedLoops 2 Speed of the game's highest speed setting.
FileArchiveExtension .7z This is the file extension of the default archive format used (currently 7z is used in the release installation).
FileArchiveExtractCommand 7z This is the file extract binary command for the default archive format used (currently 7z is used).
FileArchiveExtractCommandParameters x -o{outputpath} {archivename} This is the commandline parameters to append to the above command.
FileArchiveExtractCommandSuccessResult 0 This is the expected return value from the extract command indicating success.
Filter Bilinear Selects from Bilinear and Trilinear filter. This is the smoothing of a texture when you zoom in or out of its regular size. Trilinear will increase the quality when zoomed more than half or twice the size, as well as perform linear interpolation between mipmaps.
FilterMaxAnisotropy 1 Sets degree of anisotropic filtering, which increases quality from filtered graphics greatly, but is heavy on system resources.
FirstTime false If true, runs auto-config at startup. Don't edit this, this is automatic, and WILL overwrite all other settings.
FocusArrows true Toggles the display of arrows on units showing their target.
FogOfWarSmoothing true Toggles on or off smoothing of the appearance or disappearance of fog of war.
FogOfWarSmoothingFrameSkip 3 Frame skip for fog of war smoothing. Higher makes fog of war disappear and reappear smoother, but uses more system resources.
FONT_CHARCOUNT 256 This is the number of characters expected for the selected font type.
FontConsoleBaseSize 18 Size of the font in the console.
FontConsolePostfix -*-*-*-*-*-*-*
FontConsolePrefix -*-helvetica-*-r-*-*-
FontDisplayBaseSize 12 Size of the font in normal usage in the game.
FontDisplayPostfix -*-*-*-*-*-*-*
FontDisplayPrefix -*-helvetica-*-r-*-*-
FontDisplaySmallBaseSize 12 "Small" font size.
FontMenuBigBaseSize 20 "Big" font size in menus.
FontMenuBigPostfix -*-*-*-*-*-*-*
FontMenuBigPrefix -*-helvetica-*-r-*-*-
FontMenuNormalBaseSize 14 "Normal" font size in menus.
FontMenuNormalPostfix -*-*-*-*-*-*-*
FontMenuNormalPrefix -*-helvetica-*-r-*-*-
FontMenuVeryBigBaseSize 25 "Very big" font size in menus.
FontSizeAdjustment 0 This makes font sizes larger (+) or smaller (-).
FONT_TYPENAME Times New Roman The name of the font to use.
FTPServerPort 61358 The starting port number for ftp clients to connect (data ports for FTP start at this port number +1 to +8).
FullScreenAntiAliasing false When true this enables OpenGL fullscreen anti-aliasing.
HardwareAcceleration false When true this enables OpenGL hardware acceleration.
Lang english Language files that will be used for language strings. Will use the language file of the same name in the lang data folder with the *.lng extension.
MapPreview true True tells the game to display a preview of the selected map in the game lobby.
MasterServerExternalPortList 61357, 61358, 61359, 61360, 61000, 80, 1080, 8000, 8080, 443, 21, 22, 25, 110, 143, 587, 993, 995 This is a comma seperated list of allowed External Network ports supported.
MaxClientLagTimeAllowed 20 This is the maximum number seconds that a client is allowed to fall behind before action is taken.
Masterserver http://master.megaglest.org/ This is the master server location.
MaxExploredCellsLookupItemCache 5000 This is the maximum cache size for cell explored/visible lookup (0 disables).
MaxFrameCountLagAllowed 30 This is the maximum number of network frames that a client is allowed to fall behind before action is taken.
MaxFrameCountLagAllowedEver 35 This is the maximum number of network frames that a client is allowed to fall behind before they are disconnected.
MaxLights 3 The maximum number of light sources there can be at one time.
MaxUnitSelectCount 16 This is the maximum number of units that can be selected at one time.
NetPlayerName newbie The player nickname for network games.
NetworkConsistencyChecks true When true this enforces client and server to have the same data for network games.
NetworkFramePeriod 20 This is the number of frames that commands are sent out for network games.
No2DMouseRendering false When true this forces the use of only the operating system mouse (no mouse rendering is done in game).
PhotoMode false When true this disables GUI for enhanced screenshots.
PlatformConsistencyChecks true When true it enforces the same version to be used for all platforms for network play.
PreCacheCRCThread true When true it enables background threads which attempt to update game data CRC values.
PrivacyPlease false When true it tells the game not to send country information to other players (such as the flag denoting where the server lives).
RefreshFrequency 75 Times to fresh the display per second (hertz).
ScreenHeight 600 Height of the window, in pixels.
ScreenWidth 800 Width of the window, in pixels.
ServerControlledAI true When true it tells the game that the player's computer hosting the game will control AI players.
ServerIp The last server IP address that you connected to.
ServerPort 61357 The port to use when hosting games.
ShadowAlpha 0.2 Transparency of shadow map shadows. This is a percentage in decimal form where 0 is fully transparent and 1 is fully opaque. Ignored if shadows are disabled.
ShadowFrameSkip 2 Frameskip for shadows. Lower will get smoother shadow movement, but use more system resources. Ignored if shadows are disabled.
Shadows Projected The method of projecting the shadows to use, if any. Either None (no shadows), Projected (fast, but can't project onto other objects), or Shadow Mapping (slow and blocky, but can project onto other objects).
ShadowTextureSize 512 Size of shadow maps, must be a power of 2 but always under the screen size, higher values result in more accurate shadows and slower performance. Ignored if shadows are disabled. If larger than the game's resolution, shadows become buggy and stretched.
SoundStaticBuffers 16 Number of buffers for static sounds.
SoundStreamingBuffers 4 Number of steaming buffers.
SoundVolumeAmbient 80 Volume of ambience sounds such as the chirp of birds from 0-100.
SoundVolumeFx 80 The volume of sound effects such as the clash of swords from 0-100.
SoundVolumeMusic 90 The volume of the background music from 0-100.
StencilBits 0 The number of stencil buffer bits, which can enhance shadow rendering when combined with Shadow Mapping, though are ignored on Projected shadows. Should be 8 or 16 if using, but can be heavy on system resources.
Textures3D true Allows the usage of 3D textures, required for water textures.
ThreadedSoundStream false When true this enables sound handling in a separate thread (offloading some of the work from main game processing).
TilesetParticles true True enables display of particles in tilesets where the tileset uses this feature.
UnitParticles true When set to true this enables particle systems for units that support them.
UserData_Root See above This is the folder where user created maps, tilesets, techtrees, scenarios, tutorials, and user INIs are to be stored.
VersionURL http://master.megaglest.org/files/versions/ Information regarding the currently run game version is loaded from the given location and displayed next to the server list.
WarnFrameCountLagPercent 0.65 This is the percentage of the maximum threshold of the above reached when a client is warned they are falling too far behind.
Windowed false If true, the game is windowed, if false, it is run fullscreen.

See Also