From 88fcd8b23529a99a5548662f570253354356dc3e Mon Sep 17 00:00:00 2001 From: GenZmeY Date: Wed, 1 Jun 2022 11:39:45 +0300 Subject: [PATCH] Update README.md --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c27720..77a331e 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ -# KF2-ZedSpawner \ No newline at end of file +# ZedSpawner + +[![Steam Workshop](https://img.shields.io/static/v1?message=workshop&logo=steam&labelColor=gray&color=blue&logoColor=white&label=steam%20)](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931) +[![Steam Subscriptions](https://img.shields.io/steam/subscriptions/2811290931)](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931) +[![Steam Favorites](https://img.shields.io/steam/favorites/2811290931)](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931) +[![Steam Update Date](https://img.shields.io/steam/update-date/2811290931)](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931) +[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-ZedSpawner)](https://github.com/GenZmeY/KF2-ZedSpawner/tags) +[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-ZedSpawner)](LICENSE) + +# Description +Spawner for zeds. Started as a modification of the [PissJar](https://steamcommunity.com/sharedfiles/filedetails/?id=1082749153) and [Windows 10](https://steamcommunity.com/sharedfiles/filedetails/?id=2488241348) version, but grew into something completely different... + +# Features +- spawn without increasing zed counter +- spawn depends on the number of players +- cyclic spawn (useful for endless mode) +- separate spawn for special waves and boss waves +- spawn after a certain percentage of killed zeds + +# Usage +**UNDER CONSTRUCTION** + +[Spawn Calculator](https://docs.google.com/spreadsheets/d/1q67WJ36jhj6Y0lPNO5tS2bU79Wphu4Xmi62me6DAwtM/edit?usp=sharing) + +# Build +**Note:** If you want to build/test/brew/publish a mutator without git-bash and/or scripts, follow [these instructions](https://tripwireinteractive.atlassian.net/wiki/spaces/KF2SW/pages/26247172/KF2+Code+Modding+How-to) instead of what is described here. +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 and go to any folder where you want to store sources: +`cd ` +3. Clone this repository and go to the source folder: +`git clone https://github.com/GenZmeY/KF2-ZedSpawner && cd KF2-ZedSpawner` +4. Download dependencies: +`git submodule init && git submodule update` +5. Compile: +`./tools/builder -c` +5. The compiled files will be here: +`C:\Users\\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\` + +# Testing +Open git-bash in the source folder and run command: +`./tools/builder -t` +(or `./tools/builder -ct` if you haven't compiled the mutator yet) + +A local single-user test will be launched with parameters from `builder.cfg` (edit this file if you want to test mutator with different parameters). + +# Bug reports +If you find a bug, go to the [issue page](https://github.com/GenZmeY/KF2-ZedSpawner/issues) 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. +Attaching your KFZedSpawner.ini and Launch.log can also be helpful. + +# License +[GNU GPLv3](LICENSE)