From 9e2084feb52593669cb02495e1668f7c11b1feb7 Mon Sep 17 00:00:00 2001 From: GenZmeY Date: Thu, 10 Apr 2025 17:34:21 +0300 Subject: [PATCH] update description.txt --- PublicationContent/description.txt | 74 +++++++++++++++++------------- 1 file changed, 42 insertions(+), 32 deletions(-) diff --git a/PublicationContent/description.txt b/PublicationContent/description.txt index 26c51f5..fc722ed 100644 --- a/PublicationContent/description.txt +++ b/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] -[b]No.[/b] But I really hope that it will be whitelisted. +[h1]โŒ Whitelisted?[/h1] +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] -[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] +[h1]๐Ÿ–ฅ๏ธ Usage (server)[/h1] +[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]; -[*]Find the [b][IpDrv.TcpNetDriver][/b] section and make sure that there is a line (add if not): -[b]DownloadManagers=OnlineSubsystemSteamworks.SteamWorkshopDownload[/b] -โ—๏ธ If there are several [b]DownloadManagers=[/b] then the line above should be the first โ—๏ธ +[*]Open [b]PCServer-KFEngine.ini[/b] / [b]LinuxServer-KFEngine.ini[/b]. +[*]Find [b][IpDrv.TcpNetDriver][/b] section and ensure line exists (add if missing): +[code]DownloadManagers=OnlineSubsystemSteamworks.SteamWorkshopDownload[/code] +(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] -[*]Start the server and wait until the mutator is downloading; -[*]Add mutator to server start parameters: [b]?Mutator=AAL.Mut[/b] and restart the server. +[code]ServerSubscribedWorkshopItems=2848836389[/code] +[*]Start server and wait for mutator download. +[*]When the download is complete, stop the server. +[*]Create a file [b](*)[/b]: [code]\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). +[*]Close the server and configure the mutator (see [b]โš™๏ธ Setup (KFAAL.ini)[/b] below). +[*]Start the server again. [/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]๐Ÿž (*) Buggy config initialization[/h1] +This mutator (like many others) relies on UnrealScript's default values (0 for int type) to detect first-time use and generate a config. +However, the game contains a bug that initializes unset values to random data, which can lead to incorrect settings or missing configs. -[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. -UniqueID is suitable for all platforms. +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. 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] -[url=https://github.com/GenZmeY/KF2-AdminAutoLogin]https://github.com/GenZmeY/KF2-AdminAutoLogin[/url] [b](GNU GPLv3)[/b] \ No newline at end of file +[h1]๐ŸŒ Credits[/h1] +[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] \ No newline at end of file