Killing Floor 2

Killing Floor 2

56 ratings
Creating & Managing a Server With Game Server Manager
By jimbobslimbob
Takes you through the process of setting up a Killing Floor 2 server with Game Server Manager which automates things & provides a host of useful tools & features to make running your server easier.
   
Award
Favorite
Favorited
Unfavorite
Summary
This guide differs from others you may have read because of one important factor: the Game Server Manager program. This program automates things for you as a server owner and provides a host of useful tools and features to make setting up and running your server so much easier.

Game Server Manager features - an overview
- Automatic update checking and applying via SteamCMD (with configurable delay and server warning message)
- Players online graph
- Built-in Telnet and RCON client, which can be used manually or set to automatically send messages and commands (such as shutdown and shutdown notices) to the server
- Auto-restart if server goes down
- Message/command broadcast system
- Discord message broadcasting for server state and player changes.
- Player list showing everyone online, including ping, score, team and time online.
- INI File Parser, which displays a list of all ini file settings (across multiple files) in a list that you can sort, filter, edit, import and export as you wish.
- CPU and RAM usage display, with graph
- Network bandwidth monitor, with graph
- Ability to output status, players online and server name to a file - formatted however you want
- Single-click access to configuration.
- Detailed server information
- Internal and external IP address display
- Server up-time display
- Optional timed daily server restart.
- Timed incremental backups. Perform a daily backup of game data to a zip file.
- Automatically update game - Ability to run a maintenance / update program between restarts. e.g. SteamCMD to perform daily updates automatically. The server will start back up again when this program finished / ends so you minimise downtime.
- Option to delay timed restarts. i.e. The server will be turned off and the program will wait X seconds before attempting to restart it.
- Telnet to server
- 1 click backup and maintenance
- Remote commands to start, stop, backup, update and send commands to your server.
- Game Profiles - Multiple instances of the program can be run with multiple configurations.
- Designed to be "universal" and work with a multitude of games.
Initial Setup
Download The Game Server Manager

Head to this [www.jimbobslimbob.com]website to download my Game Server Manager[www.jimbobslimbob.com] program.

Extract the zip file to a location of your choosing and run the program.

Download SteamCMD

If you have not got it already, head to this site and download and extract SteamCMD.

Installing KF2 Server Files

Open GSM (Game Server Manager) and head to "Settings/Tools > Time Restart and Maintenance". Click the "..." button under "Program location" and select the location of your SteamCMD executable. This will set up GSM to use SteamCMD for updating.

Add the following command into the command-line parameters box at the bottom of the screen:

+login anonymous +force_install_dir "C:\KF2" +app_update 232130 +quit
Replace "C:\KF2" with wherever you want it installed

Run the maintenance program via the "Tools" tab and let SteamCMD update and install the game for you.

Port Forwarding and Firewall

You will need to forward the following ports (usually performed from your router's admin page) to the machine that you are hosting the server on:

7777 UDP - Game Port. This is the main port the game will send connections over.
27015 UDP - Query Port. This port is used to communicate with the Steam Master Server and is used by GSM to get information on your server.
8080 TCP - Web Admin. This port is used to connect to your servers web admin page (if turned on).
20560 UDP - Steam Port.
123 UDP - NTP Port. Weekly Outbreak Only - Internet time lookup to determine correct Outbreak.

These are the default ports. If you alter them then don't forget to alter the port forwarding rules as well.

You will also have to ensure that the executable "KFServer.exe" (located in the "bin" subfolder under your main installation folder) is allowed through any firewalls you have active.

Setting It Up GSM

We now need to tell GSM some things about the server. Head to "Server Details" in the settings screen and select your KF2 "KFServer.exe". This file will be in the folder you installed the game to originally, under "\Binaries\Win64".


To get the program to correctly query it, enter the IP address of the server and the query port in the relevant field. If you are running your own server this would normally be "127.0.0.1:27015". If you have altered the default ports, you may need to do so here as well. The query port is 27015 by default.

Tick "Detect via query" in the "Monitoring" tab if you want the status of the server to be detected by a server query, rather than seeing if the program is running (recommended with KF2).

Monitoring and restarting


It is recommended that you tick "Check server status, every" in the "Monitoring" tab under settings. You may want to increase the interval at which the check is performed if your server takes longer to be "ready". This actively monitors the server and updates the "Main" and "Players Online" tabs and gives you access to the following:

  • Automatically restarting the server if it goes down/crashes
  • Players online graph
  • Performance (RAM and CPU) graph
  • Network bandwidth graph
  • Ability to output the status to a file (to share or embed, for example)

Server Configuration

Rather than attempt to re-invent the wheel for this guide, for all additional server configuration options check out the official Wiki guide, here.[wiki.tripwireinteractive.com]

Tip: It can be handy to set a server configuration file in the program's settings via Server Details > Server Config File (optional) to allow you quick access to it via Game Server Manager.

INI Parser
You can also use the built in INI Parser, which displays every single ini setting in a list that can be filtered, sorted, exported and imported. This is found under the "Game Specific Tools" tab. After you have set an INI file as your "configuration file" (see above), the INI Parser will automatically load all INI files in that folder.

If you wish, you can download a pre-prepared "Friendly Names" list for use with the INI Parser here[www.jimbobslimbob.com]. Unzip it to your GSM folder. If you already have a "INIConfigList.txt" in the GSM folder (because you have already added your own) then you can copy and paste the contents of the file into your one so as to not overwrite anything you may already have - just ensure there are no double entries.


You should then be good to go.
General Use
To start the server simply click on "Start Server" on the "Main" tab. To stop the server, use the button next to start.

The main screen is split into tabs, showing different information on your server. Here you can see the number of players online, up-time, server status, performance and bandwidth details, graphs and access various tools and functions.

The Game Server Manager was designed to be highly configurable and there is many of things you can do with it. Some of those features are discussed in the sections below.
Updating and timed restarts [Optional]
The program has a built in feature to restart a server at a specific time of day. This can be found in the "Timed Restart" tab under the program settings.

Set up the time you want this to be performed and tick the "Timed restart, at" tickbox if you want to do this.


Even if you do not wish to set a timed restart, you can still make use of this screen. By selecting a program and entering any optional command line parameters in the "Run a program before starting server" section, you can enable updating the server - either manually or automatically.

For example, if you use SteamCMD to update your game, select the SteamCMD executable here and enter any command line details in the relevant box (see Initial Setup section).

Once this is set, you now have the option to perform this action on timed restarts. It will do it all for you!

You can then also use "Run Maintenance Program" under the "Settings/Tools" tab to run this program manually at any time.

Additional tip: if you have also set a backup location you can use "Perform Maintenance Now" under the "Settings/Tools" tab to perform the following sequence:
1. Back up game data
2. Stop Server
3. Run the "maintenance" program
4. Start the server back up again.
Using SteamCMD to update your game [Optional]
Regardless of whether you installed the game via the Steam client or some other method, you can still use SteamCMD to update KF2. As long as you point SteamCMD to the location of your KF2 installation, it will update it from there.

Download SteamCMD from here.

Head to the "Program Settings" and navigate to "Timed Restart" tab. Select the SteamCMD executable under "Program Location". Next, you need to tell SteamCMD what game we are updating - and where it is. To do this, we can add a number of commands in the command-line parameters field. Here are some of the ones you may need to use (put spaces between separate commands - and omit any < and > shown in the commands):

+login <username> <password>
This will log you into Steam and allow the game to be downloaded.
Please note: The first time it is performed on the machine, you may need to enter a "Steam Guard Code" before being allowed access. This is Steam's additional security layer where it will send you an e-mail with a code to input. Input it when prompted by SteamCMD.

+force_install_dir "<path>"
Tells SteamCMD that the game is located here. Enter the full path of KF2 here (e.g. "C:\KF2").

+app_update 232130
Will tell SteamCMD to go ahead and update KF2

validate
Validate that the game files are all present and correct. Tag this at the end of the above statement, without a "+" sign.

+quit
Tells SteamCMD to quit - this should always be the last command on your list.

So, an example command line could be:
+login MySteamUsername MySteamPassword +force_install_dir "C:\MyGameLocation" +app_update 232130 validate +quit

Once this has been set up you can use both the "Run Maintenance Program" (simply runs the program) and "Perform Maintenance" (will Back up game data, stop server, run the "maintenance" program, and finally start the server back up again) buttons under the "Settings/Tools" tab to update the game. Moreover, if you have set a timed restart, it will update the game before starting the server back up!

Automatic Updating
Once you have the above set, you can also tell the program to check for game updates at a regular interval. When an update is found it will automatically stop the server, update it and restart it again.

To do this, head to the "SteamCMD Auto-Updates" tab under "Program Settings" and fill out the details on this screen. You will need to enter your Steam username and password here, along with an "appid" (232130) and "branch" (public).

Once entered, select a time frame for how often the program should check for updates and tick the "Check for game updates, every" box. You are now good to go!

You can even make the program delay an update once found, for a configurable time period, in order to broadcast a message to players on your server, warning them of the impending update.
Remote Commands [Optional]
Pseudo Remote Commands Via FTP/VPN (or other similar means)
This will allow you to start, stop, backup and run maintenance (update) your server remotely (regardless of any built in features a game has).

To do this you will need to have access to the folder that the program is running in via VPN, FTP or some other means. I will not cover how to do that here, since that is really another topic altogether. I will assume that for this guide, you already have access to the folder.

How to do it

The program periodically looks to see if any of the files listed below are sitting in the folder with it. If it sees any of them it will perform the corresponding actions (and remove the file). So, to perform any of the actions listed below all you have to do is create/copy a file into the Game Server Manager folder with the corresponding name (contents of file makes no difference). The program will see the file and perform the action. Simple as that!

Start the server
File: start.txt

Stop the server
File: stop.txt

Perform a backup
File: backup.txt

Full maintenance cycle (backup, stop server, run maintenance program, start server)
File: update.txt

Restart the server
File: restart.txt
NOTE: Ensure you have set a sufficient delay in the "Server Shutdown" tab or else the server may attempt to restart before it has properly shut down.

Restart the server with command-line parameter set #1
File: parm1.txt
The command-line parameter for this is set in the "Telnet Commands" tab. You can also access this feature via the "Quick Tasks" dropdown button on the "Main" tab.
NOTE: Ensure you have set a sufficient delay in the "Server Shutdown" tab or else the server may attempt to restart before it has properly shut down.

Restart the server with command-line parameter set #2
File: parm2.txt
The command-line parameter for this is set in the "Telnet Commands" tab. You can also access this feature via the "Quick Tasks" dropdown button on the "Main" tab.
NOTE: Ensure you have set a sufficient delay in the "Server Shutdown" tab or else the server may attempt to restart before it has properly shut down.

Send command(s) to the server
File: telnetsend.txt
The program will read all text in this file and send it to the server console (provided you set this up under "Initial Setup > Setting Up GSM")
Basic Port Forwarding Guide [Reference]
Basic (Generic) Guide

NOTE:You only need to perform port forwarding if your server is going to be accessed over the internet. If you are hosting a LAN game then it is not required.

1. Find your hosting machine's LAN (internal) - displayed on the "Main" tab of GSM.

2. Log into your router's admin page in a web browser. This is variable - but most router's by standard, have the details written on the device itself somewhere (a sticker). It will be something like 192.168.0.1 or 192.168.0.255... or whatever. You will undoubtedly require a password, which is no doubt also on the sticker. If there is nothing on the router itself then you may have to get in contact with your ISP (if it's an ISP's router) or Google for the default login details of your specific router model.

3. Once you are into the router's admin pages, search for something called "port forwarding" amongst the menus. Difficult to say exactly where it would be, since all routers are different. Again, Google may be your friend here.

4. Set up a "rule" under the port forwarding screen to direct UDP / TCP traffic from the required ports to the LAN address you found in #1.

5. Save the rules and you should be good go go.

Final Note: If your hosting machine is set up to dynamically retrieve a LAN address on your network then it is possible that subsequent boots will alter your LAN address and cause port forwards to be pointing to the wrong machine. If this happens, you can either alter the port forwards again, or, even better, change your LAN address to static (and set an address manually). Another Google[www.google.co.uk] can help you with this.
Troubleshooting [Reference]
My friends cannot join the game
If you can connect locally but your friends cannot, it is almost always a firewall, AV or port forwarding issue. Ensure all is configured as it should be.

Things to check:
1. Have you let the server executable through any firewalls you have (Windows, router etc.)? Remember that Windows firewall has 3 different "profiles" (Domain, Private and Public), so ensure you have the correct ones ticked - or tick them all. Also ensure it is allowed through in both directions (incoming and outgoing).

2. Have you port forwarded all the required ports to the correct internal IP address of the server?

3. Is your server's local IP static? If not, it is liable to change on reboots and mess up your port forwarding rules. You should ideally set it to static to prevent any further changes. Either way, check to ensure your local IP has not altered and subsequently nullified your port forward rules.

4. Do you have any other software (Anti-virus or VLAN software like Hamachi) that could be interfering with network communication for the server?

Game Server Manager says my server is "Offline" when it is not
Ensure you have entered the correct IP address and port under Server Details (1) for the IP:Port of server to query. This should be "127.0.0.1:27015" by default, but if you have altered ports or are hosting on another IP address then you will need to change this.

I cannot connect to my server from the same machine I host on
There could be a port conflict. You could try and alter the ports used by the server.
Final Words
I hope this guide and the Game Server Manager was useful to you.

It may interest you to know that the program has been tried and tested not only with Killing Floor 2 - it works with Empyrion, Avorion, 7 Days to Die, GRAV, Medieval Engineers and Space Engineers too. Infact, any game that uses the standard querying language should work with it.

I have also used it to a lesser capacity in hosting servers for Project Zomboid, Neverwinter Nights, Evochron Mercenary, Planet Explorers, Void Expanse and many more that I am sure I have forgotten.

Hopefully now you have read the guide, you will have a good understanding as to how it works if you want to try it out on other games.

The Game Server Manager program is being updated regularly by myself. It has all been done in my spare time, to aid server hosters.

I hope you enjoy your Killing Floor 2 server!
38 Comments
S₮ɆRɆØ 26 Aug, 2023 @ 5:15am 
my friend use petrodactyl Kf2 Egg, is there any ways to config the remote server to perform tasks ?
Pern 19 Feb, 2022 @ 2:51pm 
getting error: Error getting NIC traffic. Please ensure you have selected a valid NIC card in settings and restart the program. I do not have an option to select a NIC. running kf2 on a virtualized windows server 2016 and using a virtual NIC. any ideas on how to fix that?
Mythical 19 Jul, 2020 @ 4:14pm 
I love this guide worked quite well. As a small note to run multiple servers you need to make copies of kfserver with different names otherwise it will restart every server (and you need to update these every new update). As another note I've added you on steam and have something I'd like to ask you about if you're down :D.
Juliano 10 Jun, 2020 @ 6:35pm 
I just wanted to play with my friend...
jimbobslimbob  [author] 21 Apr, 2020 @ 1:17pm 
There is no built in functionality for that specific purpose.
ThePlutoSociety ॐ 21 Apr, 2020 @ 5:53am 
I will use the "Run a program before starting server" option I think
ThePlutoSociety ॐ 21 Apr, 2020 @ 2:18am 
Hello,
Is there a way to manager server logs on NWN with your program ? Like a log rotate ?

Thank you :)
jimbobslimbob  [author] 24 Apr, 2019 @ 3:28am 
I have never had them in separate places so am unsure on that point.
Hans Landa 24 Apr, 2019 @ 1:43am 
It just keeps saying
Failed to load package ' '

What is the gaddamn package ' '

Anyways, I'll try to launch the server without mods to see if it'll work. PS - Having the server and the game installed in different drives is a problem?
jimbobslimbob  [author] 24 Apr, 2019 @ 12:46am 
The error also mentions checking the log file for errors... worth doing.