add build tools, remove useless code
This commit is contained in:
27
README.md
27
README.md
@ -9,23 +9,22 @@
|
||||
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
|
||||
**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, 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\`
|
||||
|
||||
# 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.
|
||||
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-TAWOD && cd KF2-TAWOD`
|
||||
4. Download dependencies:
|
||||
`git submodule init && git submodule update`
|
||||
5. Compile:
|
||||
`./tools/builder -c`
|
||||
5. The compiled files will be here:
|
||||
`C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\`
|
||||
|
||||
# Usage (Server)
|
||||
1. Open your PCServer-KFEngine.ini / LinuxServer-KFEngine.ini;
|
||||
2. Add the following string to the [OnlineSubsystemSteamworks.KFWorkshopSteamworks] section:
|
||||
2. Add the following string to the [OnlineSubsystemSteamworks.KFWorkshopSteamworks] section (create one if it doesn't exist):
|
||||
`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:
|
||||
@ -36,4 +35,4 @@ If you find a bug, create new issue here: [Issues](https://github.com/GenZmeY/KF
|
||||
Describe what the bug looks like and how to reproduce it.
|
||||
|
||||
# License
|
||||
The mutator is licensed under the [GNU GPLv3](LICENSE).
|
||||
[GNU GPLv3](LICENSE).
|
||||
|
Reference in New Issue
Block a user