Merge pull request #3 from GenZmeY/short-name

add short alias for mutator

.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,114 @@
+---
+name: MegaLinter
+
+permissions: read-all
+
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+
+env:
+  APPLY_FIXES: none
+  APPLY_FIXES_EVENT: pull_request
+  APPLY_FIXES_MODE: commit
+  FILTER_REGEX_EXCLUDE: (mega-linter.yml)
+  DISABLE: SPELL
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: MegaLinter
+        uses: oxsecurity/megalinter@7e042c726c68415475b05a65a686c612120a1232
+        id: ml
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Archive production artifacts
+        uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392
+        if: success() || failure()
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log
+
+      - name: Set APPLY_FIXES_IF var
+        run: |
+          printf 'APPLY_FIXES_IF=%s\n' "${{
+            steps.ml.outputs.has_updated_sources == 1 &&
+            (
+              env.APPLY_FIXES_EVENT == 'all' ||
+              env.APPLY_FIXES_EVENT == github.event_name
+            ) &&
+            (
+              github.event_name == 'push' ||
+              github.event.pull_request.head.repo.full_name == github.repository
+            )
+          }}" >> "${GITHUB_ENV}"
+
+      - name: Set APPLY_FIXES_IF_* vars
+        run: |
+          printf 'APPLY_FIXES_IF_PR=%s\n' "${{
+            env.APPLY_FIXES_IF == 'true' &&
+            env.APPLY_FIXES_MODE == 'pull_request'
+          }}" >> "${GITHUB_ENV}"
+          printf 'APPLY_FIXES_IF_COMMIT=%s\n' "${{
+            env.APPLY_FIXES_IF == 'true' &&
+            env.APPLY_FIXES_MODE == 'commit' &&
+            (!contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref))
+          }}" >> "${GITHUB_ENV}"
+
+      - name: Create Pull Request with applied fixes
+        uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38
+        id: cpr
+        if: env.APPLY_FIXES_IF_PR == 'true'
+        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: env.APPLY_FIXES_IF_PR == 'true'
+        run: |
+          echo "PR Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "PR URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+      - name: Prepare commit
+        if: env.APPLY_FIXES_IF_COMMIT == 'true'
+        run: sudo chown -Rc $UID .git/
+
+      - name: Commit and push applied linter fixes
+        uses: stefanzweifel/git-auto-commit-action@8756aa072ef5b4a080af5dc8fef36c5d586e521d
+        if: env.APPLY_FIXES_IF_COMMIT == 'true'
+        with:
+          branch: >-
+            ${{
+              github.event.pull_request.head.ref ||
+              github.head_ref ||
+              github.ref
+            }}
+          commit_message: "[MegaLinter] Apply linters fixes"
+          commit_user_name: "github-actions"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"

AAL/Classes/AAL.uc

@@ -1,15 +1,19 @@
 class AAL extends Info
 	config(AAL);
 
-const LatestVersion = 1;
+const LatestVersion = 2;
+
+const ProfileURL = "https://steamcommunity.com/profiles/";
 
 const CfgAdminList = class'AdminList';
 
 var private config int         Version;
 var private config E_LogLevel  LogLevel;
+var private config bool        bAutoEnableCheats;
 
 var private OnlineSubsystem    OS;
 var private Array<UniqueNetId> AdminUIDList;
+var private Array<UniqueNetId> AdminUIDListActive;
 
 public simulated function bool SafeDestroy()
 {
@@ -62,6 +66,9 @@ private function PreInit()
 		case `NO_CONFIG:
 			`Log_Info("Config created");
 
+		case 1:
+			bAutoEnableCheats = false;
+
 		case MaxInt:
 			`Log_Info("Config updated to version" @ LatestVersion);
 			break;
@@ -116,7 +123,6 @@ public function NotifyLogin(Controller C)
 	local PlayerReplicationInfo PRI;
 	local String UniqueID;
 	local String SteamID;
-	local String Profile;
 
 	`Log_Trace();
 
@@ -127,16 +133,25 @@ public function NotifyLogin(Controller C)
 	if (AdminUIDList.Find('Uid', PRI.UniqueId.Uid) != INDEX_NONE)
 	{
 		PRI.bAdmin = true;
+	}
+
+	if (PRI.bAdmin)
+	{
+		AdminUIDListActive.AddItem(PRI.UniqueId);
 
 		UniqueID = OS.UniqueNetIdToString(PRI.UniqueId);
 
 		PC = PlayerController(C);
+
+		if (PC != None && bAutoEnableCheats)
+		{
+			PC.AddCheats(true);
+		}
+
 		if (PC != None && !PC.bIsEosPlayer)
 		{
 			SteamID = OS.UniqueNetIdToInt64(PRI.UniqueId);
-			Profile = "https://steamcommunity.com/profiles/" $ SteamID;
+			`Log_Info("Admin login:" @ PRI.PlayerName @ "(" $ UniqueID $ "," @ SteamID $ "," @ ProfileURL $ SteamID $ ")");
-			
-			`Log_Info("Admin login:" @ PRI.PlayerName @ "(" $ UniqueID $ "," @ SteamID $ "," @ Profile $ ")");
 		}
 		else
 		{
@@ -147,7 +162,23 @@ public function NotifyLogin(Controller C)
 
 public function NotifyLogout(Controller C)
 {
+	local PlayerReplicationInfo PRI;
+	local String UniqueID;
+	local String SteamID;
+
 	`Log_Trace();
+
+	if (C == None || C.PlayerReplicationInfo == None) return;
+
+	PRI = C.PlayerReplicationInfo;
+
+	if (PRI.bAdmin || AdminUIDListActive.Find('Uid', PRI.UniqueId.Uid) != INDEX_NONE)
+	{
+		AdminUIDListActive.RemoveItem(PRI.UniqueId);
+		UniqueID = OS.UniqueNetIdToString(PRI.UniqueId);
+		SteamID = OS.UniqueNetIdToInt64(PRI.UniqueId);
+		`Log_Info("Admin logout:" @ PRI.PlayerName @ "(" $ UniqueID $ "," @ SteamID $ "," @ ProfileURL $ SteamID $ ")");
+	}
 }
 
 defaultproperties

AAL/Classes/AALMut.uc

@@ -1,60 +1 @@
-class AALMut extends KFMutator;
+class AALMut extends Mut; // backward compatibility
-
-var private AAL AAL;
-
-public simulated function bool SafeDestroy()
-{
-	return (bPendingDelete || bDeleteMe || Destroy());
-}
-
-public event PreBeginPlay()
-{
-	Super.PreBeginPlay();
-	
-	if (WorldInfo.NetMode == NM_Client) return;
-	
-	foreach WorldInfo.DynamicActors(class'AAL', AAL)
-	{
-		break;
-	}
-	
-	if (AAL == None)
-	{
-		AAL = WorldInfo.Spawn(class'AAL');
-	}
-	
-	if (AAL == None)
-	{
-		`Log_Base("FATAL: Can't Spawn 'AAL'");
-		SafeDestroy();
-	}
-}
-
-public function AddMutator(Mutator Mut)
-{
-	if (Mut == Self) return;
-	
-	if (Mut.Class == Class)
-		Mut.Destroy();
-	else
-		Super.AddMutator(Mut);
-}
-
-public function NotifyLogin(Controller C)
-{
-	AAL.NotifyLogin(C);
-	
-	Super.NotifyLogin(C);
-}
-
-public function NotifyLogout(Controller C)
-{
-	AAL.NotifyLogout(C);
-	
-	Super.NotifyLogout(C);
-}
-
-defaultproperties
-{
-
-}

AAL/Classes/Mut.uc

@@ -0,0 +1,60 @@
+class Mut extends KFMutator;
+
+var private AAL AAL;
+
+public simulated function bool SafeDestroy()
+{
+	return (bPendingDelete || bDeleteMe || Destroy());
+}
+
+public event PreBeginPlay()
+{
+	Super.PreBeginPlay();
+
+	if (WorldInfo.NetMode == NM_Client) return;
+
+	foreach WorldInfo.DynamicActors(class'AAL', AAL)
+	{
+		break;
+	}
+
+	if (AAL == None)
+	{
+		AAL = WorldInfo.Spawn(class'AAL');
+	}
+
+	if (AAL == None)
+	{
+		`Log_Base("FATAL: Can't Spawn 'AAL'");
+		SafeDestroy();
+	}
+}
+
+public function AddMutator(Mutator M)
+{
+	if (M == Self) return;
+
+	if (M.Class == Class)
+		Mut(M).SafeDestroy();
+	else
+		Super.AddMutator(M);
+}
+
+public function NotifyLogin(Controller C)
+{
+	AAL.NotifyLogin(C);
+
+	Super.NotifyLogin(C);
+}
+
+public function NotifyLogout(Controller C)
+{
+	AAL.NotifyLogout(C);
+
+	Super.NotifyLogout(C);
+}
+
+defaultproperties
+{
+
+}

PublicationContent/description.txt

@@ -1,10 +1,13 @@
-[img]https://img.shields.io/static/v1?logo=GitHub&labelColor=gray&color=blue&logoColor=white&label=&message=Open Source[/img] [img]https://img.shields.io/github/license/GenZmeY/KF2-AdminAutoLogin[/img] [img]https://img.shields.io/steam/favorites/2848836389[/img] [img]https://img.shields.io/steam/update-date/2848836389[/img] [url=https://steamcommunity.com/sharedfiles/filedetails/changelog/2848836389][img]https://img.shields.io/github/v/tag/GenZmeY/KF2-AdminAutoLogin[/img][/url]
+[img]https://img.shields.io/static/v1?logo=GitHub&labelColor=gray&color=blue&logoColor=white&label=&message=Open Source[/img] [img]https://img.shields.io/github/license/GenZmeY/KF2-AdminAutoLogin[/img] [img]https://img.shields.io/steam/downloads/2848836389[/img] [img]https://img.shields.io/steam/favorites/2848836389[/img] [img]https://img.shields.io/steam/update-date/2848836389[/img] [url=https://steamcommunity.com/sharedfiles/filedetails/changelog/2848836389][img]https://img.shields.io/github/v/tag/GenZmeY/KF2-AdminAutoLogin[/img][/url]
 
 [h1]Description[/h1]
 Small server-side mutator that allows specified players to automatically login as an admin.
 
 [h1]Whitelisted?[/h1]
-No. This mod is not whitelisted and will de-rank your server. Any XP gained will not be saved.
+[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/post-2353666
 
 [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]
@@ -16,13 +19,26 @@ No. This mod is not whitelisted and will de-rank your server. Any XP gained will
 [*]Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section (create one if it doesn't exist):
 [b]ServerSubscribedWorkshopItems=2848836389[/b]
 [*]Start the server and wait until the mutator is downloading;
-[*]Add mutator to server start parameters: [b]?Mutator=AAL.AALMut[/b] and restart the server.
+[*]Add mutator to server start parameters: [b]?Mutator=AAL.Mut[/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]KFAAL.ini[/b] manually. Put the following content there:
+[b][AAL.AAL]
+Version=0[/b]
+[*]Start the game/server with AAL 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 (KFAAL.ini)[/h1]
-Config will be created at the first start[b]*[/b].
 [list]
 [*]Use [b]AdminId[/b] to set the list of admins. You can use UniqueID or SteamID;
+[*]Set [b]bAutoEnableCheats=True[/b] to automatically enable cheats for admins.
 [/list]
 
 [h1]Getting ID[/h1]
@@ -38,13 +54,5 @@ SteamID can also be obtained from the player's profile, look at the URL:
 If a player uses a nickname in a link to their profile, then add this to the profile url: [b]?xml=1[/b]
 [img]https://raw.githubusercontent.com/GenZmeY/KF2-AdminAutoLogin/master/PublicationContent/ID3.png[/img]
 
-[h1]Troubleshooting[/h1]
-[b](*)[/b] If your config is not created for some reason, create it manually with the following content:
-[b][AAL.AAL]
-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-AdminAutoLogin]https://github.com/GenZmeY/KF2-AdminAutoLogin[/url] [b](GNU GPLv3)[/b]

README.md

@@ -1,18 +1,19 @@
 # Admin Auto Login
 
 [![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=2848836389)
+[![Steam Downloads](https://img.shields.io/steam/downloads/2848836389)](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389)
 [![Steam Favorites](https://img.shields.io/steam/favorites/2848836389)](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389)
-[![Steam Update Date](https://img.shields.io/steam/update-date/2848836389)](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389)
+[![MegaLinter](https://github.com/GenZmeY/KF2-AdminAutoLogin/actions/workflows/mega-linter.yml/badge.svg?branch=master)](https://github.com/GenZmeY/KF2-AdminAutoLogin/actions/workflows/mega-linter.yml)
 [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-AdminAutoLogin)](https://github.com/GenZmeY/KF2-AdminAutoLogin/tags)
 [![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-AdminAutoLogin)](LICENSE)
 
-# Description
+## Description
 Small server-side mutator that allows specified players to automatically login as an admin.
 
-# Usage & Setup
+## Usage & Setup
 [See steam workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2848836389)
 
-# 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:  
@@ -26,9 +27,9 @@ Small server-side mutator that allows specified players to automatically login a
 5. The compiled files will be here:  
 `C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\`
 
-# Bug reports
+## Bug reports
 If you find a bug, go to the [issue page](https://github.com/GenZmeY/KF2-AdminAutoLogin/issues) and check if there is a description of your bug. If not, create a new issue.  
 Describe what the bug looks like and how reproduce it.  
 
-# License
+## License
-[GNU GPLv3](LICENSE)  
+[![license](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](LICENSE)

tools

@@ -1 +1 @@
-Subproject commit 88b35bd7ebb7e30448579f1564220398f990541c
+Subproject commit fb458ac61f7e6c6426b8dff366dd5e7499e0d95f