KillingFloor2/KF2-StartWave
KillingFloor2/KF2-StartWave
1
0
Fork 0
Code Releases 3 Activity

update readme

Browse Source
This commit is contained in:
GenZmeY 2021-06-20 06:11:09 +03:00
parent e4956a6125
commit 5d3a7cece3
2 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
PublicationContent/description.txt
View File

@ -1,9 +1,9 @@
[h1]WARNING![/h1] [h1]Warning[/h1]
This mod is not whitelisted and will unrank your server. Any XP gained will not be saved. This mod is not whitelisted and will unrank your server. Any XP gained will not be saved.
[h1]Disclaimer [/h1] [h1]Disclaimer [/h1]
This is the same as [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1417081496]Pharrahnox's SetWave[/url], but with some fixes: This is the same as [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1417081496]Pharrahnox's SetWave[/url], but with some fixes:
- fixed Dosh parameter for Endless mode. - fixed starting Dosh for Endless mode.
[h1]Description:[/h1] [h1]Description:[/h1]
A utility mod that allows users to specify the starting wave and the boss that will spawn. Additionally, users can jump between waves during the match with a console command (mutate setwave, see below). A utility mod that allows users to specify the starting wave and the boss that will spawn. Additionally, users can jump between waves during the match with a console command (mutate setwave, see below).
@ -16,7 +16,7 @@ It is designed to be compatible with every mutator and wave-based gamemode, and
3. Open console (`) and input: 3. Open console (`) and input:
[code]open KF-BioticsLab?Game=KFGameContent.KFGameInfo_Endless?Difficulty=0?GameLength=0?Mutator=StartWave.StartWave?[/code] [code]open KF-BioticsLab?Game=KFGameContent.KFGameInfo_Endless?Difficulty=0?GameLength=0?Mutator=StartWave.StartWave?[/code]
Change the name of the map and the parameters of the game to the ones you need. Change the name of the map and the parameters of the game to the ones you need.
Add StartWave parameters that you need to this line (you can add any parameter from the config, the description is below). Add StartWave parameters that you need to the end of the line (you can add any parameter from the config, the description is below).
4. <Enter>. 4. <Enter>.
[h1]Usage (server):[/h1] [h1]Usage (server):[/h1]
@ -24,7 +24,7 @@ Add StartWave parameters that you need to this line (you can add any parameter f
1. Open your PCServer-KFEngine.ini / LinuxServer-KFEngine.ini; 1. Open your PCServer-KFEngine.ini / LinuxServer-KFEngine.ini;
2. Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section: 2. Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section:
[code]ServerSubscribedWorkshopItems=<WORKSHOP_ID>[/code] [code]ServerSubscribedWorkshopItems=2521731447[/code]
3. Start the server and wait while the mutator is downloading; 3. Start the server and wait while the mutator is downloading;
4. Stop the server; 4. Stop the server;
5. Add mutator to server start line: [b]?Mutator=StartWave.StartWave[/b] 5. Add mutator to server start line: [b]?Mutator=StartWave.StartWave[/b]
@ -32,12 +32,13 @@ Add StartWave parameters that you need to this line (you can add any parameter f
7. Start the server 7. Start the server
[h1]Mutator setup[/h1] [h1]Mutator setup[/h1]
You can use a config file if you do not want to specify parameters in the startup line: You can use a config if you don't want to specify parameters in the startup line:
Create a file KFGame/Config/KFStartWave.ini and copy this text into it: Create a file KFGame/Config/KFStartWave.ini and copy this text into it:
[code] [code]
[StartWave.StartWave] [StartWave.StartWave]
// Any settings not specified in the launch command will use the values stored here. If you use the same // Any settings not specified in the launch command will use the values stored here.
// settings often, it is recommended to store those here and only change what you need in the launch command. // If you use the same settings often, it is recommended to store those here
// and only change what you need in the launch command.
// Whether mod-specific events should be logged. // Whether mod-specific events should be logged.
bUseDebug=true bUseDebug=true
@ -57,8 +58,9 @@ TraderTime=60
// The starting dosh of players. // The starting dosh of players.
Dosh=250 Dosh=250
// The boss override index. For the default boss list, 0-Hans, 1-Patty, 2-King FP, 3-Abomination. Negative // The boss override index.
// values can be used to keep the boss spawn random. // For the default boss list, 0-Hans, 1-Patty, 2-King FP, 3-Abomination.
// Negative values can be used to keep the boss spawn random.
Boss=-1 Boss=-1
[/code] [/code]
You can change the config as you need. You can change the config as you need.
@ -96,9 +98,5 @@ I didn't test the mod very much because I only needed to fix a bug with Dosh.
If you find any other problems, please describe how to reproduce them. Maybe I can fix it. If you find any other problems, please describe how to reproduce them. Maybe I can fix it.
You can do it right here, but I'll be much happier if you do it [url=https://github.com/GenZmeY/KF2-StartWave/issues]in issues on github[/url] . You can do it right here, but I'll be much happier if you do it [url=https://github.com/GenZmeY/KF2-StartWave/issues]in issues on github[/url] .
[h1]Credits:[/h1]
[url=https://steamcommunity.com/profiles/76561198021230296]Pharrahnox[/url] - creating a mutator;
[url=https://steamcommunity.com/profiles/76561198001617867]GenZmeY[/url] - bugfixes.
[h1]Sources:[/h1] [h1]Sources:[/h1]
[u]https://github.com/GenZmeY/KF2-StartWave[/u] [b](GNU GPLv3)[/b] [u]https://github.com/GenZmeY/KF2-StartWave[/u] [b](GNU GPLv3)[/b]

20
README.md
View File

@ -1,14 +1,24 @@
# KF2-StartWave # KF2-StartWave
[![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=<WORKSHOP_ID>) [![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=2521731447)
[![Steam Subscriptions](https://img.shields.io/steam/subscriptions/<WORKSHOP_ID>)](https://steamcommunity.com/sharedfiles/filedetails/?id=<WORKSHOP_ID>) [![Steam Subscriptions](https://img.shields.io/steam/subscriptions/2521731447)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521731447)
[![Steam Favorites](https://img.shields.io/steam/favorites/<WORKSHOP_ID>)](https://steamcommunity.com/sharedfiles/filedetails/?id=<WORKSHOP_ID>) [![Steam Favorites](https://img.shields.io/steam/favorites/2521731447)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521731447)
[![Steam Update Date](https://img.shields.io/steam/update-date/<WORKSHOP_ID>)](https://steamcommunity.com/sharedfiles/filedetails/?id=<WORKSHOP_ID>) [![Steam Update Date](https://img.shields.io/steam/update-date/2521731447)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521731447)
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-StartWave)](https://github.com/GenZmeY/KF2-StartWave/tags) [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-StartWave)](https://github.com/GenZmeY/KF2-StartWave/tags)
[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-StartWave)](LICENSE) [![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-StartWave)](LICENSE)
# Description
A utility mod that allows users to specify the starting wave and the boss that will spawn. Additionally, users can jump between waves during the match with a console command (mutate setwave, see below).
The purpose of this mod is to allow mappers to more efficiently test their maps for later waves or for the boss. It could also be used to skip early waves if you find them boring, or to test strategies against a specific boss.
It is designed to be compatible with every mutator and wave-based gamemode, and to require little to no maintenance after game updates.
**This is the same as [Pharrahnox's SetWave](https://steamcommunity.com/sharedfiles/filedetails/?id=1417081496), but with some fixes:**
- fixed starting Dosh for Endless mode.
# Usage # Usage
[See steam workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=<WORKSHOP_ID>) [See steam workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2521731447)
***
**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. **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.