Merge pull request #127 from RLBot/custom-maps

Custom map support

Author: VirxEC

RLBotCS/Conversion/FlatToCommand.cs

@@ -388,17 +388,27 @@ private static string GetOption(string option)
         return "";
     }
 
-    public static string MakeOpenCommand(MatchConfigurationT matchConfig)
+    public static (string, CustomMap?) MakeOpenCommand(MatchConfigurationT matchConfig)
     {
         var command = "Open ";
+        CustomMap? customMap = null;
 
         // Parse game map
-        // With RLBot v5, GameMap enum is now ignored
-        // You MUST use GameMapUpk instead
         // This is the name of the map file without the extension
         // And can also be used to tell the game to load custom maps
         if (matchConfig.GameMapUpk != "")
-            command += matchConfig.GameMapUpk;
+        {
+            if (CustomMap.IsCustomMap(matchConfig.GameMapUpk))
+            {
+                // load the custom map
+                customMap = new(matchConfig.GameMapUpk);
+                command += CustomMap.RL_MAP_KEY;
+            }
+            else
+            {
+                command += matchConfig.GameMapUpk;
+            }
+        }
         else
         {
             command += "Stadium_P";
@@ -421,7 +431,7 @@ public static string MakeOpenCommand(MatchConfigurationT matchConfig)
             command += ",Freeplay";
 
         if (matchConfig.Mutators is not { } mutatorSettings)
-            return command;
+            return (command, customMap);
 
         // Parse mutator settings
         command += GetOption(MapMatchLength(mutatorSettings.MatchLength));
@@ -457,7 +467,7 @@ public static string MakeOpenCommand(MatchConfigurationT matchConfig)
         command += GetOption(MapInputRestriction(mutatorSettings.InputRestriction));
         command += GetOption(MapScoringRule(mutatorSettings.ScoringRule));
 
-        return command;
+        return (command, customMap);
     }
 
     public static string MakeGameSpeedCommand(float gameSpeed) =>

RLBotCS/Main.cs

@@ -10,7 +10,7 @@
 if (args.Length > 0 && args[0] == "--version")
 {
     Console.WriteLine(
-        $"RLBotServer v5.beta.7.3\n"
+        $"RLBotServer v5.beta.7.4\n"
             + $"Bridge {BridgeVersion.Version}\n"
             + $"@ https://www.rlbot.org & https://github.com/RLBot/core"
     );

RLBotCS/ManagerTools/CustomMap.cs

@@ -0,0 +1,81 @@
+using Microsoft.Extensions.Logging;
+
+namespace RLBotCS.ManagerTools;
+
+public class CustomMap
+{
+    private static readonly ILogger Logger = Logging.GetLogger("CustomMap");
+
+    public const string RL_MAP_KEY = "Haunted_TrainStation_P";
+    private const string MAP_SACRIFICE = RL_MAP_KEY + ".upk";
+    private const string TEMP_MAP_NAME = RL_MAP_KEY + "_copy.upk";
+
+    public static bool IsCustomMap(string path)
+    {
+        bool isMapPath = path.EndsWith(".upk") || path.EndsWith(".udk");
+        return isMapPath && File.Exists(path);
+    }
+
+    private static string GetMapsBasePath()
+    {
+        // rocketleague/Binaries/Win64/RocketLeague.exe
+        string? gamePath = LaunchManager.GetRocketLeaguePath();
+        if (gamePath == null)
+        {
+            // throw exception because we shouldn't construct this class before Rocket League has launched
+            throw new InvalidOperationException("Could not find Rocket League executable");
+        }
+
+        // rocketleague/
+        string basePath = Path.GetDirectoryName(
+            Path.GetDirectoryName(Path.GetDirectoryName(gamePath)!)!
+        )!;
+        // rocketleague/TAGame/CookedPCConsole
+        return Path.Combine(basePath, "TAGame", "CookedPCConsole");
+    }
+
+    private string _originalMapPath;
+    private string _tempMapPath;
+
+    public CustomMap(string path)
+    {
+        if (!IsCustomMap(path))
+        {
+            // throw exception because we shouldn't construct this class with an invalid path
+            throw new ArgumentException("Provided path is not a valid custom map");
+        }
+
+        string mapsBasePath = GetMapsBasePath();
+        _originalMapPath = Path.Combine(mapsBasePath, MAP_SACRIFICE);
+        _tempMapPath = Path.Combine(mapsBasePath, TEMP_MAP_NAME);
+
+        Logger.LogInformation($"Custom map detected. Temporarily replacing {RL_MAP_KEY}");
+
+        // don't overwrite the original map if it already exists
+        if (!File.Exists(_tempMapPath))
+        {
+            // copy the original map to a temporary file so we can restore it later
+            File.Copy(_originalMapPath, _tempMapPath, false);
+        }
+
+        // replace the original map with the custom map
+        File.Copy(path, _originalMapPath, true);
+    }
+
+    public void TryRestoreOriginalMap()
+    {
+        if (!File.Exists(_tempMapPath))
+            return;
+
+        File.Copy(_tempMapPath, _originalMapPath, true);
+        File.Delete(_tempMapPath);
+        Logger.LogInformation($"Restored original map of {RL_MAP_KEY}");
+    }
+
+    ~CustomMap()
+    {
+        // Doing this in the destructor to ensure that the original map is restored,
+        // even if an invalid state occurs elsewhere
+        TryRestoreOriginalMap();
+    }
+}

RLBotCS/ManagerTools/LaunchManager.cs

@@ -19,10 +19,13 @@ static class LaunchManager
 
     public static string? GetGameArgs(bool kill)
     {
-        Process[] candidates = Process.GetProcessesByName("RocketLeague");
+        Process[] candidates = Process.GetProcesses();
 
         foreach (var candidate in candidates)
         {
+            if (!candidate.ProcessName.Contains("RocketLeague"))
+                continue;
+
             string args = GetProcessArgs(candidate);
             if (kill)
                 candidate.Kill();
@@ -99,8 +102,10 @@ private static string[] GetIdealArgs(int gamePort) =>
             "-nomovie",
         ];
 
+#if WINDOWS
     private static List<string> ParseCommand(string command)
     {
+        // Only works on Windows due to exes on Linux running under Wine
         var parts = new List<string>();
         var regex = new Regex(@"(?<match>[\""].+?[\""]|[^ ]+)");
         var matches = regex.Matches(command);
@@ -112,6 +117,7 @@ private static List<string> ParseCommand(string command)
 
         return parts;
     }
+#endif
 
     private static Process RunCommandInShell(string command)
     {
@@ -389,6 +395,27 @@ int gamePort
 #endif
     }
 
+    public static string? GetRocketLeaguePath()
+    {
+        // Assumes the game has already been launched
+        string? args = GetGameArgs(false);
+        if (args is null)
+            return null;
+
+        string directGamePath;
+
+#if WINDOWS
+        directGamePath = ParseCommand(args)[0];
+#else
+        // On Linux, Rocket League is running under Wine so args is something like
+        // Z:\home\username\.steam\debian-installation\steamapps\common\rocketleague\Binaries\Win64\RocketLeague.exe-rlbotRLBot_ControllerURL=127.0.0.1:23233RLBot_PacketSendRate=240-nomovie
+        // and we must get the real path to RocketLeague.exe from this
+        directGamePath = args.Remove(0, 2).Split("-rlbot")[0].Replace("\\", "/");
+#endif
+
+        return directGamePath;
+    }
+
     public static bool IsRocketLeagueRunning() =>
         Process
             .GetProcesses()

RLBotCS/ManagerTools/MatchStarter.cs

@@ -23,6 +23,12 @@ class MatchStarter(int gamePort, int rlbotSocketsPort)
 
     private Dictionary<string, string> _hivemindNameMap = new();
 
+    /// <summary>
+    /// If this value is not null,
+    /// then a custom map is being loaded.
+    /// </summary>
+    private CustomMap? _customMap;
+
     public readonly AgentMapping AgentMapping = new();
 
     public bool HasSpawnedCars { get; private set; }
@@ -107,6 +113,11 @@ public void OnMapSpawn(string mapName, PlayerSpawner spawner)
     {
         Logger.LogInformation("Got map info for " + mapName);
         HasSpawnedMap = true;
+        if (_customMap is not null)
+        {
+            _customMap.TryRestoreOriginalMap();
+            _customMap = null;
+        }
 
         if (_deferredMatchConfig is { } matchConfig)
         {
@@ -246,7 +257,9 @@ private void LoadMatch(MatchConfigurationT matchConfig, PlayerSpawner spawner)
             _matchConfig = null;
             _deferredMatchConfig = matchConfig;
 
-            var cmd = spawner.SpawnMap(matchConfig);
+            var (cmd, customMap) = spawner.SpawnMap(matchConfig);
+            _customMap = customMap;
+
             Logger.LogInformation($"Loading map with command: {cmd}");
         }
         else

RLBotCS/ManagerTools/PlayerSpawner.cs

@@ -113,12 +113,14 @@ public void DespawnPlayers(List<int> playerIds)
         }
     }
 
-    public string SpawnMap(MatchConfigurationT matchConfig)
+    public (string, CustomMap?) SpawnMap(MatchConfigurationT matchConfig)
     {
-        string loadMapCommand = FlatToCommand.MakeOpenCommand(matchConfig);
+        (string loadMapCommand, CustomMap? customMap) = FlatToCommand.MakeOpenCommand(
+            matchConfig
+        );
         spawnCommandQueue.AddConsoleCommand(loadMapCommand);
         spawnCommandQueue.Flush();
-        return loadMapCommand;
+        return (loadMapCommand, customMap);
     }
 
     public void Flush()