update description.txt

add short alias for mutator

.editorconfig

@@ -22,6 +22,7 @@ charset = utf-16le
 
 # Other
 [*.md]
+indent_style = space
 trim_trailing_whitespace = false
 
 [*.yml]

.github/workflows/mega-linter.yml

@@ -6,12 +6,14 @@ permissions: read-all
 on:
   push:
   pull_request:
-    branches: [master]
+    branches:
+      - master
 
 env:
   APPLY_FIXES: none
   APPLY_FIXES_EVENT: pull_request
   APPLY_FIXES_MODE: commit
+  FILTER_REGEX_EXCLUDE: (mega-linter.yml)
   DISABLE: SPELL
 
 concurrency:
@@ -19,54 +21,94 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build:
+  megalinter:
     name: MegaLinter
     runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
         with:
           token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
 
       - name: MegaLinter
+        uses: oxsecurity/megalinter@7e042c726c68415475b05a65a686c612120a1232
         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@c7d193f32edcb7bfad88892161225aeda64e9392
-        uses: actions/upload-artifact@v3
+        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: 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)
+        if: env.APPLY_FIXES_IF_PR == 'true'
-        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)
+        if: env.APPLY_FIXES_IF_PR == 'true'
         run: |
-          echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
+          echo "PR Number - ${{ steps.cpr.outputs.pull-request-number }}"
-          echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
+          echo "PR 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)
+        if: env.APPLY_FIXES_IF_COMMIT == 'true'
         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@8756aa072ef5b4a080af5dc8fef36c5d586e521d
-        uses: stefanzweifel/git-auto-commit-action@v4
+        if: env.APPLY_FIXES_IF_COMMIT == 'true'
         with:
-          branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
+          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_name: "github-actions"
-          commit_user_email: nicolas.vuillamy@ox.security
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"

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)
-		AALMut(Mut).SafeDestroy();
-	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,52 +1,53 @@
 [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]
+[h1]📋 Description[/h1]
 Small server-side mutator that allows specified players to automatically login as an admin.
 
-[h1]Whitelisted?[/h1]
+[h1]❌ Whitelisted?[/h1]
-[b]No.[/b] But I really hope that it will be whitelisted.
+No. This mod is not whitelisted and will de-rank your server. Any XP earned will not be saved.
 
-[b]⚠️ I submitted whitelist request here:[/b]
+But I hope that it will be whitelisted - I submitted whitelist request here:
 https://forums.tripwireinteractive.com/index.php?threads/whitelisting-mods-and-mutators.120340/post-2353666
 
-[h1]Usage (server)[/h1]
+[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]
+[b]Note:[/b] [i]If this is unclear, first read: [url=https://wiki.killingfloor2.com/index.php?title=Dedicated_Server_(Killing_Floor_2)][u]Dedicated Server Guide (KF2 wiki)[/u][/url][/i]
 [olist]
-[*]Open your [b]PCServer-KFEngine.ini[/b] / [b]LinuxServer-KFEngine.ini[/b];
+[*]Open [b]PCServer-KFEngine.ini[/b] / [b]LinuxServer-KFEngine.ini[/b].
-[*]Find the [b][IpDrv.TcpNetDriver][/b] section and make sure that there is a line (add if not):
+[*]Find [b][IpDrv.TcpNetDriver][/b] section and ensure line exists (add if missing):
-[b]DownloadManagers=OnlineSubsystemSteamworks.SteamWorkshopDownload[/b]
+[code]DownloadManagers=OnlineSubsystemSteamworks.SteamWorkshopDownload[/code]
-❗️ If there are several [b]DownloadManagers=[/b] then the line above should be the first ❗️
+(If there are several [b]DownloadManagers[/b] then the line above should be the first)
 [*]Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section (create one if it doesn't exist):
-[b]ServerSubscribedWorkshopItems=2848836389[/b]
+[code]ServerSubscribedWorkshopItems=2848836389[/code]
-[*]Start the server and wait until the mutator is downloading;
+[*]Start server and wait for mutator download.
-[*]Add mutator to server start parameters: [b]?Mutator=AAL.AALMut[/b] and restart the server.
+[*]When the download is complete, stop the server.
+[*]Create a file [b](*)[/b]: [code]<kf2-server>\KFGame\Config\KFAAL.ini[/code]
+with content:
+[code][AAL.AAL]
+Version=0[/code]
+[*]Add mutator to server start parameters: [code]?Mutator=AAL.Mut[/code] and start the server (this will generate the default KFAAL.ini content).
+[*]Stop the server and configure the mutator (see [b]⚙️ Setup (KFAAL.ini)[/b] below).
+[*]Start the server.
 [/olist]
 
-[h1]Important setup information[/h1]
+[h1]🐞 (*) Buggy config initialization[/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.
+This mutator (like many others) relies on UnrealScript's default values (0 for int type) to detect first-time use and generate a config.
-So if you are using this mutator for the first time, I highly recommend doing the following:
+However, the game contains a bug that initializes unset values to random data, which can lead to incorrect settings or missing configs.
-[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]
+As a workaround, I recommend explicitly setting [b]Version=0[/b] in the config during the first initialization.
+
+Unfortunately, I can't fix this issue because it's a game engine problem (not the mutator's fault).
+
+[h1]⚙️ Setup (KFAAL.ini)[/h1]
 [list]
-[*]Use [b]AdminId[/b] to set the list of admins. You can use UniqueID or SteamID;
+[*]Use [b]AdminId[/b] to set the list of admins, you can use UniqueID or SteamID. The default config contains example UniqueID and SteamID entries - replace them with the values ​​you need or delete them, but don’t leave it as is.
 [*]Set [b]bAutoEnableCheats=True[/b] to automatically enable cheats for admins.
 [/list]
 
-[h1]Getting ID[/h1]
+[h1]🔎 Getting IDs[/h1]
 You can view the Steam ID and UniqueID in WebAdmin on the PLAYERS tab:
 [img]https://raw.githubusercontent.com/GenZmeY/KF2-AdminAutoLogin/master/PublicationContent/ID1.png[/img]
 
-But don't try to use the SteamID from here for EGS players - it won't work. SteamID is for Steam players only.
+But don't try to use the SteamID from here for EGS players - it won't work. SteamID is for Steam players only. UniqueID is suitable for all platforms.
-UniqueID is suitable for all platforms.
 
 SteamID can also be obtained from the player's profile, look at the URL:
 [img]https://raw.githubusercontent.com/GenZmeY/KF2-AdminAutoLogin/master/PublicationContent/ID2.png[/img]
@@ -54,5 +55,14 @@ 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]Sources[/h1]
+[h1]🌍 Credits[/h1]
-[url=https://github.com/GenZmeY/KF2-AdminAutoLogin]https://github.com/GenZmeY/KF2-AdminAutoLogin[/url] [b](GNU GPLv3)[/b]
+[list]
+[*]The cat on the cover is Meawbin (original character by [url=https://x.com/horrormove]Cotton Valent[/url]).
+[/list]
+
+[h1]☑️ Status: Completed[/h1]
+✔️ The mutator works with the current version of the game (v1150) and I have implemented everything I planned.
+⛔️ Development has stopped: I no longer have the time or motivation to maintain this mod. No further updates or bug fixes are planned.
+
+[h1]📜 Sources[/h1]
+https://github.com/GenZmeY/KF2-AdminAutoLogin [b](GNU GPLv3)[/b]