Skip to content

Latest commit

 

History

History
134 lines (72 loc) · 7.35 KB

BASIC-CONFIGURATION.md

File metadata and controls

134 lines (72 loc) · 7.35 KB
Raw

Logo

Basic configuration

Main page

Launcher screenshot

  • Platform: This combo is mandatory. It allows to select the platform where the server is installed.

  • Profile: This combo is mandatory. It allows to customize filter values by profile name.

  • Run server: Run a Killing Floor 2 server with the specified filters. All mandatory fields must be specified. Server config files are placed in folder: KFGame/Config/PROFILENAME. So, the original config files placed in folder: KFGame/Config are never modified. If more than one profile, you can launch multiple servers at once (one per profile).

  • Join server: Join to a Killing Floor 2 server game previously started. If the server has not been started, the operation will start the game but it will not join to any sever. Pre-requisites: Steam application and Killing Floor 2 game client must be installed. If more than one profile, you can select wich server you want to join (one per profile).

Basic parameters

  • Map: This combo is mandatory. It allows you to select one specific official map or custom map. NOTE: Custom maps are visible in this field only if they were already downloaded before.

  • Language: This combo is mandatory. It allows to select a language for the launcher's interface. List of available languages are described in the Features section of this document.

  • Game Type: This combo is mandatory. It allows you to select one specific game type.

  • Difficulty: This combo is mandatory. It allows you to select one specific difficulty level.

  • Length: This combo is mandatory. It allows you to select one specific number of waves.

  • Max. players: This field is mandatory. It allows you to select one specific maximum number of players in a match.

  • Server name: This field is mandatory. It must contain at least one character.

  • Server password: This field is optional. It allows you to protect your server with a password (needed to known to be able to join the game).

  • URL image server: This field is optional. This is a local image uploaded to an embedded http web server. The image resolution must be 512x256 and format PNG. If defined, it will be visible in the welcome screen of the server game but only if "Your clan", "Your web link" and "Welcome message" parameters are defined too.

  • Your clan: This field is optional.

  • Your web link: This field is optional.

  • Welcome message: This field is optional. It's a welcome message in starting screen of the server.

  • Web page: If web page check is enabled you can manage the server through WebAdmin page. Killing Floor 2 server must be launched before you can access WebAdmin page.

  • Web password: This field is optional. It allows you to protect WebAdmin page with a password to login.

  • Takeover: If this check is enabled other people can takeover the server, that means, change the password, change other configurations and take the control of the server.

Custom Image Server

You can upload a custom image to the embedded http web server to be visible in KF2's server. Not all the images are supported in the game. Only images that meet image resolution must be 512x256, format PNG and color in 16 bits depth.

An example Launcher screenshot

In game lobby Launcher screenshot

Advanced parameters

Launcher screenshot

  • Map voting: This check enables or disables map voting screen after a game ends.

  • Map voting time: This field is optional. The time, in seconds, you have to vote a map.

  • Kick voting: This check enables or disables the ability to cast a kick vote.

  • Kick percentage: This field is optional. How many players it will take to pass a kick vote. Example: 0.50 = 50% is 3/6 players, 0.66 = 66% is 4/6 players, 0.83 = 83% is 5/6 players, etc. Minimum value is 0, maximum is 1.

  • Time between kick votes: This field is optional. The time, in seconds, you must wait after a kick vote has failed before initiating another kick vote.

  • Max.idle time to be kicked: This field is optional. Set the maximum time players can idle before getting automatically kicked. Maximum is 300 seconds. Players will be notified via text chat if they're idling too long.

  • Public text chat: This check enables or disables text chat entirely.

  • Spectators chat: If this check is enabled, spectators will only be allowed to talk with other spectators. This does not affect text chat.

  • VoIP: This check enables or disables voice chat entirely.

  • Dead players can talk: If this check is false, players that die will not be able to voice chat until they spawn back in.

  • Chat logging: If this check is enabled, the in-game text chat will be logged to a file.

  • Chat logging filename: This field is optional. It indicates the filename used to log the text chat. You can enable the use of timestamp with the filename.

  • Team collision: This check enables or disables players to be able to walk through each other during the game.

  • Admin can pause: If this check is enabled, it allows admins to pause the game for all players using the console command: pause. If game is paused, players will still be able to connect and join the server.

  • Announce admin login: if this check is enabled, when you login as admin in-game, it will announce to everyone "PlayerName has logged in as Admin".

  • Ready up delay: This field is optional. The time, in seconds, you must wait when all players are set to "Ready Up" except one player.

  • Game start delay: This field is optional. The delay, in seconds, you wait after all players are set to "Ready Up". Lowest value you can use is 1.

  • Max.spectators: This field is optional. The maxium numbers of spectators allowed.

  • Map objetives: If this check is enabled, the stand your ground map objectives are present.

  • Pick up items: This check enables or disables Kevlar and weapon pick ups.

  • Friendly fire percentage: This field is optional. Enables players to inflict damage on their teammates. Minimun value is 0, maximum is 1.

  • Ports: These fields are optional. You need to open ports in your router and firewall. If more than one server is launched, ports must be different between them (one configuration per profile).

  • Tickrate: These parameters mean how many times the server updates per second. The higher the better. Manimum value admited is 60.

  • Max client rate: These parameters mean bandwith cap in bytes.

Custom parameters

Launcher screenshot

  • Custom parameters: This field is optional. It defines additional parameters. The format must be: [?]parameter1=value1?parameter2=value2?...?parameterN=valueN

    [?] means: optionally you can start parameters by "?"

WebAdmin page

In this section you can access to WebAdmin page only if the server is already started and web page is checked in "Main Page" section of the application. WebAdmin allows you to manage and control the Killing Floor 2 server.

Launcher screenshot

Console page

In this section you can see the commands generated by the launcher when you run or join a server.

Launcher screenshot

Back to main page here.