update readme

This commit is contained in:
GenZmeY 2021-01-31 13:22:26 +03:00
parent 67b37fab6c
commit 88fb6e0bfe

View File

@ -1,27 +1,22 @@
# Throw All Weapons On Death
[![](PublicationContent/mutbanner.png)](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040)
[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-TAWOD)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Steam Workshop](https://img.shields.io/badge/steam-workshop-0)](https://steamcommunity.com/sharedfiles/filedetails/?id=2379769040)
[![Steam Subscriptions](https://img.shields.io/steam/subscriptions/2379769040)](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)
***
[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-TAWOD)](https://www.gnu.org/licenses/gpl-3.0.en.html)
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);
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`
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`
4. The compiled files will be here:
`C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\`
`C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\`
# Testing
You can check your build using the `make.sh` script.
@ -32,14 +27,14 @@ On first launch, the script will create `testing.ini` file and launch the game w
# Usage (Server)
1. Open your PCServer-KFEngine.ini / LinuxServer-KFEngine.ini;
2. Add the following string to the [OnlineSubsystemSteamworks.KFWorkshopSteamworks] section:
`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`
`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`
# Bug reports
If you find a bug, create new issue here: [Issues](https://github.com/GenZmeY/KF2-TAWOD/issues)
If you find a bug, create new issue here: [Issues](https://github.com/GenZmeY/KF2-TAWOD/issues)
Describe what the bug looks like and how to reproduce it.
# License
The mutator is licensed under the [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
The mutator is licensed under the [GNU GPLv3](LICENSE).