Ticket #4141: better_gamesetup_descriptions_v1.patch

binaries/data/mods/public/simulation/data/settings/victory_conditions/conquest.json

@@ -1 +1 @@
 {
     "TranslatedKeys": ["Title", "Description"],
     "Data":
     {
         "Title": "Conquest",
-        "Description": "Defeat all opponents",
+        "Description": "Defeat all opponents to win.",
         "Scripts":
         [
             "scripts/TriggerHelper.js",
             "scripts/ConquestCommon.js",
             "scripts/Conquest.js"

binaries/data/mods/public/simulation/data/settings/victory_conditions/conquest_structures.json

@@ -1 +1 @@
 {
     "TranslatedKeys": ["Title", "Description"],
     "Data":
     {
         "Title": "Conquest Structures",
-        "Description": "Destroy all structures of enemies",
+        "Description": "Destroy all enemy structures to win.",
         "Scripts":
         [
             "scripts/TriggerHelper.js",
             "scripts/ConquestCommon.js",
             "scripts/ConquestStructures.js"

binaries/data/mods/public/simulation/data/settings/victory_conditions/conquest_units.json

@@ -1 +1 @@
 {
     "TranslatedKeys": ["Title", "Description"],
     "Data":
     {
         "Title": "Conquest Units",
-        "Description": "Kill all enemy units",
+        "Description": "Kill all enemy units to win.",
         "Scripts":
         [
             "scripts/TriggerHelper.js",
             "scripts/ConquestCommon.js",
             "scripts/ConquestUnits.js"

binaries/data/mods/public/simulation/data/settings/victory_conditions/regicide.json

@@ -1 +1 @@
 {
     "TranslatedKeys": ["Title", "Description"],
     "Data":
     {
         "Title": "Regicide",
-        "Description": "Defeat opponents by killing their hero",
+        "Description": "Defeat opponents by killing their hero.",
         "Scripts":
         [
             "scripts/TriggerHelper.js",
             "scripts/ConquestCommon.js",
             "scripts/Conquest.js",

binaries/data/mods/public/simulation/data/settings/victory_conditions/wonder.json

@@ -1 +1 @@
 {
     "TranslatedKeys": ["Title", "Description"],
     "Data":
     {
         "Title": "Wonder",
-        "Description": "Build and protect a wonder to win",
+        "Description": "Be the first to build or capture a wonder and keep it for a certain time to win the game.",
         "Scripts":
         [
             "scripts/TriggerHelper.js",
             "scripts/ConquestCommon.js",
             "scripts/Conquest.js",

binaries/data/mods/public/gui/common/settings.js

@@ -224 +224 @@
     // TODO: We might support enabling victory conditions separately sometime.
     // Until then, we supplement the endless gametype here.
     victoryConditions.push({
         "Name": "endless",
         "Title": translate("None"),
-        "Description": translate("Endless Game"),
+        "Description": translate("Endless game."),
         "Scripts": []
     });
 
     return victoryConditions;
 }

binaries/data/mods/public/gui/gamesetup/gamesetup.js

@@ -134 +134 @@
 const g_ReadyColor = "green";
 
 /**
  * Highlights the victory condition in the game-description.
  */
-const g_VictoryColor = "orange";
+const g_DescriptionHighlight = "orange";
 
 /**
  * Placeholder item for the map-dropdownlist.
  */
 const g_RandomMap = '[color="' + g_ColorRandom + '"]' + translateWithContext("map selection", "Random") + "[/color]";
@@ -1454 +1454 @@
         pColorPickerHeading.hidden = !canChangeColors;
         if (canChangeColors)
             pColorPicker.selected = g_PlayerColors.findIndex(col => sameColor(col, color));
     }
 
-    updateMapDescription();
+    updateGameDescription();
     resizeMoreOptionsWindow();
 
     g_IsInGuiUpdate = false;
 
     // Game attributes include AI settings, so update the player list
@@ -1473 +1473 @@
         openAIConfig(g_LastViewedAIPlayer);
     }
 }
 
 /**
- * Sets an additional map label, map preview image and mapsettings description.
+ * Sets an additional map label, map preview image and describes the chosen gamesettings more closely.
  */
-function updateMapDescription()
+function updateGameDescription()
 {
     setMapPreviewImage("mapPreview", getMapPreview(g_GameAttributes.map));
 
     Engine.GetGUIObjectByName("mapInfoName").caption =
         translateMapTitle(getMapDisplayName(g_GameAttributes.map));
 
-    let numPlayers = sprintf(
-        translatePlural(
-            "%(number)s player. ",
-            "%(number)s players. ",
-            g_GameAttributes.settings.PlayerData.length
-        ),
-        { "number": g_GameAttributes.settings.PlayerData.length }
-    );
-
-    let mapDescription =
-        g_GameAttributes.map == "random" ?
-            translate("Randomly selects a map from the list") :
-        g_GameAttributes.settings.Description ?
-            translate(g_GameAttributes.settings.Description) :
-            translate("Sorry, no description available.");
-
+    let victoryTitle = "";
     let victoryIdx = g_VictoryConditions.Name.indexOf(g_GameAttributes.settings.GameType || g_VictoryConditions.Default);
-    let victoryTitle;
-
-    if (victoryIdx == -1)
-        victoryTitle = translateWithContext("victory condition", "Unknown");
-    else
+    if (victoryIdx != -1)
     {
+        let title = g_VictoryConditions.Title[victoryIdx];
         if (g_VictoryConditions.Name[victoryIdx] == "wonder")
-            victoryTitle = sprintf(
+            title = sprintf(
                 translatePluralWithContext(
                     "victory condition",
                     "Wonder (%(min)s minute)",
                     "Wonder (%(min)s minutes)",
                     g_GameAttributes.settings.WonderDuration
                 ),
                 { "min": g_GameAttributes.settings.WonderDuration }
             );
-        else
-            victoryTitle = g_VictoryConditions.Title[victoryIdx];
 
-        if (victoryIdx != g_VictoryConditions.Default)
-            victoryTitle = "[color=\"" + g_VictoryColor + "\"]" + victoryTitle + "[/color]";
-    }
+        victoryTitle = sprintf(translate("%(VictoryCondition)s: %(Description)s"), {
+            "VictoryCondition": "[color=\"" + g_DescriptionHighlight + "\"]" + title + "[/color]",
+            "Description": g_VictoryConditions.Description[victoryIdx]
+        }) + "\n";
+    }
+
+    let is1v1 = g_GameAttributes.settings.PlayerData.length == 2;
+    let isRated = g_GameAttributes.settings.RatingEnabled && is1v1;
+    let ratedGameTitle = !isRated ? "" :
+        sprintf(translate("%(RatedGame)s: %(Description)s"), {
+            "RatedGame":
+                "[color=\"" + g_DescriptionHighlight + "\"]" +
+                    translate("Rated game") +
+                "[/color]",
+            "Description": translate("When the winner of this match was determined, the lobby score will adapt.")
+        }) + "\n";
+
+    let lockedTeamsTitle = isRated ? "" :
+        sprintf(translate("%(LockedTeams)s: %(Description)s"), {
+            "LockedTeams":
+                "[color=\"" + g_DescriptionHighlight + "\"]" +
+                (g_GameAttributes.settings.LockTeams ?
+                    translate("Locked Teams") :
+                    translate("Diplomacy")) +
+                "[/color]",
+            "Description":
+                g_GameAttributes.settings.LockTeams ?
+                    translate("Players can't change the initial teams.") :
+                    translate("Players can setup alliances and declare war on allies.")
+        }) + "\n";
+
+    let lastManStandingTitle = is1v1 ? "" :
+        sprintf(translate("%(LastManStanding)s: %(Description)s"), {
+            "LastManStanding":
+                "[color=\"" + g_DescriptionHighlight + "\"]" +
+                (g_GameAttributes.settings.LastManStanding ?
+                    translate("Last Man Standing") :
+                    translate("Allied Victory")) +
+                "[/color]",
+            "Description":
+                g_GameAttributes.settings.LastManStanding ?
+                    translateWithContext("lastManStanding", "Only one player can win the game.") + " " +
+                    translateWithContext("lastManStanding", "If the remaining players are allies, the game continues until only one remains.") :
+                    translateWithContext("allied victory", "If one player wins, his allies win too.") + " " +
+                    translateWithContext("allied victory", "If one group of allies remains, they win.")
+        }) + "\n";
+
+    let mapDescription = sprintf(translate("%(Map)s: %(Description)s"), {
+            "Map":
+                "[color=\"" + g_DescriptionHighlight + "\"]" +
+                translate("Map") +
+                "[/color]",
+            "Description":
+                g_GameAttributes.map == "random" ?
+                    translate("Randomly selects a map from the list") :
+                g_GameAttributes.settings.Description ?
+                    translate(g_GameAttributes.settings.Description) :
+                    translate("Sorry, no description available."),
+    });
 
     Engine.GetGUIObjectByName("mapInfoDescription").caption =
-        numPlayers +
-        translate("Victory Condition:") + " " + victoryTitle + ".\n\n" +
+        victoryTitle +
+        ratedGameTitle +
+        lockedTeamsTitle +
+        lastManStandingTitle +
         mapDescription;
 }
 
 /**
  * Broadcast the changed settings to all clients and the lobbybot.