add description

PublicationContent/description.txt

@@ -1,7 +1,71 @@
-[h1]ZedSpawner[/h1]
-
 [h1]Description[/h1]
-Work In Progress...
+Spawner for zeds. Started as a modification of [url=https://steamcommunity.com/sharedfiles/filedetails/?id=2488241348]this version[/url], but now there is almost nothing left of the previous mutator, lol xD
+
+[h1]Features[/h1]
+- 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.
+
+[h1]Whitelisted?[/h1]
+No. This mod is not whitelisted and will unrank your server. Any XP gained will not be saved.
+
+[h1]Usage (single player)[/h1]
+1. Subscribe to this mutator;
+2. Start KF2; 
+3. Open console (`) and input:
+[b]open KF-BioticsLab?Mutator=ZedSpawner.ZedSpawnerMut[/b]
+(replace the map and add the parameters you need)
+4. <Enter>.
+
+[h1]Usage (server)[/h1]
+[b]Note:[/b] [i]If you don't understand what is written here, read the article [url=https://wiki.killingfloor2.com/index.php?title=Dedicated_Server_(Killing_Floor_2)][u]Dedicated Server (KF2 wiki)[/u][/url] before following these instructions.[/i]
+
+1. Open your [b]PCServer-KFEngine.ini[/b] / [b]LinuxServer-KFEngine.ini[/b];
+2. Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section (create one if it doesn't exist):
+[b]ServerSubscribedWorkshopItems=2811290931[/b]
+3. Start the server and wait while the mutator is downloading;
+4. Add mutator to server start parameters: [b]?Mutator=ZedSpawner.ZedSpawnerMut[/b] and restart the server.
+
+[h1]Setup[/h1]
+At the first start, the [b]KFZedSpawner.ini[/b] config will be created. There are already default settings and spawn lists, but you still need to change them because this is just an example.
+
+[b]Cyclic spawn[/b]
+If you don't want to write an endless spawn list for the endless mode (lol) use a cyclic spawn. Set parameter [b]bCyclicalSpawn=True[/b]
+After the last wave in the spawn list ends, spawn will start again from the beginning of the list.
+Using the [b]SpawnTotalCycleMultiplier[/b] and [b]SingleSpawnLimitCycleMultiplier[/b] modifiers will allow you to adjust the difficulty of the following cycles.
+
+[b]Shadow spawn[/b]
+With [b]bShadowSpawn=True[/b], the zeds from the list will replace the original zeds that haven't spawned yet, so the counter of the remaining zeds won't grow. Spawning will stop when there are no unspawned zeds left.
+With [b]bShadowSpawn=False[/b] zeds from the spawn list will not replace the original ones. The counter of remaining zeds will increase when spawning. Spawn will continue until the end of the wave.
+
+[b]AliveSpawnLimit[/b]
+If you have a server crash with a large number of zeds, set [b]AliveSpawnLimit[/b]. If the number of live zeds reaches the specified limit, spawning will be stopped until there are fewer zeds. At zero there is no limit.
+
+[b]Spawn lists[/b]
+Use the [b][ZedSpawner.SpawnListRegular][/b] section to set spawn on any wave.
+Use the [b][ZedSpawner.SpawnListBossWaves][/b] and [b][ZedSpawner.SpawnListSpecialWaves][/b] sections to set a separate spawn for the boss wave and special waves if needed. Use [b]bStopRegularSpawn=True[/b] if you want to stop spawning from the regular list during boss waves or special waves.
+
+[b]Spawn entry parameters[/b]
+[list]
+[*][b]Wave / BossClass[/b] - what wave is the spawn for. Wave number for the regular list, wave type for the special list; boss class for the boss list.
+[*][b]ZedClass[/b] - the class of the zed you want to spawn (for example: ZedternalReborn.WMPawn_ZedScrake_Omega).
+[*][b]RelativeStart[/b] - allows you to start spawning a zed not on a timer, but after killing the specified percentage of zeds. If set to zero, spawn will start after [b]Delay[/b] seconds from the start of the wave. Note that [b]RelativeStart[/b] does not work on bosses.
+[*][b]Delay[/b] - time in seconds between spawns.
+[*][b]Probability[/b] - the chance (%) of each spawn (1-100).
+[*][b]SpawnCountBase[/b] - The base number of zeds to spawn, aka the number of zeds that will be spawned on the first cycle with one player. Can be adjusted by modifiers, number of players and cycle number.
+[*][b]SingleSpawnLimit[/b] - maximum number of zeds for one spawn. Can be adjusted by modifiers, number of players and cycle number.
+[*][b]bSpawnAtPlayerStart[/b] - exactly what is written.
+[/list]
+
+[h1]Spawn logic[/h1]
+I really tried to describe in text how it works, but every time I got some kind of crap. Therefore, I decided to explain it a little differently and made a small calculator for this. It is interactive, you can change the parameters and see what happens. It has all the necessary explanations, so I think you will quickly figure out how the spawner works.
+
+[h1]📌[url=https://redirect.genzmey.su/kf2-zedspawner-calc]Spawn calculator[/url][/h1]
+[i]Just please try not to interfere with each other if you see that someone is already using a calculator.[/i]
+
+By the way, ZedSpawner logs everything it does, so reading the logs can also help you figure out how it works.
 
 [h1]Sources[/h1]
-[url=https://github.com/GenZmeY/KF2-ZedSpawner]https://github.com/GenZmeY/KF2-ZedSpawner[/url]
+[url=https://github.com/GenZmeY/KF2-ZedSpawner]https://github.com/GenZmeY/KF2-ZedSpawner[/url] (GNU GPLv3)

README.md

@@ -8,7 +8,7 @@
 [![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...  
+Spawner for zeds. Started as a modification of the [this version](https://steamcommunity.com/sharedfiles/filedetails/?id=2488241348), but now there is almost nothing left of the previous mutator, lol  
 
 # Features
 - spawn without increasing zed counter;
@@ -17,9 +17,10 @@ Spawner for zeds. Started as a modification of the [PissJar](https://steamcommun
 - separate spawn for special waves and boss waves;
 - spawn after a certain percentage of killed zeds.
 
-# Usage
-**UNDER CONSTRUCTION**
+# Usage & Setup
+[See steam workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2811290931)
 
+# Spawn calculator
 [Spawn Calculator](https://docs.google.com/spreadsheets/d/1q67WJ36jhj6Y0lPNO5tS2bU79Wphu4Xmi62me6DAwtM/edit?usp=sharing)
 
 # Build

ZedSpawner/Classes/ZedSpawner.uc

@@ -1,9 +1,7 @@
 class ZedSpawner extends Info
 	config(ZedSpawner);
 
-const LatestVersion = 1;
-
-const dt = 1;
+const LatestVersion = 2;
 
 const CfgSpawn        = class'Spawn';
 const CfgSpawnListRW  = class'SpawnListRegular';
@@ -34,7 +32,7 @@ struct S_SpawnEntry
 	var float  RelativeStartDefault;
 	var float  RelativeStart;
 	var int    DelayDefault;
-	var int    Delay;
+	var float  Delay;
 	var int    PawnsLeft;
 	var int    PawnsTotal;
 	var bool   SpawnAtPlayerStart;
@@ -44,6 +42,9 @@ struct S_SpawnEntry
 
 var private config int        Version;
 var private config E_LogLevel LogLevel;
+var private config float      Tickrate;
+
+var private float dt;
 
 var private Array<S_SpawnEntry> SpawnListRW;
 var private Array<S_SpawnEntry> SpawnListBW;
@@ -101,6 +102,7 @@ private function InitConfig()
 {
 	if (Version == `NO_CONFIG)
 	{
+		Tickrate = 1.0f;
 		LogLevel = LL_Info;
 		SaveConfig();
 	}
@@ -114,6 +116,9 @@ private function InitConfig()
 	{
 		case `NO_CONFIG:
 			`ZS_Info("Config created");
+			
+		case 1:
+			Tickrate = 1.0f;
 
 		case MaxInt:
 			`ZS_Info("Config updated to version"@LatestVersion);
@@ -164,12 +169,20 @@ private function Init()
 	}
 	`ZS_Log("LogLevel:" @ LogLevel);
 	
-	if (!CfgSpawn.static.Load(LogLevel))
+	if (Tickrate <= 0)
+	{
+		`ZS_Error("Spawner tickrate must be positive (current value:" @ Tickrate $ ")");
+	}
+	
+	if (!CfgSpawn.static.Load(LogLevel) || Tickrate <= 0)
 	{
 		`ZS_Fatal("Wrong settings, Destroy...");
 		Destroy();
 		return;
 	}
+	
+	dt = 1 / Tickrate;
+	`ZS_Info("Spawner tickrate:" @ Tickrate @ "(update every" @ dt $ "s)");
 
 	SpawnListRW = CfgSpawnListRW.static.Load(LogLevel);
 	SpawnListBW = CfgSpawnListBW.static.Load(LogLevel);
@@ -193,7 +206,7 @@ private function Init()
 	
 	PreloadContent();
 	
-	SetTimer(float(dt), true, nameof(SpawnTimer));
+	SetTimer(dt, true, nameof(SpawnTimer));
 }
 
 private function PreloadContent()
@@ -281,7 +294,7 @@ private function SpawnTimer()
 			continue;
 		}
 		
-		if (SE.Delay > 0)
+		if (SE.Delay > 0.0f)
 		{
 			SpawnListCurrent[Index].Delay -= dt;
 			continue;
@@ -431,15 +444,15 @@ private function AdjustSpawnList(out Array<S_SpawnEntry> List)
 		if (KFGIS.MyKFGRI.IsBossWave())
 		{
 			List[Index].RelativeStart = 0.f;
-			List[Index].Delay = SE.DelayDefault;
+			List[Index].Delay = float(SE.DelayDefault);
 		}
 		else
 		{
 			List[Index].RelativeStart = SE.RelativeStartDefault;
 			if (List[Index].RelativeStart == 0.f)
-				List[Index].Delay = SE.DelayDefault;
+				List[Index].Delay = float(SE.DelayDefault);
 			else
-				List[Index].Delay = 0;
+				List[Index].Delay = 0.0f;
 		}
 		
 		PawnTotalF = B * (TM + TCM * (Cycle - 1.0f) + TPM * (Players - 1.0f));
@@ -490,7 +503,7 @@ private function SpawnEntry(out Array<S_SpawnEntry> SpawnList, int Index)
 	
 	SE = SpawnList[Index];
 	
-	SpawnList[Index].Delay = SE.DelayDefault;
+	SpawnList[Index].Delay = float(SE.DelayDefault);
 	if (FRand() <= SE.Probability || SE.ForceSpawn)
 	{
 		if (SE.SingleSpawnLimit == 0 || SE.PawnsLeft < SE.SingleSpawnLimit)
@@ -520,10 +533,10 @@ private function SpawnEntry(out Array<S_SpawnEntry> SpawnList, int Index)
 		Spawned = SpawnZed(SE.ZedClass, PawnCount, SE.SpawnAtPlayerStart);
 		if (Spawned == INDEX_NONE)
 		{
-			SpawnList[Index].Delay = 5;
+			SpawnList[Index].Delay = 5.0f;
 			SpawnList[Index].ForceSpawn = true;
 			Action  = "Skip spawn";
-			Comment = "no free spawn volume, try to spawn it again in" @ SpawnList[Index].Delay @ "seconds...";
+			Comment = "no free spawn volume, try to spawn it again in" @ Round(SpawnList[Index].Delay) @ "seconds...";
 			SpawnLog(SE, Action, Comment);
 			return;
 		}