Update README.md

This commit is contained in:
GenZmeY 2023-02-11 23:00:12 +03:00 committed by GitHub
parent d09a5a6d79
commit e0bf86c61e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,3 +1,27 @@
# KF2-MSKGS
# KF2-MSK-GS
**Copyright (C) 2021-2022 GenZmeY**
[![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=2850677094)
[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-MSK-GS)](LICENSE)
***
**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.
# 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 and go to any folder where you want to store sources:
`cd <ANY_FOLDER_YOU_WANT>`
3. Clone this repository and go to the source folder:
`git clone https://github.com/GenZmeY/KF2-MSK-GS && cd KF2-MSK-GS`
4. Download dependencies:
`git submodule init && git submodule update`
5. Compile:
`./tools/builder -cb`
6. Copy server-side file:
`C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\MSKGS-SRV.u`
To your kf2 server folder: `/KFGame/BrewedPC/`
7. Upload client-side files to steam workshop:
`./tools/builder -u`
# License
[GNU GPLv3](LICENSE)