update publication content

PublicationContent/description.txt

@@ -1,19 +1,9 @@
-[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-YetAnotherScoreboard[/img] [img]https://img.shields.io/steam/subscriptions/2521826524[/img] [img]https://img.shields.io/steam/favorites/2521826524[/img] [img]https://img.shields.io/steam/update-date/2521826524[/img] [url=https://steamcommunity.com/sharedfiles/filedetails/changelog/2521826524][img]https://img.shields.io/github/v/tag/GenZmeY/KF2-YetAnotherScoreboard[/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-YetAnotherScoreboard[/img] [img]https://img.shields.io/steam/downloads/2521826524[/img] [img]https://img.shields.io/steam/favorites/2521826524[/img] [img]https://img.shields.io/steam/update-date/2521826524[/img] [url=https://steamcommunity.com/sharedfiles/filedetails/changelog/2521826524][img]https://img.shields.io/github/v/tag/GenZmeY/KF2-YetAnotherScoreboard[/img][/url]
 
 [h1]Description[/h1]
 Yet another scoreboard...
 Based on the scoreboard from [url=https://steamcommunity.com/sharedfiles/filedetails/?id=1963099942]ClassicHUD[/url] and heavily modified. 
 
-[h1]Features[/h1]
-- Doesn't block the view with the mouse when active;
-- Correctly displayed in all available resolutions;
-- Close to KF2 interface style;
-- Displays a large number of players;
-- The scoreboard adjusts to the size of the content;
-- Customizing the appearance and elements of the scoreboard;
-- Dynamically changing colors for some elements (depending on their value);
-- Player ranks.
-
 [h1]Whitelisted?[/h1]
 No. This mod is not whitelisted and will de-rank your server. Any XP gained will not be saved.
 
@@ -36,23 +26,83 @@ No. This mod is not whitelisted and will de-rank your server. Any XP gained will
 ❗️ 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=2521826524[/b]
-[*]Start the server and wait while the mutator is downloading;
+[*]Start the server and wait until the mutator is downloading;
 [*]Add mutator to server start parameters: [b]?Mutator=YAS.YASMut[/b] and restart the server.
 [/olist]
 
-[h1]Setup[/h1]
+[h1]Setup (KFYAS.ini)[/h1]
-All settings are here: 
+Config will be created at the first start[b]*[/b].
-[code]
-/KFGame/Config/KFYAS.ini
-[/code]
-I will add detailed instructions for setting up the scoreboard later.
-But these images will help you a little anyway:
-[url=https://raw.githubusercontent.com/GenZmeY/KF2-YetAnotherScoreboard/master/PublicationContent/elements.png]Elements[/url]
-[url=https://raw.githubusercontent.com/GenZmeY/KF2-YetAnotherScoreboard/master/PublicationContent/rect_shapes.png]Rectangle shape codes[/url]
 
-[h1]Bug reports[/h1]
+[b][YAS.MessageOfTheDay][/b]
-If you find a bug, describe what it looks like and how to repeat it - I will try to fix it. 
+In this section you can customize the messages that will be shown at the bottom of the panel.
-You can do it right here, but I'll be much happier if you do it [url=https://github.com/GenZmeY/KF2-YetAnotherScoreboard/issues]in issues on github[/url].
+[list]
+[*][b]bRandomize[/b] - If True the message will be chosen randomly;
+[*][b]DisplayTime[/b] - message display time in seconds;
+[*][b]Message[/b] - Array of messages to display. Place multiple "Message=" below each other if you want to specify multiple messages. If you need a line break in a message, use '[b]\n[/b]'.
+[/list]
+
+[b][YAS.Ranks][/b]
+here you can set display settings for different player ranks.
+
+Edit [b]Player[/b] and [b]Admin[/b] lines to set how this is displayed:
+[list]
+[*][b]RankName[/b] - rank name. Leave blank if you don't want this to be shown.
+[*][b]RankColor[/b] - rank display color.
+[*][b]PlayerColor[/b] - player name display color of the player with this rank.
+[/list]
+
+Use [b]Rank[/b] array to set your own ranks:
+[list]
+[*][b]RankName[/b] - same as above.
+[*][b]RankColor[/b] - same as above.
+[*][b]PlayerColor[/b] - same as above.
+[*][b]RankID[/b] - used to establish a relation between a player and his rank (more on that below), you can use any value greater than zero.
+[*][b]OverrideAdmin[/b] - If True then this rank will be displayed even if the player is an admin.
+[/list]
+
+[b][YAS.RankRelations][/b]
+Use [b]Relation[/b] array to establish a relation between a player and their rank:
+[list]
+[*][b]RankID[/b] - RankID from the [b][YAS.Ranks][/b] section.
+[*][b]ObjectID[/b] - ID for which this rank will be applied. This can be a player's SteamID64, a player's UniqueID, or a steam group's SteamID64 (then the rank will be applied to all members of that group).
+[/list]
+
+[b]Ranks priority[/b]
+[list]
+[*]Personal ranks are higher in priority than group ranks, so if a player belongs to both the group rank and the personal rank, then the personal rank will be used.
+[*]The higher the position in [b][YAS.RankRelations][/b] the higher the rank priority. That is, if a player belongs to two group relations at once, the one that is higher in the list will be used.
+[/list]
+
+[b]Rank example[/b]
+When your config is generated for the first time there will be an example rank - "Man of Culture". It has green color and relation with ObjectID 103582791429670253 (which is the SteamID64 of [url=https://steamcommunity.com/groups/hentaii]this group[/url]). Thus, if you leave this setting, when someone from this group enters the game, he will have a green rank "Man of Culture".
+You can use this as a template for creating your own ranks, or remove it if you don't need it.
+
+[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-YetAnotherScoreboard/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.
+
+SteamID can also be obtained from the player's profile, look at the URL:
+[img]https://raw.githubusercontent.com/GenZmeY/KF2-YetAnotherScoreboard/master/PublicationContent/ID2.png[/img]
+
+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-YetAnotherScoreboard/master/PublicationContent/ID3.png[/img]
+
+If you need a SteamID64 for a steam group, open the group in a browser and add this to the url: [b]/memberslistxml/?xml=1[/b]
+[img]https://raw.githubusercontent.com/GenZmeY/KF2-YetAnotherScoreboard/master/PublicationContent/ID4.png[/img]
+
+[h1]Notes[/h1]
+📌 VersusSurvival mode not supported (yet).
+
+[h1]Troubleshooting[/h1]
+[b](*)[/b] If your config is not created for some reason, create it manually with the following content:
+[b][YAS.YAS]
+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-YetAnotherScoreboard]https://github.com/GenZmeY/KF2-YetAnotherScoreboard[/url] [b](GNU GPLv3)[/b]

builder.cfg

@@ -39,7 +39,7 @@ Map="KF-Nuked"
 # Endless:        KFGameContent.KFGameInfo_Endless
 # Objective:      KFGameContent.KFGameInfo_Objective
 # Versus:         KFGameContent.KFGameInfo_VersusSurvival
-Game="KFGameContent.KFGameInfo_Survival"
+Game="KFGameContent.KFGameInfo_VersusSurvival"
 
 # Difficulty:
 # Normal:         0