PlayReportAnalyzer: Added Games (#614)

Added Super Mario Odyssey, Super Mario Odyssey (China), Super Mario 3D
World + Bowser's Fury, Mario Kart 8 Deluxe and Mario Kart 8 Deluxe
(China)

docs/compatibility.csv

@@ -2483,7 +2483,7 @@
 0100A5200C2E0000,"Safety First!",,playable,2021-01-06 09:05:23
 0100A51013530000,"SaGa Frontier Remastered",nvdec,playable,2022-11-03 13:54:56
 010003A00D0B4000,"SaGa SCARLET GRACE: AMBITIONS™",,playable,2022-10-06 13:20:31
-01008D100D43E000,"Saints Row IV®: Re-Elected™",ldn-untested;LAN,playable,2023-12-04 18:33:37
+01008D100D43E000,"Saints Row IV®: Re-Elected™",ldn-untested;LAN;deadlock,ingame,2025-02-02 16:57:53
 0100DE600BEEE000,"SAINTS ROW®: THE THIRD™ - THE FULL PACKAGE",slow;LAN,playable,2023-08-24 02:40:58
 01007F000EB36000,"Sakai and...",nvdec,playable,2022-12-15 13:53:19
 0100B1400E8FE000,"Sakuna: Of Rice and Ruin",,playable,2023-07-24 13:47:13

src/Ryujinx.Common/Helpers/PlayReportAnalyzer.cs

@@ -0,0 +1,80 @@
+using Gommon;
+using MsgPack;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Ryujinx.Common.Helper
+{
+    public class PlayReportAnalyzer
+    {
+        private readonly List<PlayReportGameSpec> _specs = [];
+
+        public PlayReportAnalyzer AddSpec(string titleId, Func<PlayReportGameSpec, PlayReportGameSpec> transform)
+        {
+            _specs.Add(transform(new PlayReportGameSpec { TitleIdStr = titleId }));
+            return this;
+        }
+        
+        public PlayReportAnalyzer AddSpec(string titleId, Action<PlayReportGameSpec> transform)
+        {
+            _specs.Add(new PlayReportGameSpec { TitleIdStr = titleId }.Apply(transform));
+            return this;
+        }
+
+        public Optional<string> Run(string runningGameId, MessagePackObject playReport)
+        {
+            if (!playReport.IsDictionary) 
+                return Optional<string>.None;
+
+            if (!_specs.TryGetFirst(s => s.TitleIdStr.EqualsIgnoreCase(runningGameId), out PlayReportGameSpec spec))
+                return Optional<string>.None;
+
+            foreach (PlayReportValueFormatterSpec formatSpec in spec.Analyses.OrderBy(x => x.Priority))
+            {
+                if (!playReport.AsDictionary().TryGetValue(formatSpec.ReportKey, out MessagePackObject valuePackObject))
+                    continue;
+
+                return formatSpec.ValueFormatter(valuePackObject.ToObject());
+            }
+            
+            return Optional<string>.None;
+        }
+        
+    }
+
+    public class PlayReportGameSpec
+    {
+        public required string TitleIdStr { get; init; }
+        public List<PlayReportValueFormatterSpec> Analyses { get; } = [];
+
+        public PlayReportGameSpec AddValueFormatter(string reportKey, Func<object, string> valueFormatter)
+        {
+            Analyses.Add(new PlayReportValueFormatterSpec
+            {
+                Priority = Analyses.Count,
+                ReportKey = reportKey, 
+                ValueFormatter = valueFormatter
+            });
+            return this;
+        }
+        
+        public PlayReportGameSpec AddValueFormatter(int priority, string reportKey, Func<object, string> valueFormatter)
+        {
+            Analyses.Add(new PlayReportValueFormatterSpec
+            {
+                Priority = priority,
+                ReportKey = reportKey, 
+                ValueFormatter = valueFormatter
+            });
+            return this;
+        }
+    }
+
+    public struct PlayReportValueFormatterSpec
+    {
+        public required int Priority { get; init; }
+        public required string ReportKey { get; init; }
+        public required Func<object, string> ValueFormatter { get; init; }
+    }
+}

src/Ryujinx.Horizon/HorizonStatic.cs

@@ -7,7 +7,7 @@ namespace Ryujinx.Horizon
 {
     public static class HorizonStatic
     {
-        internal static void HandlePlayReport(MessagePackObject report) => PlayReportPrinted.Invoke(report);
+        internal static void HandlePlayReport(MessagePackObject report) => PlayReportPrinted?.Invoke(report);
         
         public static event Action<MessagePackObject> PlayReportPrinted;
         

src/Ryujinx/DiscordIntegrationModule.cs

@@ -5,6 +5,7 @@ using Ryujinx.Ava.Utilities;
 using Ryujinx.Ava.Utilities.AppLibrary;
 using Ryujinx.Ava.Utilities.Configuration;
 using Ryujinx.Common;
+using Ryujinx.Common.Helper;
 using Ryujinx.Common.Logging;
 using Ryujinx.HLE;
 using Ryujinx.HLE.Loaders.Processes;
@@ -23,12 +24,12 @@ namespace Ryujinx.Ava
         public static Timestamps GuestAppStartedAt { get; set; }
 
         private static string VersionString
-            => (ReleaseInformation.IsCanaryBuild ? "Canary " : string.Empty) + $"v{ReleaseInformation.Version}"; 
+            => (ReleaseInformation.IsCanaryBuild ? "Canary " : string.Empty) + $"v{ReleaseInformation.Version}";
 
-        private static readonly string _description = 
-            ReleaseInformation.IsValid 
-                    ? $"{VersionString} {ReleaseInformation.ReleaseChannelOwner}/{ReleaseInformation.ReleaseChannelSourceRepo}@{ReleaseInformation.BuildGitHash}" 
-                    : "dev build";
+        private static readonly string _description =
+            ReleaseInformation.IsValid
+                ? $"{VersionString} {ReleaseInformation.ReleaseChannelOwner}/{ReleaseInformation.ReleaseChannelSourceRepo}@{ReleaseInformation.BuildGitHash}"
+                : "dev build";
 
         private const string ApplicationId = "1293250299716173864";
 
@@ -45,8 +46,7 @@ namespace Ryujinx.Ava
             {
                 Assets = new Assets
                 {
-                    LargeImageKey = "ryujinx",
-                    LargeImageText = TruncateToByteLength(_description)
+                    LargeImageKey = "ryujinx", LargeImageText = TruncateToByteLength(_description)
                 },
                 Details = "Main Menu",
                 State = "Idling",
@@ -82,14 +82,44 @@ namespace Ryujinx.Ava
             }
         }
 
+        public static string MarioKart8(object obj)
+        {
+            return obj switch
+            {
+                // Single Player
+                "Single" => "Single Player",
+                // Multiplayer
+                "Multi-2players" => "Multiplayer 2 Players",
+                "Multi-3players" => "Multiplayer 3 Players",
+                "Multi-4players" => "Multiplayer 4 Players",
+                // Wireless/LAN Play
+                "Local-Single" => "Wireless/LAN Play",
+                "Local-2players" => "Wireless/LAN Play 2 Players",
+                // CC Classes
+                "50cc" => "50cc",
+                "100cc" => "100cc",
+                "150cc" => "150cc",
+                "Mirror" => "Mirror (150cc)",
+                "200cc" => "200cc",
+                // Modes
+                "GrandPrix" => "Grand Prix",
+                "TimeAttack" => "Time Trials",
+                "VS" => "VS Races",
+                "Battle" => "Battle Mode",
+                "RaceStart" => "Selecting a Course",
+                "Race" => "Racing",
+                _ => "Playing Mario Kart 8 Deluxe"
+            };
+        }
+
         public static void Use(Optional<string> titleId)
         {
             if (titleId.TryGet(out string tid))
                 SwitchToPlayingState(
-                    ApplicationLibrary.LoadAndSaveMetaData(tid), 
+                    ApplicationLibrary.LoadAndSaveMetaData(tid),
                     Switch.Shared.Processes.ActiveApplication
                 );
-            else 
+            else
                 SwitchToMainState();
         }
 
@@ -114,7 +144,7 @@ namespace Ryujinx.Ava
         {
             _discordClient?.SetPresence(_discordPresencePlaying ??= CreatePlayingState(appMeta, procRes));
         }
-        
+
         private static void UpdatePlayingState()
         {
             _discordClient?.SetPresence(_discordPresencePlaying);
@@ -126,37 +156,52 @@ namespace Ryujinx.Ava
             _discordPresencePlaying = null;
         }
         
+        private static readonly PlayReportAnalyzer _playReportAnalyzer = new PlayReportAnalyzer()
+            .AddSpec( // Breath of the Wild
+                "01007ef00011e000",
+                gameSpec =>
+                    gameSpec.AddValueFormatter("IsHardMode", val => val is 1 ? "Playing Master Mode" : "Playing Normal Mode")
+            )
+            .AddSpec( // Super Mario Odyssey
+                "0100000000010000",
+                gameSpec =>
+                    gameSpec.AddValueFormatter("is_kids_mode", val => val is 1 ? "Playing in Assist Mode" : "Playing in Regular Mode")
+            )
+            .AddSpec( // Super Mario Odyssey (China)
+                "010075000ECBE000",
+                gameSpec =>
+                    gameSpec.AddValueFormatter("is_kids_mode", val => val is 1 ? "Playing in 帮助模式" : "Playing in 普通模式")
+            )
+            .AddSpec( // Super Mario 3D World + Bowser's Fury
+                "010028600EBDA000",
+                gameSpec =>
+                    gameSpec.AddValueFormatter("mode", val => val is 0 ? "Playing Super Mario 3D World" : "Playing Bowser's Fury")
+            )
+            .AddSpec( // Mario Kart 8 Deluxe
+                "0100152000022000",
+                gameSpec =>
+                    gameSpec.AddValueFormatter("To", MarioKart8)
+            )
+            .AddSpec( // Mario Kart 8 Deluxe (China)
+                "010075100E8EC000",
+                gameSpec =>
+                    gameSpec.AddValueFormatter("To", MarioKart8)
+            );
+
         private static void HandlePlayReport(MessagePackObject playReport)
         {
             if (!TitleIDs.CurrentApplication.Value.HasValue) return;
             if (_discordPresencePlaying is null) return;
-            if (!playReport.IsDictionary) return;
 
-            foreach ((string titleId, (string reportKey, Func<object, string> formatter)) in _playReportValues)
-            {
-                if (!TitleIDs.CurrentApplication.Value.Value.EqualsIgnoreCase(titleId))
-                    continue;
-                
-                if (!playReport.AsDictionary().TryGetValue(reportKey, out MessagePackObject valuePackObject))
-                    return;
+            Optional<string> details = _playReportAnalyzer.Run(TitleIDs.CurrentApplication.Value, playReport);
 
-                _discordPresencePlaying.Details = formatter(valuePackObject.ToObject());
-                UpdatePlayingState();
-                Logger.Info?.Print(LogClass.UI, "Updated Discord RPC based on a supported play report.");
-            }
+            if (!details.HasValue) return;
+            
+            _discordPresencePlaying.Details = details;
+            UpdatePlayingState();
+            Logger.Info?.Print(LogClass.UI, "Updated Discord RPC based on a supported play report.");
         }
 
-        // title ID -> Play Report key & value formatter
-        private static readonly ReadOnlyDictionary<string, (string ReportKey, Func<object, string> Formatter)> 
-            _playReportValues = new(new Dictionary<string, (string ReportKey, Func<object, string> Formatter)>
-            {
-                {
-                    // Breath of the Wild Master Mode display
-                    "01007ef00011e000", 
-                    ("IsHardMode", val => val is 1 ? "Playing Master Mode" : "Playing Normal Mode")
-                }
-            });
-
         private static string TruncateToByteLength(string input)
         {
             if (Encoding.UTF8.GetByteCount(input) <= ApplicationByteLimit)