KF2-TAWOD/README.md

40 lines
2.3 KiB
Markdown
Raw Normal View History

2021-01-31 10:13:35 +00:00
[![](PublicationContent/mutbanner.png)](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040)
[![Steam Workshop](https://img.shields.io/badge/steam-workshop-0)](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040)
[![Steam Favorites](https://img.shields.io/steam/favorites/2379769040)](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040)
[![Steam Update Date](https://img.shields.io/steam/update-date/2379769040)](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040)
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-TAWOD)](https://github.com/GenZmeY/KF2-TAWOD/tags)
2021-01-31 10:22:26 +00:00
[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-TAWOD)](https://www.gnu.org/licenses/gpl-3.0.en.html)
2021-01-31 10:13:35 +00:00
A small mutator that forces players to throw all their weapons on death (not just the current weapon as in the game by default).
# Build
1. Install [Killing Floor 2](https://store.steampowered.com/app/232090/Killing_Floor_2/), Killing Floor 2 - SDK and [git for windows](https://git-scm.com/download/win);
2021-01-31 10:22:26 +00:00
2. Open git-bash, clone this repository and go to the source folder:
`git clone https://github.com/GenZmeY/KF2-TAWOD && cd KF2-TAWOD`
3. Run make.sh script:
`./make.sh --compile`
2021-01-31 10:13:35 +00:00
4. The compiled files will be here:
2021-01-31 10:22:26 +00:00
`C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\`
2021-01-31 10:13:35 +00:00
# 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-Outpost map + TAWODMut). Edit this file if you need to test the mutator with different parameters.
# Usage (Server)
1. Open your PCServer-KFEngine.ini / LinuxServer-KFEngine.ini;
2. Add the following string to the [OnlineSubsystemSteamworks.KFWorkshopSteamworks] section:
2021-01-31 10:22:26 +00:00
`ServerSubscribedWorkshopItems=2379769040`
3. Start the server and wait while the mutator is downloading;
4. Add the following line to the startup parameters and restart the server:
`?Mutator=TAWOD.TAWODMut`
2021-01-31 10:13:35 +00:00
# Bug reports
2021-01-31 10:22:26 +00:00
If you find a bug, create new issue here: [Issues](https://github.com/GenZmeY/KF2-TAWOD/issues)
2021-01-31 10:13:35 +00:00
Describe what the bug looks like and how to reproduce it.
# License
2021-01-31 10:22:26 +00:00
The mutator is licensed under the [GNU GPLv3](LICENSE).