Merge branch 'develop' into feature/recall-on-disconnect

FAForever · Dec 25, 2024 · 778ea84 · 778ea84
2 parents 72475a4 + 9142736
commit 778ea84
Show file tree

Hide file tree

Showing 58 changed files with 118 additions and 11 deletions.
diff --git a/changelog/snippets/other.6577.md b/changelog/snippets/other.6577.md
diff --git a/docs/_posts/2024-12-25-3817.md b/docs/_posts/2024-12-25-3817.md
@@ -0,0 +1,33 @@
+---
+layout: post
+title: Game version 3817
+permalink: changelog/3817
+---
+
+# Game version 3817 (25th of December, 2024)
+
+A small hotfix for the autolobby. This will be the final patch for the game in 2024.
+
+I’d like to take this opportunity to express my sincere gratitude to everyone who has contributed to FAForever this past year, as well as those who have contributed in the past. The FAForever project is possible because of your time and effort!
+
+If you're interested in contributing then I encourage you to visit the forums and review the first pinned post in the contribution section. It provides an extensive overview of the currently documented roles in the community. Whether you're an (aspiring) artist, developer, or simply interested in writing well-structured texts — you are welcome!
+
+I wish you all the best in the new year.
+
+With kind regards,
+Jip
+
+## Bug fixes
+
+- (#6581) Fix divisions not being parsed by the matchmaker lobby.
+
+- (#6581) Fix division image filenames not matching the division data in the scenario info.
+
+## Other changes
+
+- (#6577) Annotate `AddBlinkyBox`. This UI-side global engine function makes a unit's selection box blink for some time.
+
+## Contributors
+
+- Nomander
+- Jip
diff --git a/lua/ui/lobby/autolobby/AutolobbyController.lua b/lua/ui/lobby/autolobby/AutolobbyController.lua
@@ -56,13 +56,33 @@ local AutolobbyEngineStrings = {
     ['LaunchRejected'] = "<LOC lob_0009>Some players are using an incompatible client version.",
 }
 
+-- associated textures are in `/textures/divisions/<division> <subdivision>.png` 
+-- Make note of the space, which isn't there for "grandmaster" and "unlisted" divisions
+
+---@alias Division
+---| "bronze"
+---| "silver"
+---| "gold"
+---| "diamond"
+---| "master"
+---| "grandmaster"
+---| "unlisted"
+
+---@alias Subdivision
+---| "I"
+---| "II"
+---| "III"
+---| "IV"
+---| "V"
+---| "" # when Division is grandmaster or unlisted
+
 ---@class UIAutolobbyPlayer: UILobbyLaunchPlayerConfiguration
 ---@field StartSpot number
 ---@field DEV number    # Related to rating/divisions
 ---@field MEAN number   # Related to rating/divisions
 ---@field NG number     # Related to rating/divisions
----@field DIV string    # Related to rating/divisions
----@field SUBDIV string # Related to rating/divisions
+---@field DIV Division    # Related to rating/divisions
+---@field SUBDIV Subdivision # Related to rating/divisions
 ---@field PL number     # Related to rating/divisions
 ---@field PlayerClan string
 

diff --git a/lua/ui/lobby/autolobby/components/AutolobbyArguments.lua b/lua/ui/lobby/autolobby/components/AutolobbyArguments.lua
@@ -48,7 +48,7 @@ AutolobbyArgumentsComponent = ClassSimple {
         ["/mean"] = true,
 
         -- related to divisions
-        ["division"] = true,
+        ["/division"] = true,
         ["/subdivision"] = true,
 
         -- related to game settings

diff --git a/lua/ui/lobby/changelogData.lua b/lua/ui/lobby/changelogData.lua
@@ -3,6 +3,47 @@ last_version = 3816
 
 ---@type PatchNotes[]
 gamePatches = {
+    {
+        version = 3817,
+        name = "Hotfix",
+        hasPrettyGithubRelease = true,
+        hasPrettyPatchnotes = false,
+        description = {
+            "# Game version 3817 (25th of December, 2024)",
+            "",
+            "A small hotfix for the autolobby. This will be the final patch for the game in 2024.",
+            "",
+            "I’d like to take this opportunity to express my sincere gratitude to everyone who has contributed to FAForever this ",
+            "past year, as well as those who have contributed in the past. The FAForever project is possible ",
+            "because of your time and effort!",
+            "",
+            "If you're interested in contributing then I encourage you to visit the forums and review the first pinned post in ",
+            "the contribution section. It provides an extensive overview of the currently documented roles in the ",
+            "community. Whether you're an (aspiring) artist, developer, or simply interested in writing well-structured ",
+            "texts — you are welcome!",
+            "",
+            "I wish you all the best in the new year.",
+            "",
+            "With kind regards,",
+            "Jip",
+            "",
+            "## Bug fixes",
+            "",
+            "- (#6581) Fix divisions not being parsed by the matchmaker lobby.",
+            "",
+            "- (#6581) Fix division image filenames not matching the division data in the scenario info.",
+            "",
+            "## Other changes",
+            "",
+            "- (#6577) Annotate `AddBlinkyBox`. This UI-side global engine function makes a unit's selection box blink for some time.",
+            "",
+            "## Contributors",
+            "",
+            "- Nomander",
+            "- Jip",
+            "",
+        },
+    },
         {
             version = 3816,
             name = "Hotfix",

diff --git a/lua/version.lua b/lua/version.lua
@@ -34,9 +34,9 @@ local Commit = 'unknown'    -- The use of `'` instead of `"` is **intentional**
 
 --#endregion
 
-local Version = "3816"
----@alias PATCH "3816"
----@alias VERSION "1.5.3816"
+local Version = "3817"
+---@alias PATCH "3817"
+---@alias VERSION "1.5.3817"
 ---@return PATCH    # Game release
 function GetVersion()
     LOG(string.format('Supreme Commander: Forged Alliance Lua version %s at %s (%s)', Version, GameType, Commit))

diff --git a/mod_info.lua b/mod_info.lua
@@ -27,7 +27,7 @@
 -- - https://github.com/FAForever/fa/blob/deploy/fafdevelop/lua/MODS.LUA
 
 name = "Forged Alliance Forever"
-version = 3816          -- needs to be an integer as it is parsed as a short (16 bit integer)
+version = 3817          -- needs to be an integer as it is parsed as a short (16 bit integer)
 _faf_modname='faf'
 copyright = "Forged Alliance Forever Community"
 description = "Forged Alliance Forever extends Forged Alliance, bringing new patches, game modes, units, ladder, and much more!"

diff --git a/scripts/LaunchFAInstances.ps1 b/scripts/LaunchFAInstances.ps1
@@ -32,9 +32,11 @@ $hostProtocol = "udp"
 $hostPlayerName = "HostPlayer_1"
 $gameName = "MyGame"
 
-# Array of factions to choose from
+# Array of player data to choose from
 $factions = @("UEF", "Seraphim", "Cybran", "Aeon")
 $clans = @("Yps", "Nom", "Cly", "Mad", "Gol", "Kur", "Row", "Jip", "Bal", "She")
+$divisions = @("bronze", "silver", "gold", "diamond", "master", "grandmaster", "unlisted")
+$subdivisions = @("I", "II", "III", "IV", "V")
 
 # Get the screen resolution (for placing and resizing the windows)
 Add-Type -AssemblyName System.Windows.Forms
@@ -84,6 +86,15 @@ function Get-TeamArgument {
     return "/team $((($instanceNumber % $teams) + 1 + 1))"
 }
 
+function Get-DivisionArgText {
+    $division = $($divisions | Get-Random)
+    $argText = "/division $division"
+    if ($division -ne "unlisted" -and $division -ne "grandmaster") {
+        $argText += " /subdivision $($subdivisions | Get-Random)"
+    }
+    return $argText
+}
+
 # Prepare arguments and launch instances
 if ($players -eq 1) {
     $logFile = "dev.log"
@@ -92,7 +103,9 @@ if ($players -eq 1) {
     $hostLogFile = "host_dev_1.log"
     $hostFaction = $factions | Get-Random
     $hostTeamArgument = Get-TeamArgument -instanceNumber 0
-    $hostArguments = "/log $hostLogFile /showlog /hostgame $hostProtocol $port $hostPlayerName $gameName $map /startspot 1 /players $players /$hostFaction $hostTeamArgument $baseArguments /division HostDivision /subdivision 1 /clan $($clans | Get-Random)"
+
+    $divisionArgText = Get-DivisionArgText
+    $hostArguments = "/log $hostLogFile /showlog /hostgame $hostProtocol $port $hostPlayerName $gameName $map /startspot 1 /players $players /$hostFaction $hostTeamArgument $baseArguments $divisionArgText /clan $($clans | Get-Random)"
 
     # Launch host game instance
     Launch-GameInstance -instanceNumber 1 -xPos 0 -yPos 0 -arguments $hostArguments
@@ -108,7 +121,8 @@ if ($players -eq 1) {
         $clientPlayerName = "ClientPlayer_$($i + 1)"
         $clientFaction = $factions | Get-Random
         $clientTeamArgument = Get-TeamArgument -instanceNumber $i
-        $clientArguments = "/log $clientLogFile /joingame $hostProtocol localhost:$port $clientPlayerName /startspot $($i + 1) /players $players /$clientFaction $clientTeamArgument $baseArguments /division Diamond /subdivision $($i + 1) /clan $($clans | Get-Random)"
+        $divisionArgText = Get-DivisionArgText
+        $clientArguments = "/log $clientLogFile /joingame $hostProtocol localhost:$port $clientPlayerName /startspot $($i + 1) /players $players /$clientFaction $clientTeamArgument $baseArguments $divisionArgText /clan $($clans | Get-Random)"
 
         Launch-GameInstance -instanceNumber ($i + 1) -xPos $xPos -yPos $yPos -arguments $clientArguments
     }

diff --git a/textures/divisions/bronzeI.png → textures/divisions/bronze I.png b/textures/divisions/bronzeI.png → textures/divisions/bronze I.png
diff --git a/textures/divisions/bronzeII.png → textures/divisions/bronze II.png b/textures/divisions/bronzeII.png → textures/divisions/bronze II.png
diff --git a/textures/divisions/bronzeIII.png → textures/divisions/bronze III.png b/textures/divisions/bronzeIII.png → textures/divisions/bronze III.png
diff --git a/textures/divisions/bronzeIII_medium.png → textures/divisions/bronze III_medium.png b/textures/divisions/bronzeIII_medium.png → textures/divisions/bronze III_medium.png
diff --git a/textures/divisions/bronzeII_medium.png → textures/divisions/bronze II_medium.png b/textures/divisions/bronzeII_medium.png → textures/divisions/bronze II_medium.png
diff --git a/textures/divisions/bronzeIV.png → textures/divisions/bronze IV.png b/textures/divisions/bronzeIV.png → textures/divisions/bronze IV.png
diff --git a/textures/divisions/bronzeIV_medium.png → textures/divisions/bronze IV_medium.png b/textures/divisions/bronzeIV_medium.png → textures/divisions/bronze IV_medium.png
diff --git a/textures/divisions/bronzeI_medium.png → textures/divisions/bronze I_medium.png b/textures/divisions/bronzeI_medium.png → textures/divisions/bronze I_medium.png
diff --git a/textures/divisions/bronzeV.png → textures/divisions/bronze V.png b/textures/divisions/bronzeV.png → textures/divisions/bronze V.png
diff --git a/textures/divisions/bronzeV_medium.png → textures/divisions/bronze V_medium.png b/textures/divisions/bronzeV_medium.png → textures/divisions/bronze V_medium.png
diff --git a/textures/divisions/diamondI.png → textures/divisions/diamond I.png b/textures/divisions/diamondI.png → textures/divisions/diamond I.png
diff --git a/textures/divisions/diamondII.png → textures/divisions/diamond II.png b/textures/divisions/diamondII.png → textures/divisions/diamond II.png
diff --git a/textures/divisions/diamondIII.png → textures/divisions/diamond III.png b/textures/divisions/diamondIII.png → textures/divisions/diamond III.png
diff --git a/textures/divisions/diamondIII_medium.png → textures/divisions/diamond III_medium.png b/textures/divisions/diamondIII_medium.png → textures/divisions/diamond III_medium.png
diff --git a/textures/divisions/diamondII_medium.png → textures/divisions/diamond II_medium.png b/textures/divisions/diamondII_medium.png → textures/divisions/diamond II_medium.png
diff --git a/textures/divisions/diamondIV.png → textures/divisions/diamond IV.png b/textures/divisions/diamondIV.png → textures/divisions/diamond IV.png
diff --git a/textures/divisions/diamondIV_medium.png → textures/divisions/diamond IV_medium.png b/textures/divisions/diamondIV_medium.png → textures/divisions/diamond IV_medium.png
diff --git a/textures/divisions/diamondI_medium.png → textures/divisions/diamond I_medium.png b/textures/divisions/diamondI_medium.png → textures/divisions/diamond I_medium.png
diff --git a/textures/divisions/diamondV.png → textures/divisions/diamond V.png b/textures/divisions/diamondV.png → textures/divisions/diamond V.png
diff --git a/textures/divisions/diamondV_medium.png → textures/divisions/diamond V_medium.png b/textures/divisions/diamondV_medium.png → textures/divisions/diamond V_medium.png
diff --git a/textures/divisions/goldI.png → textures/divisions/gold I.png b/textures/divisions/goldI.png → textures/divisions/gold I.png
diff --git a/textures/divisions/goldII.png → textures/divisions/gold II.png b/textures/divisions/goldII.png → textures/divisions/gold II.png
diff --git a/textures/divisions/goldIII.png → textures/divisions/gold III.png b/textures/divisions/goldIII.png → textures/divisions/gold III.png
diff --git a/textures/divisions/goldIII_medium.png → textures/divisions/gold III_medium.png b/textures/divisions/goldIII_medium.png → textures/divisions/gold III_medium.png
diff --git a/textures/divisions/goldII_medium.png → textures/divisions/gold II_medium.png b/textures/divisions/goldII_medium.png → textures/divisions/gold II_medium.png
diff --git a/textures/divisions/goldIV.png → textures/divisions/gold IV.png b/textures/divisions/goldIV.png → textures/divisions/gold IV.png
diff --git a/textures/divisions/goldIV_medium.png → textures/divisions/gold IV_medium.png b/textures/divisions/goldIV_medium.png → textures/divisions/gold IV_medium.png
diff --git a/textures/divisions/goldI_medium.png → textures/divisions/gold I_medium.png b/textures/divisions/goldI_medium.png → textures/divisions/gold I_medium.png
diff --git a/textures/divisions/goldV.png → textures/divisions/gold V.png b/textures/divisions/goldV.png → textures/divisions/gold V.png
diff --git a/textures/divisions/goldV_medium.png → textures/divisions/gold V_medium.png b/textures/divisions/goldV_medium.png → textures/divisions/gold V_medium.png
diff --git a/textures/divisions/masterI.png → textures/divisions/master I.png b/textures/divisions/masterI.png → textures/divisions/master I.png
diff --git a/textures/divisions/masterII.png → textures/divisions/master II.png b/textures/divisions/masterII.png → textures/divisions/master II.png
diff --git a/textures/divisions/masterIII.png → textures/divisions/master III.png b/textures/divisions/masterIII.png → textures/divisions/master III.png
diff --git a/textures/divisions/masterIII_medium.png → textures/divisions/master III_medium.png b/textures/divisions/masterIII_medium.png → textures/divisions/master III_medium.png
diff --git a/textures/divisions/masterII_medium.png → textures/divisions/master II_medium.png b/textures/divisions/masterII_medium.png → textures/divisions/master II_medium.png
diff --git a/textures/divisions/masterIV.png → textures/divisions/master IV.png b/textures/divisions/masterIV.png → textures/divisions/master IV.png
diff --git a/textures/divisions/masterIV_medium.png → textures/divisions/master IV_medium.png b/textures/divisions/masterIV_medium.png → textures/divisions/master IV_medium.png
diff --git a/textures/divisions/masterI_medium.png → textures/divisions/master I_medium.png b/textures/divisions/masterI_medium.png → textures/divisions/master I_medium.png
diff --git a/textures/divisions/masterV.png → textures/divisions/master V.png b/textures/divisions/masterV.png → textures/divisions/master V.png
diff --git a/textures/divisions/masterV_medium.png → textures/divisions/master V_medium.png b/textures/divisions/masterV_medium.png → textures/divisions/master V_medium.png
diff --git a/textures/divisions/silverI.png → textures/divisions/silver I.png b/textures/divisions/silverI.png → textures/divisions/silver I.png
diff --git a/textures/divisions/silverII.png → textures/divisions/silver II.png b/textures/divisions/silverII.png → textures/divisions/silver II.png
diff --git a/textures/divisions/silverIII.png → textures/divisions/silver III.png b/textures/divisions/silverIII.png → textures/divisions/silver III.png
diff --git a/textures/divisions/silverIII_medium.png → textures/divisions/silver III_medium.png b/textures/divisions/silverIII_medium.png → textures/divisions/silver III_medium.png
diff --git a/textures/divisions/silverII_medium.png → textures/divisions/silver II_medium.png b/textures/divisions/silverII_medium.png → textures/divisions/silver II_medium.png
diff --git a/textures/divisions/silverIV.png → textures/divisions/silver IV.png b/textures/divisions/silverIV.png → textures/divisions/silver IV.png
diff --git a/textures/divisions/silverIV_medium.png → textures/divisions/silver IV_medium.png b/textures/divisions/silverIV_medium.png → textures/divisions/silver IV_medium.png
diff --git a/textures/divisions/silverI_medium.png → textures/divisions/silver I_medium.png b/textures/divisions/silverI_medium.png → textures/divisions/silver I_medium.png
diff --git a/textures/divisions/silverV.png → textures/divisions/silver V.png b/textures/divisions/silverV.png → textures/divisions/silver V.png
diff --git a/textures/divisions/silverV_medium.png → textures/divisions/silver V_medium.png b/textures/divisions/silverV_medium.png → textures/divisions/silver V_medium.png