r3diance / kf2-server-extension

A repository for ServerExtension by Marco found here https://forums.tripwireinteractive.com/forum/killing-floor-2/killing-floor-2-modifications/general-modding-discussion-ad/beta-mod-releases/109463-mutator-server-extension-mod

---

This mod replaces current perk system in Killing Floor 2 with a serverside perk progression with RPG elements, which let you buy individual stats and traits.

This is a further development of the ServerExt mutator from Marco and Forrest Mark X.

Features

• RPG elements (traits and stats);
• New menu system;
• Scoreboard that supports unlimited playercount on server;
• Supports custom characters and weapons;
• Enhanced HUD feedback (kill/damage messages);
• First person legs and backpack weapon;
• Customizable experience for killing custom zeds;
• DLC weapons are available for purchase from the trader;
• Localization support.

The full changelog is available on steam workshop.

---

Note: If you want to build/test/brew/publish a mutator without git-bash and/or scripts, follow these instructions instead of what is described here.

Build

1. Install Killing Floor 2, Killing Floor 2 - SDK and git for windows;
2. Open the file C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Config\KFEditor.ini
   and add the following lines to the [ModPackages] section:

ModPackages=ServerExt
ModPackages=ServerExtMut

3. Open git-bash in the folder: C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame
4. Clone this repository and go to the source folder:
   git clone https://github.com/inklesspen1scripter/KF2-Server-Extension ./Src && cd ./Src
5. Run make.sh script: ./make.sh --compile
6. The compiled files will be here:
   C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\

Testing

You can check your build using the make.sh script.
Open git-bash in the source folder and run the script:
./make.sh --test
On first launch, the script will create testing.ini file and launch the game with the settings from it (KF-Nuked map + ServerExtMut). Edit this file if you need to test the mutator with different parameters.

Using and configuring ServerExt

A detailed manual is available on the mod page in the steam workshop.

Publication in steam workshop

1. Modify the publish files if necessary, they are here:
   C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Src\PublicationContent\

description.txt
preview.png
tags.txt
title.txt

2. Run this command in the source folder:
   ./make.sh -c && ./make.sh -bu && ./make.sh -u

Contributing

Participation is welcome!

Bug reports

If you find a bug, go to the issue page and check if there is a description of your bug. If not, create a new issue.
Describe what the bug looks like and how we can reproduce it.
Attach screenshots if you think it might help.

If it's a crash issue, be sure to include the Launch.log and Launch_2.log files. You can find them here:
C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Logs\
Please note that these files are overwritten every time you start the game/server. Therefore, you must take these files immediately after the game crashes in order not to lose information.

Localization

The mutator supports localization and you can help translate it into other languages.
It does not require any special knowledge or programming skills, so you just need to know the language into which you will translate.
Here's a quick guide on how to do it: localization guide

Contribute code

You can help improve ServerExt by fixing bugs and adding new features.
Before making a pull request, make sure that:

1. Your code is working correctly.
2. Your code does not break existing features.

In the description of the pull request, describe the changes you made.

License

The mutator is licensed under the GNU GPLv3 so you are free to use, modify, and redistribute this code, but you must keep the authors credits in the derivative work.

---

Note about the banner:
The cat in the picture is meowbin. And Cotton Valent is the artist who designed and painted this magnificent cat.