Ticket #4406: ai-info-v2.patch

binaries/data/config/default.cfg

@@ -29 +29 @@
 ; Show detailed tooltips (Unit stats)
 showdetailedtooltips = false
 
-; Enable/disable the splashscreen
-splashscreendisable = false
-
-; Splashscreen version (date of last modification). By default, 0 to force splashscreen to appear at first launch.
-splashscreenversion = 0
-
 ; Pause the game on window focus loss (Only applicable to single player mode)
 pauseonfocusloss = true
 
@@ -327 +321 @@
 [gui]
 cursorblinkrate = 0.5             ; Cursor blink rate in seconds (0.0 to disable blinking)
 scale = 1.0                       ; GUI scaling factor, for improved compatibility with 4K displays
+enablesplashscreen = true         ; Enable/disable the splashscreen
+splashscreenversion = 0           ; Splashscreen version (date of last modification). By default, 0 to force splashscreen to appear at first launch
+enablespinfo = true               ; Enable/Disable tips for SP newcomers
 
 [gui.menu]
 limitfps = true                   ; Limit FPS in the menus and loading screen

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

@@ -303 +303 @@
 
     if (g_IsNetworked)
         Engine.GetGUIObjectByName("chatInput").focus();
+    else
+        initSPInfo();
 
     if (g_IsController)
     {
@@ -340 +342 @@
     g_GameAttributes.mapFilter = "default";
 }
 
+function initSPInfo()
+{
+    if (Engine.ConfigDB_GetValue("user", "gui.enablespinfo") !== "true")
+        return;
+
+    let tips = Engine.ReadJSONFile("gui/gamesetup/singleplayerTips.json");
+    Engine.GetGUIObjectByName("spInfo").hidden = false;
+    Engine.GetGUIObjectByName("displaySPInfo").checked = true;
+    Engine.GetGUIObjectByName("aiInfo").caption = Engine.TranslateLines(tips.ai);
+}
+
 /**
  * Remove empty space in case of hidden options (like cheats, rating or wonder duration)
  */
@@ -1998 +2011 @@
     g_LastGameStanza = stanza;
     Engine.SendRegisterGame(stanza);
 }
+
+function saveSPInfoSetting()
+{
+    let enabled = String(Engine.GetGUIObjectByName("displaySPInfo").checked);
+    Engine.ConfigDB_CreateValue("user", "gui.enablespinfo", enabled);
+    Engine.ConfigDB_WriteValueToFile("user", "gui.enablespinfo", enabled, "config/user.cfg");
+}

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

@@ -133 +133 @@
                 </object>
             </object>
             <object size="24 64 100%-460 358" type="image" sprite="CoverFillDark" name="playerAssignmentsPanelCover" hidden="true"/>
+
+            <object size="24 370 560 520" type="image" name="spInfo" hidden="true">
+                <object size="4 10 28 34" type="image" sprite="ModernGear"/>
+                <object name="aiInfo" type="text" style="ModernLeftLabelText" size="32 0 100%-20 100%-32"/>
+                <object size="30 100%-30 100% 100%-8" type="text" style="ModernLeftLabelText">
+                    <translatableAttribute id="caption">Show this message in the future</translatableAttribute>
+                </object>
+                <object name="displaySPInfo" size="8 100%-30 22 100%-8" type="checkbox" style="ModernTickBox">
+                    <action on="Press">saveSPInfoSetting();</action>
+                </object>
+            </object>
             <!-- Map selection -->
 
             <object size="100%-425 355 100%-285 470" name="mapTypeTooltip">

binaries/data/mods/public/gui/gamesetup/singleplayerTips.json

@@ +1 @@
+{
+    "ai": "Although reasonably easy for an experienced player, the default AI level is quite challenging for new players before they master the basic mechanisms of the game. It is advised to start by playing against a lower level (sandbox or very easy) when beginning with the game. Changing the AI level is done by clicking on the gear icon next to each AI player in the player selection panel above."
+}

binaries/data/mods/public/gui/options/options.json

@@ -27 +27 @@
         },
         {
             "type": "boolean",
-            "label": "Disable Welcome Screen",
+            "label": "Enable Welcome Screen",
             "tooltip": "When disabled, the welcome screen will nevertheless be shown once when a new version is available and you can always launch it from the main menu.",
-            "parameters": { "config": "splashscreendisable" }
+            "parameters": { "config": "gui.enablesplashscreen" }
         },
         {
             "type": "boolean",
+            "label": "Enable SP info panel",
+            "tooltip": "Show the SP info panel with some tips for newcomers.",
+            "parameters": { "config": "gui.enablespinfo" }
+        },
+        {
+            "type": "boolean",
             "label": "Detailed Tooltips",
             "tooltip": "Show detailed tooltips for trainable units in unit-producing buildings.",
             "parameters": { "config": "showdetailedtooltips" }

binaries/data/mods/public/gui/pregame/mainmenu.js

@@ -128 +128 @@
     {
         g_ShowSplashScreens = false;
 
-        if (Engine.ConfigDB_GetValue("user", "splashscreendisable") !== "true" ||
-            Engine.ConfigDB_GetValue("user", "splashscreenversion") < Engine.GetFileMTime("gui/splashscreen/splashscreen.txt"))
+        if (Engine.ConfigDB_GetValue("user", "gui.enablesplashscreen") === "true" ||
+            Engine.ConfigDB_GetValue("user", "gui.splashscreenversion") < Engine.GetFileMTime("gui/splashscreen/splashscreen.txt"))
             Engine.PushGuiPage("page_splashscreen.xml", { "page": "splashscreen", callback : "SplashScreenClosedCallback" } );
         else
             ShowRenderPathMessage();

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

@@ -1 +1 @@
 function init(data)
 {
     Engine.GetGUIObjectByName("mainText").caption = Engine.TranslateLines(Engine.ReadFile("gui/splashscreen/" + data.page + ".txt"));
-    Engine.GetGUIObjectByName("displaySplashScreen").checked = Engine.ConfigDB_GetValue("user", "splashscreendisable") !== "true";
+    Engine.GetGUIObjectByName("displaySplashScreen").checked = Engine.ConfigDB_GetValue("user", "gui.enablesplashscreen") === "true";
 }

binaries/data/mods/public/gui/splashscreen/splashscreen.xml

@@ -27 +27 @@
         <object name="btnOK" type="button" style="ModernButtonRed" size="18 100%-45 50%-5 100%-17" hotkey="cancel">
             <translatableAttribute id="caption">OK</translatableAttribute>
             <action on="Press"><![CDATA[
-            let disabled = "" + !Engine.GetGUIObjectByName("displaySplashScreen").checked;
-            Engine.ConfigDB_CreateValue("user", "splashscreendisable", disabled);
-            Engine.ConfigDB_WriteValueToFile("user", "splashscreendisable", disabled, "config/user.cfg"); 
+            let enabled = String(Engine.GetGUIObjectByName("displaySplashScreen").checked);
+            Engine.ConfigDB_CreateValue("user", "gui.enablesplashscreen", enabled);
+            Engine.ConfigDB_WriteValueToFile("user", "gui.enablesplashscreen", enabled, "config/user.cfg"); 
             let version = Engine.GetFileMTime("gui/splashscreen/splashscreen.txt");
-            Engine.ConfigDB_CreateValue("user", "splashscreenversion", version);
-            Engine.ConfigDB_WriteValueToFile("user", "splashscreenversion", version, "config/user.cfg");
+            Engine.ConfigDB_CreateValue("user", "gui.splashscreenversion", version);
+            Engine.ConfigDB_WriteValueToFile("user", "gui.splashscreenversion", version, "config/user.cfg");
             Engine.PopGuiPageCB();
             ]]></action>
         </object>