Fix unexpected behavior when Ryujinx input configs were not ordered by player index

Author: MoreOrLessSoftware

JoystickHelper/JoystickHelper.csproj

@@ -5,6 +5,7 @@
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <OutputType>Exe</OutputType>
+        <AssemblyVersion>1.0.1</AssemblyVersion>
     </PropertyGroup>
 
     <ItemGroup>

JoystickHelper/JoystickInfo.cs

@@ -3,9 +3,10 @@
 public class JoystickInfo
 {
     public Guid SdlJoystickGuid { get; set; }
+    public int SdlDeviceIndex { get; internal set; }
 
     public override string ToString()
     {
-        return SdlJoystickGuid.ToString();
+        return SdlDeviceIndex + "-" + SdlJoystickGuid.ToString();
     }
 }

JoystickHelper/Program.cs

@@ -40,8 +40,13 @@ private static int RunConfigureRyujinx(ConfigureRyujinxOptions opts)
             var configJson = File.ReadAllText(context.ConfigPath);
             var joysticks = SdlHelper.GetConnectedJoysticks();
             var setResult = RyujinxConfigHelper.SetJoystickGuids(joysticks, configJson);
-            File.WriteAllText(context.ConfigPath, setResult.ModifiedConfigJson);
-            File.WriteAllText(context.LastSettingsPath, JsonSerializer.Serialize(new RyujinxLastSettings(setResult.SwappedJoysticks)));
+            if (!String.IsNullOrEmpty(setResult.ModifiedConfigJson))
+            {
+                File.WriteAllText(context.ConfigPath, setResult.ModifiedConfigJson);
+                File.WriteAllText(context.LastSettingsPath, JsonSerializer.Serialize(new RyujinxLastSettings(setResult.SwappedJoysticks)));
+
+                Log.Information("Ryujinx config file updated");
+            }
             return 0;
         }
         catch (Exception ex)
@@ -65,7 +70,12 @@ private static int RunRevertRyujinx(RevertRyujinxOptions opts)
             var configJson = File.ReadAllText(context.ConfigPath);
             var joysticks = context.GetLastSettings().GetJoystickInfos();
             var setResult = RyujinxConfigHelper.SetJoystickGuids(joysticks, configJson);
-            File.WriteAllText(context.ConfigPath, setResult.ModifiedConfigJson);
+            if (!String.IsNullOrEmpty(setResult.ModifiedConfigJson))
+            {
+                File.WriteAllText(context.ConfigPath, setResult.ModifiedConfigJson);
+
+                Log.Information("Ryujinx config file updated");
+            }
             return 0;
         }
         catch (Exception ex)

JoystickHelper/Ryujinx/RyujinxConfigHelper.cs

@@ -32,53 +32,73 @@ public static SetJoysticksResult SetJoystickGuids(IList<JoystickInfo> joysticks,
             throw new InvalidRyujinxConfigException("Failed to deserialize the Ryujinx config json", ex);
         }
 
-        Log.Information("Found {count} input configs in Ryujinx config file", inputConfigs.Count);
+        var inputConfigsToProcess = inputConfigs
+            .Where(c => c["backend"]?.ToString() == "GamepadSDL2")
+            .OrderBy(c => ParsePlayerIndex(c["player_index"]?.ToString()))
+            .ToList();
 
-        for (int i = 0; i < inputConfigs.Count; i++)
+        if (inputConfigsToProcess.Count == 0)
         {
-            var inputConfig = inputConfigs[i];
-            if (joysticks.Count - 1 >= i)
+            Log.Warning("No inputs configured with GamepadSDL2 backend type were found in Ryujinx");
+            return result;
+        }
+
+        Log.Information("Found {count} SDL2 inputs configured in Ryujinx", inputConfigsToProcess.Count);
+
+        var inputConfigModified = false;
+
+        for (var i = 0; i < inputConfigsToProcess.Count; i++)
+        {
+            var inputConfig = inputConfigsToProcess[i];
+            var playerIndex = inputConfig["player_index"]?.ToString();
+
+            if (i > joysticks.Count - 1)
             {
-                var oldId = inputConfig["id"]?.ToString();
-                var newId = $"{i}-{joysticks[i].SdlJoystickGuid}";
+                Log.Information("No connected joystick available to swap for {playerIndex}", playerIndex);
+                continue;
+            }
 
-                if (newId != oldId)
-                {
-                    inputConfig["id"] = newId;
+            var oldId = inputConfig["id"]?.ToString();
+            var newId = $"{joysticks[i].SdlDeviceIndex}-{joysticks[i].SdlJoystickGuid}";
 
-                    if (IsValidRyujinxInputDeviceId(oldId))
-                    {
-                        result.SwappedJoysticks.Add(new SwappedJoystickResult { InputIndex = i, OldInputId = ConvertRyujinxInputDeviceIdToGuid(oldId) });
-                    }
+            if (newId != oldId)
+            {
+                inputConfig["id"] = newId;
+                inputConfigModified = true;
 
-                    Log.Information("Swapped input #{index}: {oldId} >> {newId}", i, oldId, newId);
-                }
-                else
+                if (IsValidRyujinxInputDeviceId(oldId))
                 {
-                    Log.Information("No change needed for input #{index} ({oldId})", i, oldId);
+                    result.SwappedJoysticks.Add(new SwappedJoystickResult { OldRyujinxDeviceId = oldId });
                 }
+
+                Log.Information("Swapped input {playerIndex}: {oldId} >> {newId}", playerIndex, oldId, newId);
             }
             else
             {
-                Log.Information("No connected joystick available to swap for input #{index}", i);
+                Log.Information("No change needed for input {playerIndex} ({oldId})", playerIndex, oldId);
             }
         }
 
-        result.ModifiedConfigJson = JsonConvert.SerializeObject(configData, Formatting.Indented);
+        if (inputConfigModified)
+        {
+            result.ModifiedConfigJson = JsonConvert.SerializeObject(configData, Formatting.Indented);
+        }
 
         return result;
     }
 
-    public static bool IsValidRyujinxInputDeviceId(string? deviceId)
+    private static int ParsePlayerIndex(string? jsonValue)
     {
-        return deviceId != null && Regex.IsMatch(deviceId, @"\d-.+");
+        if (String.IsNullOrEmpty(jsonValue) || !Regex.IsMatch(jsonValue, @"Player\d"))
+        {
+            throw new Exception($"PlayerIndex value did not match expected pattern: {jsonValue}");
+        }
+
+        return int.Parse(Regex.Match(jsonValue, @"Player(\d)").Groups[1].Value);
     }
 
-    public static Guid ConvertRyujinxInputDeviceIdToGuid(string value)
+    public static bool IsValidRyujinxInputDeviceId(string? deviceId)
     {
-        if (!RyujinxConfigHelper.IsValidRyujinxInputDeviceId(value))
-            throw new ArgumentException($"OldRyujinxInputId is not in the expected format: {value}");
-
-        return Guid.Parse(value.Substring(2));
+        return deviceId != null && Regex.IsMatch(deviceId, @"\d-.+");
     }
 }

JoystickHelper/Ryujinx/RyujinxLastSettings.cs

@@ -11,6 +11,6 @@ public RyujinxLastSettings(List<SwappedJoystickResult>? swappedJoysticks = null)
 
     internal IList<JoystickInfo> GetJoystickInfos()
     {
-        return SwappedJoysticks.Select(j => new JoystickInfo { SdlJoystickGuid = j.OldInputId }).ToList();
+        return SwappedJoysticks.Select(j => j.ToJoystickInfo()).Where(j => j != null).ToList();
     }
 }

JoystickHelper/Ryujinx/SetJoysticksResult.cs

@@ -10,7 +10,21 @@ public class SetJoysticksResult
 
     public class SwappedJoystickResult
     {
-        public int InputIndex { get; internal set; }
-        public Guid OldInputId { get; set; }
+        public string OldRyujinxDeviceId { get; set; }
+
+        public JoystickInfo ToJoystickInfo()
+        {
+            var match = Regex.Match(OldRyujinxDeviceId, @"(?<index>\d)-(?<guid>.+)");
+            if (!match.Success)
+            {
+                return null;
+            }
+
+            return new JoystickInfo
+            {
+                SdlJoystickGuid = Guid.Parse(match.Groups["guid"].Value),
+                SdlDeviceIndex = int.Parse(match.Groups["index"].Value)
+            };
+        }
     }
 }

JoystickHelper/SdlHelper.cs

@@ -28,7 +28,7 @@ public static IList<JoystickInfo> GetConnectedJoysticks(int maxJoysticks = 4)
             }
             else
             {
-                joysticks.Add(new JoystickInfo { SdlJoystickGuid = SDL.SDL_JoystickGetGUID(joystick) });
+                joysticks.Add(new JoystickInfo { SdlJoystickGuid = SDL.SDL_JoystickGetGUID(joystick), SdlDeviceIndex = i });
             }   
         }