{
    "info": {
        "author": "Alexander Oblovatniy",
        "author_email": "oblovatniy@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Software Development :: Libraries"
        ],
        "description": "IL-2 FB DS Config\n=================\n\n|pypi_package| |pypi_downloads| |python_versions| |license|\n\n|code_issues| |codeclimate| |codacy| |quality| |health| |requirements|\n\nPython library for working with settings of IL-2 FB Dedicated Server\n(``confs.ini``).\n\n\n**Table of contents**\n\n.. contents::\n    :local:\n    :depth: 2\n    :backlinks: none\n\n\nServer config parameters\n------------------------\n\nThis part of documentation describes server parameters. They are groupped by\nsections like in server's ``confs.ini`` file.\n\n\n``NET`` section\n~~~~~~~~~~~~~~~\n\nThis section defined mostly server's network parameters.\n\nserverName\n   Name of server, which will be displayed in a list of servers in LAN.\n\n   :Type: ``string``\n   :Default: ``(empty value)``\n   :Example: ``serverName=Test server``\n\nserverDescription\n   Description of server, which will be displayed in a list of servers in LAN.\n\n   :Type: ``string``\n   :Default: ``(empty value)``\n   :Example: ``serverDescription=Server for testing new features``\n\nserverChannels\n   Max number of users.\n\n   :Type: ``integer``\n   :Min: ``1``\n   :Max: ``128``\n   :Default: ``8``\n   :Example: ``serverChannels=64``\n\nspeed\n   Server's throughput in bytes/sec *(need more details)*.\n\n   .. table:: Common values\n\n      ====== ===========\n      Value  Comment\n      ====== ===========\n      3000   Modem 28800\n      5000   Modem 56000\n      25000  DSL cable\n      ====== ===========\n\n   :Type: ``integer``\n   :Min: ``300``\n   :Max: ``1000000``\n   :Default: ``5000``\n   :Example: ``speed=25000``\n\nlocalHost\n   Address of network interface to listen for all incoming connections on.\n\n   :Type: ``string``\n   :Default: ``(empty value, listen on all interfaces)``\n   :Example: ``localHost=192.168.0.10``\n\nlocalPort\n   UDP port number for client to connect to. Users enter this value when\n   connecting to server.\n\n   :Type: ``integer``\n   :Min: ``1000``\n   :Max: ``65000``\n   :Default: ``21000``\n   :Example: ``serverChannels=21000``\n\nsocksHost\n   Proxy host *(need more details)*.\n\n   :Type: ``string``\n   :Default: ``(empty value)``\n   :Example: ``(no example)``\n\nsocksPort\n   Proxy port *(need more details)*.\n\n   :Type: ``integer``\n   :Default: ``1080``\n   :Example: ``(no example)``\n\nsocksUser\n   Proxy user name *(need more details)*.\n\n   :Type: ``string``\n   :Default: ``(empty value)``\n   :Example: ``(no example)``\n\nsocksPwd\n   Password for proxy user *(need more details)*.\n\n   :Type: ``string``\n   :Default: ``(empty value)``\n   :Example: ``(no example)``\n\ncheckRuntime\n   Strictness of game version checks *(need more details)*.\n\n   .. table:: Allowed values\n\n      ====== =======================================================================\n      Value  Comment\n      ====== =======================================================================\n      0      No checks\n      1      Checks enabled\n      2      Strict checks enabled (may not work under ``wine`` on Linux and Mac OS)\n      ====== =======================================================================\n\n   :Type: ``integer``\n   :Min: ``0``\n   :Max: ``2``\n   :Default: ``0``\n   :Example: ``checkRuntime=2``\n\ncheckTimeSpeedDifferense\n   Max allowed difference in time between server and client (protection from\n   SpeedHack-like cheats). This may especially happen when the connection\n   quality is low and connectivity errors occur. This may also happen if the\n   hardware malfunctions, such as overheating of the computer timer causing\n   frequency changes.\n\n   :Type: ``float``\n   :Min: ``0.01`` (1%)\n   :Default: ``0.2`` (20%)\n   :Example: ``checkTimeSpeedDifferense=0.2``\n\ncheckTimeSpeedInterval\n   Max allowed time period when time difference can exceed\n   ``checkTimeSpeedDifferense`` value. Client will be disconnected from the\n   server after this period.\n\n   :Type: ``integer``\n   :Min: ``1``\n   :Max: ``1000``\n   :Default: ``17``\n   :Example: ``checkTimeSpeedInterval=17``\n\ncheckServerTimeSpeed\n   Enable protection from SpeedHack-like cheats at server side.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``checkServerTimeSpeed=1``\n\ncheckClientTimeSpeed\n   Enable protection from SpeedHack-like cheats at client side.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``checkClientTimeSpeed=0``\n\ndifficulty\n   Difficulty settings.\n   `Use difficulty editor <http://il2horusteam.github.io/il2fb-difficulty/>`_\n   to understand values.\n\n   :Type: ``integer``\n   :Default: ``193791``\n   :Example: ``difficulty=8796093022207``\n\nSkinDownload\n   Allow users to see skins, which are not present on server *(need more details)*.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``SkinDownload=1``\n\nallowCustomSounds\n   Allow to use custom sounds in ``my_presets`` and ``my_samples`` directories\n   *(need more details)*.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``allowCustomSounds=1``\n\nreflyDisabled\n   When enabled, ``Refly`` button will be disabled until next mission.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``reflyDisabled=0``\n\nreflyKIADelay\n   Initial penalty (delay in seconds) for refly after death.\n\n   :Type: ``integer``\n   :Default: ``0``\n   :Example: ``reflyKIADelay=60``\n\nreflyKIADelayMultiplier\n   Number of seconds, which will be multiplied by number of users's deaths and\n   added to initial penalty for refly after death. So, final penalty is\n   following:\n\n   ``penalty = reflyKIADelay + reflyKIADelayMultiplier * NUMBER_OF_KIA_IN_MISSION``\n\n   :Type: ``float``\n   :Default: ``0.0``\n   :Example: ``reflyKIADelayMultiplier=30.0``\n\nmaxAllowedKIA\n   Limit of deaths per mission.\n\n   :Type: ``integer``\n   :Default: ``-1`` (no limit)\n   :Example: ``maxAllowedKIA=20``\n\nallowMorseAsText\n   When enabled, online clients are allowed to use Morse as text feature\n   online.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``allowMorseAsText=1``\n\nfilterUserNames\n   When enabled, strips invalid characters from names. Valid characters are\n   those, which have codes within ranges ``[33;160]`` or ``[1025;1119]`` or\n   ``[1168;1257]`` *(need more details)*.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``filterUserNames=0``\n\ndisableNetStatStatistics\n   When enabled, all online statistics are disabled (not visible).\n   Statistics are shown with ``S`` key by default.\n   ``USER STAT`` console command will not work either.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``disableNetStatStatistics=0``\n\nshowPilotNumber\n   When enabled, online stats shows pilot's number.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotNumber=1``\n\nshowPilotPing\n   When enabled, online stats shows pilot's ping.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotPing=1``\n\nshowPilotName\n   When enabled, online stats shows pilot's name.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotName=1``\n\nshowPilotArmy\n   When enabled, online stats shows pilot's army.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotArmy=1``\n\nshowPilotACDesignation\n   When enabled, online stats shows pilot's aircraft designation.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotACDesignation=1``\n\nshowPilotACType\n   When enabled, online stats shows pilot's aircraft type.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotACType=1``\n\nshowPilotScore\n   When enabled, online stats shows pilot's score.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``showPilotScore=1``\n\nshowTeamScore\n   When enabled, online stats shows team score. This is combined score of all\n   pilots in the team. It includes all scores even from pilots that have\n   already quit playing the mission.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``showTeamScore=0``\n\ncumulativeTeamScore\n   When enabled, the team score is not zeroed between missions.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``cumulativeTeamScore=0``\n\n\n``Console`` section\n~~~~~~~~~~~~~~~~~~~\n\nThis part describes options available for server's remote console.\n\nIP\n   TCP port number to listen for connnections on.\n\n   :Type: ``integer``\n   :Min: ``0``\n   :Max: ``65000``\n   :Default: ``0`` (disable console)\n   :Example: ``IP=20000``\n\nIPS\n   List of hostnames, which are allowed to connect to server's console.\n\n   By default only connections from ``NET.localHost`` are allowed.\n   If ``NET.localHost`` is not specified, then system's ``localhost`` is used.\n\n   :Type: ``space-separated strings``\n   :Default: ``(empty value)``\n   :Example: ``127.0.0.1 192.168.0.10``\n\nLOG\n   When enabled, console messages will be logged into a file.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``LOG=0``\n\nLOGFILE\n   Name of file to log console messages into.\n\n   :Type: ``string``\n   :Default: ``log.lst``\n   :Example: ``logs/console.log``\n\nLOGTIME\n   When enabled, console log messages will be prefixed with time.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``LOGTIME=0``\n\nLOGKEEP\n   When enabled, existing console log file will be preserved.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``LOGKEEP=0``\n\nHISTORY\n   How much console records to keep in log file.\n\n   :Type: ``integer``\n   :Min: ``0``\n   :Max: ``10000``\n   :Default: ``128``\n   :Example: ``HISTORY=1024``\n\nHISTORYCMD\n   How much console commands to keep in console's history.\n\n   :Type: ``integer``\n   :Min: ``0``\n   :Max: ``10000``\n   :Default: ``128``\n   :Example: ``HISTORYCMD=1024``\n\n\n``DeviceLink`` section\n~~~~~~~~~~~~~~~~~~~~~~\n\nThis part describes options available for server's Device Link interface.\n\nhost\n   Hostnames to listen for incoming requests on.\n\n   :Type: ``string``\n   :Default: ``(empty value)`` (listen on system's ``localhost``)\n   :Example: ``192.168.0.10``\n\nport\n   UDP port number to listen for incoming requests on.\n\n   :Type: ``integer``\n   :Min: ``0``\n   :Max: ``65000``\n   :Default: ``0`` (disable Device Link)\n   :Example: ``IP=10000``\n\nIPS\n   List of hostnames, which are allowed to connect to server's Device Link.\n\n   :Type: ``space-separated strings``\n   :Default: ``(empty value)``\n   :Example: ``127.0.0.1 192.168.0.10``\n\n\n``game`` section\n~~~~~~~~~~~~~~~~\n\nThis part describes options for different game conditions.\n\neventlog\n   Name of file to log events into. This file is created only when a mission\n   starts.\n\n   :Type: ``string``\n   :Default: ``eventlog.lst``\n   :Example: ``logs/events.log``\n\neventlogkeep\n   When enabled, events from previous mission be preserved.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``eventlogkeep=1``\n\neventlogHouse\n   Log events about destroyed buildings and trees.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``eventlogHouse=0``\n\nNoMissionInfoHud\n   When enabled, mission related messages like ``Mission completed`` are not\n   shown at the center of the screen.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``NoMissionInfoHud=0``\n\nnoKillInfoHud\n   When enabled, kill related messages like ``Enemy/friendly xxx destroyed``\n   are not shown at the right side of the screen.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``noKillInfoHud=0``\n\nlowInfoHud\n   Display HUD messages at the bottom of the screen, instead of center of the\n   screen.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``lowInfoHud=0``\n\nShowMorseAsText\n   When enabled, all Morse code beeps are also shown as text on screen.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``ShowMorseAsText=0``\n\nBlockMorseChat\n   This switch is related to undocumented \"easter egg\" feature in 4.10 patch.\n   By typing a chat message online so that the message starts with ``Morse:``\n   will cause the message to be sent as Morse code beeps instead of text. This\n   switch can be used to disable this feature in case some players decide to\n   start chatting in Morse and you don't want to hear the annoying beeping\n   noises.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``BlockMorseChat=0``\n\nSmallMapWPLabels\n   When enabled, the map shows waypoint labels with small font instead of\n   large.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``SmallMapWPLabels=1``\n\nSkipParatrooperViews\n   When enabled, external camera views skip bailed out paratroopers.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``0``\n   :Example: ``SkipParatrooperViews=0``\n\nTypeClouds\n   Use new clouds render from versions 4.x.\n\n   :Type: ``boolean`` (0 \u2014 false, 1 \u2014 true)\n   :Default: ``1``\n   :Example: ``TypeClouds=1``\n\n\n``chat`` section\n~~~~~~~~~~~~~~~~\n\nOptions for game chat.\n\nautoLogDetail\n   Amount of events users will see chat message.\n\n   .. table:: Allowed values\n\n      ====== ===================================================================\n      Value  Comment\n      ====== ===================================================================\n      0      Minimum of events (e.g., user joined, user left, user is cheating).\n      1      More events, including kills, craches, captures and so on.\n      2      More events, including destruction of ground units.\n      3      All events, including different kinds of damages.\n      ====== ===================================================================\n\n   :Type: ``integer``\n   :Min: ``0``\n   :Max: ``3``\n   :Default: ``3``\n   :Example: ``autoLogDetail=3``\n\n\n``MaxLag`` section\n~~~~~~~~~~~~~~~~~~\n\nThis section is about ``Cheating has been detected!`` messages.\n\nIt contains options which allow to limit the amount of lag acceptable by the\nhost before a player will be autokicked.\n\nSettings to leanient will have no effect, while settings too strict will cause\na lot of autokicking.\n\nnearMaxLagTime\n   Defines the max lag time allowed for an aircraft in an endangered position\n   before it is considered warping (cheating). This is meant to address players\n   who are lagging on purpose.\n\n   :Type: ``float``\n   :Min: ``0.1``\n   :Max: ``30.0``\n   :Default: ``2.0``\n   :Example: ``nearMaxLagTime=2``\n\nfarMaxLagTime\n   Defines the maximum delay (in seconds) between packets received from a given\n   client. A time greater than this is considered a warp.\n\n   :Type: ``float``\n   :Min: value of ``nearMaxLagTime``\n   :Max: ``30.0``\n   :Default: ``10.0``\n   :Example: ``farMaxLagTime=10``\n\ncheaterWarningDelay\n   Defines the maximum amount of time the system will refrain from taking\n   action against a player acting out of bounds. This can be used to avoid\n   issuing multiple warnings for a single glitch.\n\n   :Type: ``float``\n   :Min: ``1.0``\n   :Max: ``30.0``\n   :Default: ``10.0``\n   :Example: ``cheaterWarningDelay=10``\n\ncheaterWarningNum\n   Defines the max number of warnings issued before a player is autokicked by\n   the host. A value of ``-1`` prevents autokicking.\n\n   :Type: ``integer``\n   :Default: ``3``\n   :Example: ``cheaterWarningNum=3``\n\n\n.. |codeclimate| image:: https://codeclimate.com/github/IL2HorusTeam/il2fb-ds-config/badges/gpa.svg\n   :target: https://codeclimate.com/github/IL2HorusTeam/il2fb-ds-config\n   :alt: Code Climate\n\n.. |codacy| image:: https://www.codacy.com/project/badge/6691993e3d5241ceb5341ec73c0aff70\n   :target: https://www.codacy.com/app/oblalex/il2fb-ds-config\n   :alt: Codacy Code Review\n\n.. |quality| image:: https://scrutinizer-ci.com/g/IL2HorusTeam/il2fb-ds-config/badges/quality-score.png?b=master&style=flat\n   :target: https://scrutinizer-ci.com/g/IL2HorusTeam/il2fb-ds-config/?branch=master\n   :alt: Code quality provided by Scrutinizer\n\n.. |health| image:: https://landscape.io/github/IL2HorusTeam/il2fb-ds-config/master/landscape.svg?style=flat\n   :target: https://landscape.io/github/IL2HorusTeam/il2fb-ds-config/master\n   :alt: Code Health\n\n.. |code_issues| image:: https://www.quantifiedcode.com/api/v1/project/4261ecf3af654c579839aeb7e99e4ee3/badge.svg\n   :target: https://www.quantifiedcode.com/app/project/4261ecf3af654c579839aeb7e99e4ee3\n   :alt: Code issues\n\n.. |requirements| image:: https://requires.io/github/IL2HorusTeam/il2fb-ds-config/requirements.svg?branch=master\n   :target: https://requires.io/github/IL2HorusTeam/il2fb-ds-config/requirements/?branch=master\n   :alt: Requirements Status\n\n.. |pypi_package| image:: http://img.shields.io/pypi/v/il2fb-ds-config.svg?style=flat\n   :target: http://badge.fury.io/py/il2fb-ds-config/\n   :alt: Version of PyPI package\n\n.. |pypi_downloads| image::  http://img.shields.io/pypi/dm/il2fb-ds-config.svg?style=flat\n   :target: https://crate.io/packages/il2fb-ds-config/\n   :alt: Number of downloads of PyPI package\n\n.. |python_versions| image:: https://img.shields.io/badge/Python-2.7,3.4,3.5,3.6-brightgreen.svg?style=flat\n   :alt: Supported versions of Python\n\n.. |license| image:: https://img.shields.io/badge/license-LGPLv3-blue.svg?style=flat\n   :target: https://github.com/IL2HorusTeam/il2fb-ds-config/blob/master/LICENSE\n   :alt: Package license",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/IL2HorusTeam/il2fb-ds-config",
        "keywords": "il2,il-2,fb,forgotten battles,server,dedicated,config,settings",
        "license": "LGPLv3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "il2fb-ds-config",
        "package_url": "https://pypi.org/project/il2fb-ds-config/",
        "platform": "",
        "project_url": "https://pypi.org/project/il2fb-ds-config/",
        "project_urls": {
            "Homepage": "https://github.com/IL2HorusTeam/il2fb-ds-config"
        },
        "release_url": "https://pypi.org/project/il2fb-ds-config/1.0.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Library for working with settings of IL-2 FB Dedicated Server",
        "version": "1.0.0"
    },
    "last_serial": 3351379,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "01a06c2f3cbb902c707ad591edfa1514",
                    "sha256": "a75b5da18bb7c2c47ba6c5e8c5c9861926c307a6eb02035c2ffd7cb317b98ce8"
                },
                "downloads": -1,
                "filename": "il2fb-ds-config-1.0.0.zip",
                "has_sig": false,
                "md5_digest": "01a06c2f3cbb902c707ad591edfa1514",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 36122,
                "upload_time": "2017-11-21T08:10:29",
                "url": "https://files.pythonhosted.org/packages/d0/0c/b109a8c3ad8e269ab10f9c0fe30feef88f907ec477290b8735038df0ac04/il2fb-ds-config-1.0.0.zip"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "01a06c2f3cbb902c707ad591edfa1514",
                "sha256": "a75b5da18bb7c2c47ba6c5e8c5c9861926c307a6eb02035c2ffd7cb317b98ce8"
            },
            "downloads": -1,
            "filename": "il2fb-ds-config-1.0.0.zip",
            "has_sig": false,
            "md5_digest": "01a06c2f3cbb902c707ad591edfa1514",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 36122,
            "upload_time": "2017-11-21T08:10:29",
            "url": "https://files.pythonhosted.org/packages/d0/0c/b109a8c3ad8e269ab10f9c0fe30feef88f907ec477290b8735038df0ac04/il2fb-ds-config-1.0.0.zip"
        }
    ]
}