Package: il2fb-ds-config
Python library for working with settings of IL-2 FB Dedicated Server
(confs.ini).Table of contentsServer config parametersNETsectionConsolesectionDeviceLinksectiongamesectionchatsectionMaxLagsectionServer config parametersThis part of documentation describes server parameters. They are groupped by
sections like in server’sconfs.inifile.NETsectionThis section defined mostly server’s network parameters.serverNameName of server, which will be displayed in a list of servers in LAN.Type:stringDefault:(empty value)Example:serverName=Test serverserverDescriptionDescription of server, which will be displayed in a list of servers in LAN.Type:stringDefault:(empty value)Example:serverDescription=Server for testing new featuresserverChannelsMax number of users.Type:integerMin:1Max:128Default:8Example:serverChannels=64speedServer’s throughput in bytes/sec(need more details).Common valuesValueComment3000Modem 288005000Modem 5600025000DSL cableType:integerMin:300Max:1000000Default:5000Example:speed=25000localHostAddress of network interface to listen for all incoming connections on.Type:stringDefault:(empty value, listen on all interfaces)Example:localHost=192.168.0.10localPortUDP port number for client to connect to. Users enter this value when
connecting to server.Type:integerMin:1000Max:65000Default:21000Example:serverChannels=21000socksHostProxy host(need more details).Type:stringDefault:(empty value)Example:(no example)socksPortProxy port(need more details).Type:integerDefault:1080Example:(no example)socksUserProxy user name(need more details).Type:stringDefault:(empty value)Example:(no example)socksPwdPassword for proxy user(need more details).Type:stringDefault:(empty value)Example:(no example)checkRuntimeStrictness of game version checks(need more details).Allowed valuesValueComment0No checks1Checks enabled2Strict checks enabled (may not work underwineon Linux and Mac OS)Type:integerMin:0Max:2Default:0Example:checkRuntime=2checkTimeSpeedDifferenseMax allowed difference in time between server and client (protection from
SpeedHack-like cheats). This may especially happen when the connection
quality is low and connectivity errors occur. This may also happen if the
hardware malfunctions, such as overheating of the computer timer causing
frequency changes.Type:floatMin:0.01(1%)Default:0.2(20%)Example:checkTimeSpeedDifferense=0.2checkTimeSpeedIntervalMax allowed time period when time difference can exceedcheckTimeSpeedDifferensevalue. Client will be disconnected from the
server after this period.Type:integerMin:1Max:1000Default:17Example:checkTimeSpeedInterval=17checkServerTimeSpeedEnable protection from SpeedHack-like cheats at server side.Type:boolean(0 — false, 1 — true)Default:1Example:checkServerTimeSpeed=1checkClientTimeSpeedEnable protection from SpeedHack-like cheats at client side.Type:boolean(0 — false, 1 — true)Default:0Example:checkClientTimeSpeed=0difficultyDifficulty settings.Use difficulty editorto understand values.Type:integerDefault:193791Example:difficulty=8796093022207SkinDownloadAllow users to see skins, which are not present on server(need more details).Type:boolean(0 — false, 1 — true)Default:1Example:SkinDownload=1allowCustomSoundsAllow to use custom sounds inmy_presetsandmy_samplesdirectories(need more details).Type:boolean(0 — false, 1 — true)Default:1Example:allowCustomSounds=1reflyDisabledWhen enabled,Reflybutton will be disabled until next mission.Type:boolean(0 — false, 1 — true)Default:0Example:reflyDisabled=0reflyKIADelayInitial penalty (delay in seconds) for refly after death.Type:integerDefault:0Example:reflyKIADelay=60reflyKIADelayMultiplierNumber of seconds, which will be multiplied by number of users’s deaths and
added to initial penalty for refly after death. So, final penalty is
following:penalty = reflyKIADelay + reflyKIADelayMultiplier * NUMBER_OF_KIA_IN_MISSIONType:floatDefault:0.0Example:reflyKIADelayMultiplier=30.0maxAllowedKIALimit of deaths per mission.Type:integerDefault:-1(no limit)Example:maxAllowedKIA=20allowMorseAsTextWhen enabled, online clients are allowed to use Morse as text feature
online.Type:boolean(0 — false, 1 — true)Default:1Example:allowMorseAsText=1filterUserNamesWhen enabled, strips invalid characters from names. Valid characters are
those, which have codes within ranges[33;160]or[1025;1119]or[1168;1257](need more details).Type:boolean(0 — false, 1 — true)Default:0Example:filterUserNames=0disableNetStatStatisticsWhen enabled, all online statistics are disabled (not visible).
Statistics are shown withSkey by default.USER STATconsole command will not work either.Type:boolean(0 — false, 1 — true)Default:0Example:disableNetStatStatistics=0showPilotNumberWhen enabled, online stats shows pilot’s number.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotNumber=1showPilotPingWhen enabled, online stats shows pilot’s ping.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotPing=1showPilotNameWhen enabled, online stats shows pilot’s name.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotName=1showPilotArmyWhen enabled, online stats shows pilot’s army.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotArmy=1showPilotACDesignationWhen enabled, online stats shows pilot’s aircraft designation.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotACDesignation=1showPilotACTypeWhen enabled, online stats shows pilot’s aircraft type.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotACType=1showPilotScoreWhen enabled, online stats shows pilot’s score.Type:boolean(0 — false, 1 — true)Default:1Example:showPilotScore=1showTeamScoreWhen enabled, online stats shows team score. This is combined score of all
pilots in the team. It includes all scores even from pilots that have
already quit playing the mission.Type:boolean(0 — false, 1 — true)Default:0Example:showTeamScore=0cumulativeTeamScoreWhen enabled, the team score is not zeroed between missions.Type:boolean(0 — false, 1 — true)Default:0Example:cumulativeTeamScore=0ConsolesectionThis part describes options available for server’s remote console.IPTCP port number to listen for connnections on.Type:integerMin:0Max:65000Default:0(disable console)Example:IP=20000IPSList of hostnames, which are allowed to connect to server’s console.By default only connections fromNET.localHostare allowed.
IfNET.localHostis not specified, then system’slocalhostis used.Type:space-separatedstringsDefault:(empty value)Example:127.0.0.1 192.168.0.10LOGWhen enabled, console messages will be logged into a file.Type:boolean(0 — false, 1 — true)Default:0Example:LOG=0LOGFILEName of file to log console messages into.Type:stringDefault:log.lstExample:logs/console.logLOGTIMEWhen enabled, console log messages will be prefixed with time.Type:boolean(0 — false, 1 — true)Default:0Example:LOGTIME=0LOGKEEPWhen enabled, existing console log file will be preserved.Type:boolean(0 — false, 1 — true)Default:1Example:LOGKEEP=0HISTORYHow much console records to keep in log file.Type:integerMin:0Max:10000Default:128Example:HISTORY=1024HISTORYCMDHow much console commands to keep in console’s history.Type:integerMin:0Max:10000Default:128Example:HISTORYCMD=1024DeviceLinksectionThis part describes options available for server’s Device Link interface.hostHostnames to listen for incoming requests on.Type:stringDefault:(empty value)(listen on system’slocalhost)Example:192.168.0.10portUDP port number to listen for incoming requests on.Type:integerMin:0Max:65000Default:0(disable Device Link)Example:IP=10000IPSList of hostnames, which are allowed to connect to server’s Device Link.Type:space-separatedstringsDefault:(empty value)Example:127.0.0.1 192.168.0.10gamesectionThis part describes options for different game conditions.eventlogName of file to log events into. This file is created only when a mission
starts.Type:stringDefault:eventlog.lstExample:logs/events.logeventlogkeepWhen enabled, events from previous mission be preserved.Type:boolean(0 — false, 1 — true)Default:1Example:eventlogkeep=1eventlogHouseLog events about destroyed buildings and trees.Type:boolean(0 — false, 1 — true)Default:0Example:eventlogHouse=0NoMissionInfoHudWhen enabled, mission related messages likeMission completedare not
shown at the center of the screen.Type:boolean(0 — false, 1 — true)Default:0Example:NoMissionInfoHud=0noKillInfoHudWhen enabled, kill related messages likeEnemy/friendly xxx destroyedare not shown at the right side of the screen.Type:boolean(0 — false, 1 — true)Default:0Example:noKillInfoHud=0lowInfoHudDisplay HUD messages at the bottom of the screen, instead of center of the
screen.Type:boolean(0 — false, 1 — true)Default:0Example:lowInfoHud=0ShowMorseAsTextWhen enabled, all Morse code beeps are also shown as text on screen.Type:boolean(0 — false, 1 — true)Default:0Example:ShowMorseAsText=0BlockMorseChatThis switch is related to undocumented “easter egg” feature in 4.10 patch.
By typing a chat message online so that the message starts withMorse:will cause the message to be sent as Morse code beeps instead of text. This
switch can be used to disable this feature in case some players decide to
start chatting in Morse and you don’t want to hear the annoying beeping
noises.Type:boolean(0 — false, 1 — true)Default:0Example:BlockMorseChat=0SmallMapWPLabelsWhen enabled, the map shows waypoint labels with small font instead of
large.Type:boolean(0 — false, 1 — true)Default:1Example:SmallMapWPLabels=1SkipParatrooperViewsWhen enabled, external camera views skip bailed out paratroopers.Type:boolean(0 — false, 1 — true)Default:0Example:SkipParatrooperViews=0TypeCloudsUse new clouds render from versions 4.x.Type:boolean(0 — false, 1 — true)Default:1Example:TypeClouds=1chatsectionOptions for game chat.autoLogDetailAmount of events users will see chat message.Allowed valuesValueComment0Minimum of events (e.g., user joined, user left, user is cheating).1More events, including kills, craches, captures and so on.2More events, including destruction of ground units.3All events, including different kinds of damages.Type:integerMin:0Max:3Default:3Example:autoLogDetail=3MaxLagsectionThis section is aboutCheating has been detected!messages.It contains options which allow to limit the amount of lag acceptable by the
host before a player will be autokicked.Settings to leanient will have no effect, while settings too strict will cause
a lot of autokicking.nearMaxLagTimeDefines the max lag time allowed for an aircraft in an endangered position
before it is considered warping (cheating). This is meant to address players
who are lagging on purpose.Type:floatMin:0.1Max:30.0Default:2.0Example:nearMaxLagTime=2farMaxLagTimeDefines the maximum delay (in seconds) between packets received from a given
client. A time greater than this is considered a warp.Type:floatMin:value ofnearMaxLagTimeMax:30.0Default:10.0Example:farMaxLagTime=10cheaterWarningDelayDefines the maximum amount of time the system will refrain from taking
action against a player acting out of bounds. This can be used to avoid
issuing multiple warnings for a single glitch.Type:floatMin:1.0Max:30.0Default:10.0Example:cheaterWarningDelay=10cheaterWarningNumDefines the max number of warnings issued before a player is autokicked by
the host. A value of-1prevents autokicking.Type:integerDefault:3Example:cheaterWarningNum=3