Merge pull request #4 from GenZmeY/group-names

add mutator group name

.editorconfig

@@ -0,0 +1,33 @@
+root = true
+
+# Global
+[*]
+indent_style = unset
+indent_size = 4
+tab_width = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = unset
+
+# Unreal Engine 3 / Source
+[*.uc]
+indent_style = tab
+
+[*.{uci,upkg}]
+
+# Unreal Engine 3 / i18n
+[*.{chn,cht,cze,dan,deu,dut,esl,esn,fra,frc,hun,int,ita,jpn,kor,pol,por,ptb,rus,tur,ukr}]
+charset = utf-16le
+
+# Other
+[*.md]
+indent_style = space
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.{txt,cfg,conf}]
+indent_style = tab

.github/workflows/mega-linter.yml

@@ -0,0 +1,72 @@
+---
+name: MegaLinter
+
+permissions: read-all
+
+on:
+  push:
+  pull_request:
+    branches: [master]
+
+env:
+  APPLY_FIXES: none
+  APPLY_FIXES_EVENT: pull_request
+  APPLY_FIXES_MODE: commit
+  DISABLE: SPELL
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+
+      - name: MegaLinter
+        id: ml
+        uses: oxsecurity/megalinter@v6
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Archive production artifacts
+        if: ${{ success() }} || ${{ failure() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log
+
+      - name: Create Pull Request with applied fixes
+        id: cpr
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          commit-message: "[MegaLinter] Apply linters automatic fixes"
+          title: "[MegaLinter] Apply linters automatic fixes"
+          labels: bot
+      - name: Create PR output
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
+        run: |
+          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+      - name: Prepare commit
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
+        run: sudo chown -Rc $UID .git/
+      - name: Commit and push applied linter fixes
+        if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository)
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
+          commit_message: "[MegaLinter] Apply linters fixes"
+          commit_user_name: megalinter-bot
+          commit_user_email: nicolas.vuillamy@ox.security

LTI/Classes/LTI.uc

@@ -1,7 +1,7 @@
 class LTI extends Info
 	config(LTI);
 
-const LatestVersion = 1;
+const LatestVersion = 2;
 
 const CfgRemoveItems     = class'RemoveItems';
 const CfgOfficialWeapons = class'OfficialWeapons';
@@ -71,6 +71,8 @@ private function PreInit()
 		case `NO_CONFIG:
 			`Log_Info("Config created");
 
+		case 1:
+
 		case MaxInt:
 			`Log_Info("Config updated to version" @ LatestVersion);
 			break;
@@ -139,7 +141,13 @@ private function PostInit()
 		return;
 	}
 
-	Trader.static.ModifyTrader(KFGRI, RemoveItems, CfgRemoveItems.default.bAll, LogLevel);
+	Trader.static.ModifyTrader(
+		KFGRI,
+		RemoveItems,
+		CfgRemoveItems.default.bAll,
+		CfgRemoveItems.default.bHRG,
+		CfgRemoveItems.default.bDLC,
+		LogLevel);
 
 	ReadyToSync = true;
 
@@ -185,7 +193,9 @@ public function bool CreateRepInfo(Controller C)
 		Self,
 		LogLevel,
 		RemoveItems,
-		CfgRemoveItems.default.bAll);
+		CfgRemoveItems.default.bAll,
+		CfgRemoveItems.default.bHRG,
+		CfgRemoveItems.default.bDLC);
 
 	RepInfos.AddItem(RepInfo);
 

LTI/Classes/LTIMut.uc

@@ -35,7 +35,7 @@ public function AddMutator(Mutator Mut)
 	if (Mut == Self) return;
 
 	if (Mut.Class == Class)
-		Mut.Destroy();
+		LTIMut(Mut).SafeDestroy();
 	else
 		Super.AddMutator(Mut);
 }
@@ -56,5 +56,5 @@ public function NotifyLogout(Controller C)
 
 DefaultProperties
 {
-
+	GroupNames.Add("TraderItems")
 }

LTI/Classes/LTI_LocalMessage.uc

@@ -4,17 +4,14 @@ class LTI_LocalMessage extends Object
 var const             String SyncItemsDefault;
 var private localized String SyncItems;
 
-var const             String SyncFinishedDefault;
-var private localized String SyncFinished;
-
 var const             String WaitingGRIDefault;
 var private localized String WaitingGRI;
 
 var const             String IncompatibleGRIDefault;
 var private localized String IncompatibleGRI;
 
-var const             String DisconnectDefault;
+var const             String IncompatibleGRIWarningDefault;
-var private localized String Disconnect;
+var private localized String IncompatibleGRIWarning;
 
 var const             String SecondsShortDefault;
 var private localized String SecondsShort;
@@ -22,10 +19,9 @@ var private localized String SecondsShort;
 enum E_LTI_LocalMessageType
 {
 	LTI_SyncItems,
-	LTI_SyncFinished,
 	LTI_WaitingGRI,
 	LTI_IncompatibleGRI,
-	LTI_Disconnect,
+	LTI_IncompatibleGRIWarning,
 	LTI_SecondsShort
 };
 
@@ -43,17 +39,14 @@ public static function String GetLocalizedString(
 		case LTI_SyncItems:
 			return (default.SyncItems != "" ? default.SyncItems : default.SyncItemsDefault);
 
-		case LTI_SyncFinished:
-			return (default.SyncFinished != "" ? default.SyncFinished : default.SyncFinishedDefault);
-		
 		case LTI_WaitingGRI:
 			return (default.WaitingGRI != "" ? default.WaitingGRI : default.WaitingGRIDefault);
 
 		case LTI_IncompatibleGRI:
-			return (default.IncompatibleGRI != "" ? default.IncompatibleGRI : default.IncompatibleGRIDefault);
+			return (default.IncompatibleGRI != "" ? default.IncompatibleGRI : default.IncompatibleGRIDefault) @ String1;
 
-		case LTI_Disconnect:
+		case LTI_IncompatibleGRIWarning:
-			return (default.Disconnect != "" ? default.Disconnect : default.DisconnectDefault);
+			return (default.IncompatibleGRIWarning != "" ? default.IncompatibleGRIWarning : default.IncompatibleGRIWarningDefault);
 
 		case LTI_SecondsShort:
 			return (default.SecondsShort != "" ? default.SecondsShort : default.SecondsShortDefault);
@@ -64,10 +57,9 @@ public static function String GetLocalizedString(
 
 defaultproperties
 {
-	SyncItemsDefault       = "Sync items:"
+	SyncItemsDefault              = "Sync items:"
-	SyncFinishedDefault    = "Sync finished."
+	WaitingGRIDefault             = "Waiting GRI..."
-	WaitingGRIDefault      = "Waiting GRI..."
+	IncompatibleGRIDefault        = "Incompatible GRI:"
-	IncompatibleGRIDefault = "Incompatible GRI:"
+	IncompatibleGRIWarningDefault = "You can enter the game, but the trader may not work correctly.";
-	DisconnectDefault      = "Disconnect..."
+	SecondsShortDefault           = "s"
-	SecondsShortDefault    = "s"
 }

LTI/Classes/LTI_RepInfo.uc

@@ -9,6 +9,8 @@ var private LTI LTI;
 var private E_LogLevel LogLevel;
 var private Array<class<KFWeaponDefinition> > RemoveItems;
 var private bool ReplaceMode;
+var private bool RemoveHRG;
+var private bool RemoveDLC;
 
 var private int  Recieved;
 var private int  SyncSize;
@@ -23,11 +25,12 @@ var private String NotificationRightText;
 var private int    NotificationPercent;
 
 var private int    WaitingGRI;
+var private int    WaitingGRILimit;
 
 replication
 {
 	if (bNetInitial && Role == ROLE_Authority)
-		LogLevel, ReplaceMode, SyncSize;
+		LogLevel, ReplaceMode, RemoveHRG, RemoveDLC, SyncSize;
 }
 
 public simulated function bool SafeDestroy()
@@ -41,7 +44,9 @@ public function PrepareSync(
 	LTI _LTI,
 	E_LogLevel _LogLevel,
 	Array<class<KFWeaponDefinition> > _RemoveItems,
-	bool _ReplaceMode)
+	bool _ReplaceMode,
+	bool _RemoveHRG,
+	bool _RemoveDLC)
 {
 	`Log_Trace();
 
@@ -49,6 +54,8 @@ public function PrepareSync(
 	LogLevel            = _LogLevel;
 	RemoveItems         = _RemoveItems;
 	ReplaceMode         = _ReplaceMode;
+	RemoveHRG           = _RemoveHRG;
+	RemoveDLC           = _RemoveDLC;
 	SyncSize            = RemoveItems.Length;
 }
 
@@ -68,6 +75,39 @@ private simulated function KFPlayerController GetKFPC()
 	return KFPC;
 }
 
+public reliable client function WriteToChatLocalized(
+	E_LTI_LocalMessageType LMT,
+	optional String HexColor,
+	optional String String1,
+	optional String String2,
+	optional String String3)
+{
+	`Log_Trace();
+
+	WriteToChat(LocalMessage.static.GetLocalizedString(LogLevel, LMT, String1, String2, String3), HexColor);
+}
+
+public reliable client function WriteToChat(String Message, optional String HexColor)
+{
+	local KFGFxHudWrapper HUD;
+
+	`Log_Trace();
+
+	if (GetKFPC() == None) return;
+
+	if (KFPC.MyGFxManager.PartyWidget != None && KFPC.MyGFxManager.PartyWidget.PartyChatWidget != None)
+	{
+		KFPC.MyGFxManager.PartyWidget.PartyChatWidget.SetVisible(true);
+		KFPC.MyGFxManager.PartyWidget.PartyChatWidget.AddChatMessage(Message, HexColor);
+	}
+
+	HUD = KFGFxHudWrapper(KFPC.myHUD);
+	if (HUD != None && HUD.HUDMovie != None && HUD.HUDMovie.HudChatBox != None)
+	{
+		HUD.HUDMovie.HudChatBox.AddChatMessage(Message, HexColor);
+	}
+}
+
 private simulated function SetPartyInGameWidget()
 {
 	`Log_Trace();
@@ -183,47 +223,44 @@ private simulated reliable client function ClientSyncFinished()
 
 	`Log_Trace();
 
-	NotificationLeftText  = "";
+	if (WorldInfo.GRI == None && WaitingGRI++ < WaitingGRILimit)
-	NotificationRightText = "";
-	NotificationPercent   = 0;
-	
-	if (WorldInfo.GRI == None)
 	{
-		`Log_Debug("ClientSyncFinished: Waiting GRI");
+		`Log_Debug("ClientSyncFinished: Waiting GRI" @ WaitingGRI);
 		NotificationHeaderText = LocalMessage.static.GetLocalizedString(LogLevel, LTI_WaitingGRI);
-		NotificationLeftText   = String(++WaitingGRI) $ LocalMessage.static.GetLocalizedString(LogLevel, LTI_SecondsShort);
+		NotificationLeftText   = String(WaitingGRI) $ LocalMessage.static.GetLocalizedString(LogLevel, LTI_SecondsShort);
 		NotificationRightText  = "";
+		NotificationPercent    = 0;
 		SetTimer(1.0f, false, nameof(ClientSyncFinished));
 		return;
 	}
 
-	KFGRI = KFGameReplicationInfo(WorldInfo.GRI);
+	NotificationHeaderText = "";
-	if (KFGRI == None)
-	{
-		`Log_Fatal("Incompatible Replication info:" @ String(WorldInfo.GRI));
-		ClearTimer(nameof(KeepNotification));
-		UpdateNotification(
-			LocalMessage.static.GetLocalizedString(LogLevel, LTI_IncompatibleGRI) @ String(WorldInfo.GRI),
-			LocalMessage.static.GetLocalizedString(LogLevel, LTI_Disconnect), "", 0);
-		Cleanup();
-		ConsoleCommand("Disconnect");
-		SafeDestroy();
-		return;
-	}
-	
-	NotificationHeaderText = LocalMessage.static.GetLocalizedString(LogLevel, LTI_SyncFinished);
 	NotificationLeftText   = "";
 	NotificationRightText  = "";
 	NotificationPercent    = 0;
 
-	Trader.static.ModifyTrader(KFGRI, RemoveItems, ReplaceMode, LogLevel);
+	KFGRI = KFGameReplicationInfo(WorldInfo.GRI);
-	`Log_Debug("ClientSyncFinished: Trader.static.ModifyTrader");
+	if (KFGRI != None)
+	{
+		`Log_Debug("ClientSyncFinished: Trader.static.ModifyTrader");
+		Trader.static.ModifyTrader(KFGRI, RemoveItems, ReplaceMode, RemoveHRG, RemoveDLC, LogLevel);
+	}
+	else
+	{
+		`Log_Error("Incompatible Replication info:" @ String(WorldInfo.GRI));
+		WriteToChatLocalized(
+			LTI_IncompatibleGRI,
+			class'KFLocalMessage'.default.InteractionColor,
+			WorldInfo.GRI == None ? "None" : String(WorldInfo.GRI.class));
+		WriteToChatLocalized(
+			LTI_IncompatibleGRIWarning,
+			class'KFLocalMessage'.default.InteractionColor);
+	}
 
 	ClearTimer(nameof(KeepNotification));
 	ShowReadyButton();
 
 	Cleanup();
-	
 	SafeDestroy();
 }
 
@@ -273,4 +310,5 @@ defaultproperties
 
 	NotificationPercent    = 0
 	WaitingGRI             = 0
+	WaitingGRILimit        = 15
 }

LTI/Classes/RemoveItems.uc

@@ -3,6 +3,8 @@ class RemoveItems extends Object
 	config(LTI);
 
 var public  config bool bAll;
+var public  config bool bHRG;
+var public  config bool bDLC;
 var private config Array<String> Item;
 
 public static function InitConfig(int Version, int LatestVersion)
@@ -12,6 +14,10 @@ public static function InitConfig(int Version, int LatestVersion)
 		case `NO_CONFIG:
 			ApplyDefault();
 
+		case 1:
+			default.bHRG = false;
+			default.bDLC = false;
+
 		default: break;
 	}
 
@@ -24,6 +30,8 @@ public static function InitConfig(int Version, int LatestVersion)
 private static function ApplyDefault()
 {
 	default.bAll = false;
+	default.bHRG = false;
+	default.bDLC = false;
 	default.Item.Length = 0;
 	default.Item.AddItem("KFGame.KFWeapDef_9mmDual");
 }
@@ -43,6 +51,15 @@ public static function Array<class<KFWeaponDefinition> > Load(E_LogLevel LogLeve
 	}
 	else
 	{
+		if (default.bHRG)
+		{
+			`Log_Info("Remove all HRG items");
+		}
+		if (default.bDLC)
+		{
+			`Log_Info("Remove all DLC items");
+		}
+
 		foreach default.Item(ItemRaw, Line)
 		{
 			ItemWeapDef = class<KFWeaponDefinition>(DynamicLoadObject(ItemRaw, class'Class'));

LTI/Classes/Trader.uc

@@ -69,6 +69,8 @@ public static simulated function ModifyTrader(
 	KFGameReplicationInfo KFGRI,
 	Array<class<KFWeaponDefinition> > RemoveItems,
 	bool ReplaceMode,
+	bool RemoveHRG,
+	bool RemoveDLC,
 	E_LogLevel LogLevel)
 {
 	local KFGFxObject_TraderItems TraderItems;
@@ -86,7 +88,9 @@ public static simulated function ModifyTrader(
 		foreach TraderItems.SaleItems(Item)
 		{
 			if (Item.WeaponDef != None
-			&& RemoveItems.Find(Item.WeaponDef) == INDEX_NONE)
+			&& RemoveItems.Find(Item.WeaponDef) == INDEX_NONE
+			&& (!RemoveHRG || (RemoveHRG && InStr(Item.WeaponDef, "_HRG", true) == INDEX_NONE))
+			&& (!RemoveDLC || (RemoveDLC && Item.WeaponDef.default.SharedUnlockId == SCU_None)))
 			{
 				WeapDefs.AddItem(Item.WeaponDef);
 			}

PublicationContent/description.txt

@@ -11,16 +11,16 @@ This is a heavily stripped-down version of [url=https://steamcommunity.com/share
 If we're lucky with that then server operators will have more tools to fine-tune the server.
 
 [h1]Whitelisted?[/h1]
-No. But I really hope that it will be whitelisted.
+[b]No.[/b] But I really hope that it will be whitelisted.
 
 [b]⚠️ I submitted whitelist request here:[/b]
-https://forums.tripwireinteractive.com/index.php?threads/whitelisting-mods-and-mutators.120340/
+https://forums.tripwireinteractive.com/index.php?threads/whitelisting-mods-and-mutators.120340/post-2353665
 
 [h1]Usage (single player)[/h1]
 [olist]
 [*]Subscribe to this mutator;
 [*]Start KF2;
-[*]Open console (`) and input:
+[*]Open console (~) and input:
 [b]open KF-BioticsLab?Mutator=LTI.LTIMut[/b]
 (replace the map and add the parameters you need)
 [*]<Enter>.
@@ -38,21 +38,27 @@ https://forums.tripwireinteractive.com/index.php?threads/whitelisting-mods-and-m
 [*]Add mutator to server start parameters: [b]?Mutator=LTI.LTIMut[/b] and restart the server.
 [/olist]
 
+[h1]Important setup information[/h1]
+The config should be created on first start, but now the game contains a bug that initializes the config values ​​randomly if they are not explicitly set. Thus, the config may have incorrect values ​​or not be created at all.
+So if you are using this mutator for the first time, I highly recommend doing the following:
+[olist]
+[*]Create (modify) [b]KFLTI.ini[/b] manually. Put the following content there:
+[b][LTI.LTI]
+Version=0[/b]
+[*]Start the game/server with LTI to generate the contents of the config
+[*]Close the game/server
+[/olist]
+[b]Right now this is the only way to correctly create the default config.[/b]
+Unfortunately I can't do anything about it because it's a game problem (not mutator). I hope TWI fixes this someday.
+
 [h1]Setup (KFLTI.ini)[/h1]
-Config will be created at the first start[b]*[/b].
 [list]
 [*]Set [b]bOfficialWeaponsList=True[/b] to have an auto-updated list of all official weapons in the config (for a convenient copy-paste).
 [*]Use [b][LTI.RemoveItems][/b] to remove items from the trader inventory.
 example: [b]Item=KFGame.KFWeapDef_Mac10[/b] will remove MAC10 from sale.
+[*]Set [b]bHRG=True[/b] to remove HRG items.
+[*]Set [b]bDLC=True[/b] to remove DLC items.
 [/list]
 
-[h1]Troubleshooting[/h1]
-[b](*)[/b] If your config is not created for some reason, create it manually with the following content:
-[b][LTI.LTI]
-Version=0
-[/b]
-
-Then start the server and check the file again - config content should be generated.
-
 [h1]Sources[/h1]
 [url=https://github.com/GenZmeY/KF2-LootedTraderInventory]https://github.com/GenZmeY/KF2-LootedTraderInventory[/url] [b](GNU GPLv3)[/b]

README.md

@@ -3,17 +3,17 @@
 [![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=2864857909)
 [![Steam Downloads](https://img.shields.io/steam/downloads/2864857909)](https://steamcommunity.com/sharedfiles/filedetails/?id=2864857909)
 [![Steam Favorites](https://img.shields.io/steam/favorites/2864857909)](https://steamcommunity.com/sharedfiles/filedetails/?id=2864857909)
-[![Steam Update Date](https://img.shields.io/steam/update-date/2864857909)](https://steamcommunity.com/sharedfiles/filedetails/?id=2864857909)
+[![MegaLinter](https://github.com/GenZmeY/KF2-LootedTraderInventory/actions/workflows/mega-linter.yml/badge.svg?branch=master)](https://github.com/GenZmeY/KF2-LootedTraderInventory/actions/workflows/mega-linter.yml)
 [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-LootedTraderInventory)](https://github.com/GenZmeY/KF2-LootedTraderInventory/tags)
 [![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-LootedTraderInventory)](LICENSE)
 
-# Description
+## Description
 This is a heavily stripped down version of [CTI](https://github.com/GenZmeY/KF2-CustomTraderInventory) that only allows you to remove the trader's weapons, not add them. This only exists in hopes of being whitelisted.  
 
-# Usage & Setup
+## Usage & Setup
 [See steam workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2864857909)
 
-# Build
+## 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:  
@@ -27,5 +27,5 @@ This is a heavily stripped down version of [CTI](https://github.com/GenZmeY/KF2-
 5. The compiled files will be here:  
 `C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\`
 
-# License
+## License
-[GNU GPLv3](LICENSE)  
+[![license](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](LICENSE)