KF2-StartWave/README.md

2.8 KiB

KF2-StartWave

Steam Workshop Steam Subscriptions Steam Favorites Steam Update Date GitHub tag (latest by date) GitHub

Usage

See steam workshop page

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 git-bash in the folder: C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame
  3. Clone this repository and go to the source folder:
    git clone https://github.com/GenZmeY/KF2-StartWave && cd KF2-StartWave
  4. Run make.sh script: ./make.sh --compile
  5. 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.

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 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.

License

GNU GPLv3