Rcon.cfg

Description

Rcon.cfg is a HLSW Config File containing remote control related information. The file consists of one big ['RconData'] structure containing string identified rcon parts. The identifier is arbitrary and is referenced by ['Games'][*]['RconData'].

Several games share the same rcon information e.g. is the rcon data identified by Q3 used by CoD, CoDUO, EF, EF2, ET, JK2, JK3, Q3, RtCW, SoF2. This is possible since all of these games are based - more or less - on the Quake engine. If you like to modify the rcon information for only one game you have to duplicate the complete Q3 rcon information, rename your copy and reference it in Games.cfg.

Syntax

    ['RconData'] = {
        ['HL2'] = {
            <-- Rcon Information -->
        }

        ['CoD2'] = {
            <-- Rcon Information -->
        }

        ...
    }

Rcon Information

The rcon information consists of following keys. Grey keys keep internal information that are only useful for HLSW developers.

['RconProtocol']

The rcon protocol used.

['bRconQueue']

If the rcon queue is enabled HLSW waits 100ms until it sends the next rcon command.

['bSecondPortRcon']

Rcon uses connect port and not query port.

['bBanIP']

Ban by ip is supported

['bBanID']

Ban by id is supported

['bBanTime']

A ban time can be specified for each ban.

['bBanSave']

The ban list can be saved and reload.

['bUsername']

For login a user name is needed.

['bExtraPort']

Rcon port can be change. User must specify an extra rcon port.

['bUTF8']

Rcon protocol uses utf8 instead of ascii.

['PermBanTime']

BanTime value that is used for permanent ban.

['BanTimeMult']

BanTime multiplier to calculate the ban time in seconds.

['Command']

Command contains a list of game independent rcon command the rcon type supports. On the left side is the name of the game independent rcon command and on the right the rcon command that is send to the server. E.g. is someone enters "/listplayers" in the rcon console HLSW looks at this list for “listplayers” and correct rcon request for the game.

['PlayerRightClickMenu']

PlayerRightClickMenu can be used to specify the rcon part of popup menu that is displayed if you right click on a player in the player list. It contains an array of menu items.

ARRAY (Menu Items)

Each menu item can be a normal item or a popup. A menu item is a popup if the Popup value exists.

['Type']

Optional value to change the type of the menu item. If no type is specified the command is executed as rcon command. If type is “URL” a browser windows is opened navigating to the URL specified by command. This value has been added in v1.3.0.

['Text']

Text that is displayed in menu.

['Command']

The rcon command that is sent to the server. You can use [[HLSW Tags#Player specific tags|Pl