Merge branch 'master' into master

src/Ryujinx/Assets/locales.json

@@ -447,6 +447,31 @@
         "zh_TW": "開啟 Ryujinx 資料夾"
       }
     },
+    {
+      "ID": "MenuBarFileOpenScreenshotsFolder",
+      "Translations": {
+        "ar_SA": "",
+        "de_DE": "",
+        "el_GR": "",
+        "en_US": "Open Screenshots Folder",
+        "es_ES": "",
+        "fr_FR": "",
+        "he_IL": "",
+        "it_IT": "",
+        "ja_JP": "",
+        "ko_KR": "",
+        "no_NO": "",
+        "pl_PL": "",
+        "pt_BR": "",
+        "ru_RU": "",
+        "sv_SE": "",
+        "th_TH": "",
+        "tr_TR": "",
+        "uk_UA": "",
+        "zh_CN": "",
+        "zh_TW": ""
+      }
+    },
     {
       "ID": "MenuBarFileOpenLogsFolder",
       "Translations": {
@@ -17297,6 +17322,31 @@
         "zh_TW": "開啟 Ryujinx 檔案系統資料夾"
       }
     },
+    {
+      "ID": "OpenScreenshotFolderTooltip",
+      "Translations": {
+        "ar_SA": "",
+        "de_DE": "",
+        "el_GR": "",
+        "en_US": "Open Ryujinx screenshots folder",
+        "es_ES": "",
+        "fr_FR": "",
+        "he_IL": "",
+        "it_IT": "",
+        "ja_JP": "",
+        "ko_KR": "",
+        "no_NO": "",
+        "pl_PL": "",
+        "pt_BR": "",
+        "ru_RU": "",
+        "sv_SE": "",
+        "th_TH": "",
+        "tr_TR": "",
+        "uk_UA": "",
+        "zh_CN": "",
+        "zh_TW": ""
+      }
+    },
     {
       "ID": "OpenRyujinxLogsTooltip",
       "Translations": {

src/Ryujinx/DiscordIntegrationModule.cs

@@ -56,6 +56,7 @@ namespace Ryujinx.Ava
             ConfigurationState.Instance.EnableDiscordIntegration.Event += Update;
             TitleIDs.CurrentApplication.Event += (_, e) => Use(e.NewValue);
             HorizonStatic.PlayReport += HandlePlayReport;
+            PlayReports.Initialize();
         }
 
         private static void Update(object sender, ReactiveEventArgs<bool> evnt)

src/Ryujinx/UI/Controls/ApplicationDataView.axaml

@@ -119,8 +119,11 @@
                         TextWrapping="Wrap" >
                     </TextBlock>
                 </StackPanel>
-                <StackPanel Orientation="Horizontal" Spacing="5">
+                <StackPanel Orientation="Horizontal" Spacing="5" ToolTip.Tip="{Binding DynamicRichPresenceDescription}">
-                    <ui:SymbolIcon Foreground="ForestGreen" Symbol="Checkmark" IsVisible="{Binding AppData.HasDynamicRichPresenceSupport}"/>
+                    <ui:SymbolIcon 
+                        Foreground="ForestGreen" 
+                        Symbol="Checkmark" 
+                        IsVisible="{Binding AppData.HasDynamicRichPresenceSupport}"/>
                     <TextBlock
                         Foreground="ForestGreen"
                         HorizontalAlignment="Stretch"
@@ -129,7 +132,10 @@
                         TextAlignment="Start"
                         TextWrapping="Wrap">
                     </TextBlock>
-                    <ui:SymbolIcon Foreground="Red" Symbol="Cancel" IsVisible="{Binding !AppData.HasDynamicRichPresenceSupport}"/>
+                    <ui:SymbolIcon 
+                        Foreground="Red" 
+                        Symbol="Cancel" 
+                        IsVisible="{Binding !AppData.HasDynamicRichPresenceSupport}"/>
                     <TextBlock
                         Foreground="Red"
                         HorizontalAlignment="Stretch"

src/Ryujinx/UI/ViewModels/ApplicationDataViewModel.cs

@@ -1,6 +1,7 @@
 using Gommon;
 using Ryujinx.Ava.Common.Locale;
 using Ryujinx.Ava.Utilities.AppLibrary;
+using Ryujinx.Ava.Utilities.PlayReport;
 
 namespace Ryujinx.Ava.UI.ViewModels
 {
@@ -10,6 +11,11 @@ namespace Ryujinx.Ava.UI.ViewModels
 
         public ApplicationDataViewModel(ApplicationData appData) => AppData = appData;
 
+        public string DynamicRichPresenceDescription =>
+            AppData.HasDynamicRichPresenceSupport
+                ? AppData.RichPresenceSpec.Value.Description
+                : GameSpec.DefaultDescription;
+
         public string FormattedVersion => LocaleManager.Instance[LocaleKeys.GameListHeaderVersion].Format(AppData.Version);
         public string FormattedDeveloper => LocaleManager.Instance[LocaleKeys.GameListHeaderDeveloper].Format(AppData.Developer);
         public string FormattedFileExtension => LocaleManager.Instance[LocaleKeys.GameListHeaderFileExtension].Format(AppData.FileExtension);

src/Ryujinx/UI/ViewModels/MainWindowViewModel.cs

@@ -1352,6 +1352,25 @@ namespace Ryujinx.Ava.UI.ViewModels
             OpenHelper.OpenFolder(AppDataManager.BaseDirPath);
         }
 
+        public void OpenScreenshotsFolder()
+        {
+            string screenshotsDir = Path.Combine(AppDataManager.BaseDirPath, "screenshots");
+
+            try
+            {
+                if (!Directory.Exists(screenshotsDir))
+                    Directory.CreateDirectory(screenshotsDir);
+            }
+            catch (Exception ex)
+            {
+                Logger.Error?.Print(LogClass.Application, $"Failed to create directory at path {screenshotsDir}. Error : {ex.GetType().Name}", "Screenshot");
+
+                return;
+            }
+            
+            OpenHelper.OpenFolder(screenshotsDir);
+        }
+
         public void OpenLogsFolder()
         {
             string logPath = AppDataManager.GetOrCreateLogsDir();

src/Ryujinx/UI/Views/Main/MainMenuBarView.axaml

@@ -66,6 +66,10 @@
                     Command="{Binding OpenRyujinxFolder}"
                     Header="{ext:Locale MenuBarFileOpenEmuFolder}"
                     ToolTip.Tip="{ext:Locale OpenRyujinxFolderTooltip}" />
+                <MenuItem
+                    Command="{Binding OpenScreenshotsFolder}"
+                    Header="{ext:Locale MenuBarFileOpenScreenshotsFolder}"
+                    ToolTip.Tip="{ext:Locale OpenScreenshotFolderTooltip}"/>
                 <MenuItem
                     Command="{Binding OpenLogsFolder}"
                     Header="{ext:Locale MenuBarFileOpenLogsFolder}"

src/Ryujinx/Utilities/AppLibrary/ApplicationData.cs

@@ -10,6 +10,7 @@ using LibHac.Tools.FsSystem;
 using LibHac.Tools.FsSystem.NcaUtils;
 using Ryujinx.Ava.Common.Locale;
 using Ryujinx.Ava.Utilities.Compat;
+using Ryujinx.Ava.Utilities.PlayReport;
 using Ryujinx.Common.Logging;
 using Ryujinx.HLE.FileSystem;
 using Ryujinx.HLE.Loaders.Processes.Extensions;
@@ -36,9 +37,14 @@ namespace Ryujinx.Ava.Utilities.AppLibrary
             {
                 _id = value;
 
-                Compatibility = CompatibilityCsv.Find(Id);
+                Compatibility = CompatibilityCsv.Find(value);
+                RichPresenceSpec = PlayReports.Analyzer.TryGetSpec(IdString, out GameSpec gameSpec) 
+                    ? gameSpec 
+                    : default(Optional<GameSpec>);
             }
         }
+        public Optional<GameSpec> RichPresenceSpec { get; set; }
+        
         public string Developer { get; set; } = "Unknown";
         public string Version { get; set; } = "0";
         public int PlayerCount { get; set; }
@@ -47,7 +53,7 @@ namespace Ryujinx.Ava.Utilities.AppLibrary
         public bool HasLdnGames => PlayerCount != 0 && GameCount != 0;
 
         public bool HasRichPresenceAsset => DiscordIntegrationModule.HasAssetImage(IdString);
-        public bool HasDynamicRichPresenceSupport => DiscordIntegrationModule.HasAnalyzer(IdString);
+        public bool HasDynamicRichPresenceSupport => RichPresenceSpec.HasValue;
         
         public TimeSpan TimePlayed { get; set; }
         public DateTime? LastPlayed { get; set; }

src/Ryujinx/Utilities/PlayReport/Analyzer.cs

@@ -1,5 +1,6 @@
 using Gommon;
 using Ryujinx.Ava.Utilities.AppLibrary;
+using Ryujinx.Common.Logging;
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
@@ -19,6 +20,11 @@ namespace Ryujinx.Ava.Utilities.PlayReport
 
         public IReadOnlyList<GameSpec> Specs => new ReadOnlyCollection<GameSpec>(_specs);
 
+        public GameSpec GetSpec(string titleId) => _specs.First(x => x.TitleIds.ContainsIgnoreCase(titleId));
+
+        public bool TryGetSpec(string titleId, out GameSpec gameSpec)
+            => (gameSpec = _specs.FirstOrDefault(x => x.TitleIds.ContainsIgnoreCase(titleId))) != null;
+
         /// <summary>
         /// Add an analysis spec matching a specific game by title ID, with the provided spec configuration.
         /// </summary>
@@ -27,10 +33,12 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <returns>The current <see cref="Analyzer"/>, for chaining convenience.</returns>
         public Analyzer AddSpec(string titleId, Func<GameSpec, GameSpec> transform)
         {
-            Guard.Ensure(ulong.TryParse(titleId, NumberStyles.HexNumber, null, out _),
+            if (ulong.TryParse(titleId, NumberStyles.HexNumber, null, out _))
-                $"Cannot use a non-hexadecimal string as the Title ID for a {nameof(GameSpec)}.");
-
                 return AddSpec(transform(GameSpec.Create(titleId)));
+
+            Logger.Notice.PrintMsg(LogClass.Application,
+                $"Tried to add a {nameof(GameSpec)} with a non-hexadecimal title ID value. Input: '{titleId}'");
+            return this;
         }
 
         /// <summary>
@@ -41,10 +49,12 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <returns>The current <see cref="Analyzer"/>, for chaining convenience.</returns>
         public Analyzer AddSpec(string titleId, Action<GameSpec> transform)
         {
-            Guard.Ensure(ulong.TryParse(titleId, NumberStyles.HexNumber, null, out _),
+            if (ulong.TryParse(titleId, NumberStyles.HexNumber, null, out _))
-                $"Cannot use a non-hexadecimal string as the Title ID for a {nameof(GameSpec)}.");
-
                 return AddSpec(GameSpec.Create(titleId).Apply(transform));
+
+            Logger.Notice.PrintMsg(LogClass.Application,
+                $"Tried to add a {nameof(GameSpec)} with a non-hexadecimal title ID value. Input: '{titleId}'");
+            return this;
         }
 
         /// <summary>
@@ -57,10 +67,19 @@ namespace Ryujinx.Ava.Utilities.PlayReport
             Func<GameSpec, GameSpec> transform)
         {
             string[] tids = titleIds.ToArray();
-            Guard.Ensure(tids.All(x => ulong.TryParse(x, NumberStyles.HexNumber, null, out _)),
+            if (tids.All(x => ulong.TryParse(x, NumberStyles.HexNumber, null, out _) && !string.IsNullOrEmpty(x)))
-                $"Cannot use a non-hexadecimal string as the Title ID for a {nameof(GameSpec)}.");
-
                 return AddSpec(transform(GameSpec.Create(tids)));
+
+            Logger.Notice.PrintMsg(LogClass.Application,
+                $"Tried to add a {nameof(GameSpec)} with a non-hexadecimal title ID value. Input: '{
+                    tids.FormatCollection(
+                        x => x,
+                        separator: ", ",
+                        prefix: "[",
+                        suffix: "]"
+                    )
+                }'");
+            return this;
         }
 
         /// <summary>
@@ -72,10 +91,19 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         public Analyzer AddSpec(IEnumerable<string> titleIds, Action<GameSpec> transform)
         {
             string[] tids = titleIds.ToArray();
-            Guard.Ensure(tids.All(x => ulong.TryParse(x, NumberStyles.HexNumber, null, out _)),
+            if (tids.All(x => ulong.TryParse(x, NumberStyles.HexNumber, null, out _) && !string.IsNullOrEmpty(x)))
-                $"Cannot use a non-hexadecimal string as the Title ID for a {nameof(GameSpec)}.");
-
                 return AddSpec(GameSpec.Create(tids).Apply(transform));
+
+            Logger.Notice.PrintMsg(LogClass.Application,
+                $"Tried to add a {nameof(GameSpec)} with a non-hexadecimal title ID value. Input: '{
+                    tids.FormatCollection(
+                        x => x,
+                        separator: ", ",
+                        prefix: "[",
+                        suffix: "]"
+                    )
+                }'");
+            return this;
         }
 
         /// <summary>
@@ -106,12 +134,12 @@ namespace Ryujinx.Ava.Utilities.PlayReport
             if (!playReport.ReportData.IsDictionary)
                 return FormattedValue.Unhandled;
             
-            if (!_specs.TryGetFirst(s => runningGameId.EqualsAnyIgnoreCase(s.TitleIds), out GameSpec spec))
+            if (!TryGetSpec(runningGameId, out GameSpec spec))
                 return FormattedValue.Unhandled;
 
             foreach (FormatterSpecBase formatSpec in spec.ValueFormatters.OrderBy(x => x.Priority))
             {
-                if (!formatSpec.Format(appMeta, playReport, out FormattedValue value))
+                if (!formatSpec.TryFormat(appMeta, playReport, out FormattedValue value))
                     continue;
 
                 return value;

src/Ryujinx/Utilities/PlayReport/PlayReports.Formatters.cs

@@ -1,4 +1,5 @@
 using Gommon;
+using Humanizer;
 using System;
 using System.Buffers.Binary;
 using System.Collections.Generic;
@@ -19,6 +20,9 @@ namespace Ryujinx.Ava.Utilities.PlayReport
                 _ => "Roaming Hyrule"
             };
         
+        private static FormattedValue SkywardSwordHD_Rupees(SingleValue value)
+            => "rupee".ToQuantity(value.Matched.IntValue);
+
         private static FormattedValue SuperMarioOdyssey_AssistMode(SingleValue value)
             => value.Matched.BoxedValue is 1 ? "Playing in Assist Mode" : "Playing in Regular Mode";
 

src/Ryujinx/Utilities/PlayReport/PlayReports.cs

@@ -1,11 +1,22 @@
-namespace Ryujinx.Ava.Utilities.PlayReport
+using System;
+
+namespace Ryujinx.Ava.Utilities.PlayReport
 {
     public static partial class PlayReports
     {
-        public static Analyzer Analyzer { get; } = new Analyzer()
+        public static void Initialize()
+        {
+            // init lazy value
+            _ = Analyzer;
+        }
+
+        public static Analyzer Analyzer => _analyzerLazy.Value;
+
+        private static readonly Lazy<Analyzer> _analyzerLazy = new(() => new Analyzer()
             .AddSpec(
                 "01007ef00011e000",
                 spec => spec
+                    .WithDescription("based on being in Master Mode.")
                     .AddValueFormatter("IsHardMode", BreathOfTheWild_MasterMode)
                     // reset to normal status when switching between normal & master mode in title screen
                     .AddValueFormatter("AoCVer", FormattedValue.SingleAlwaysResets)
@@ -13,34 +24,49 @@
             .AddSpec(
                 "0100f2c0115b6000",
                 spec => spec
+                    .WithDescription("based on where you are in Hyrule (Depths, Surface, Sky).")
                     .AddValueFormatter("PlayerPosY", TearsOfTheKingdom_CurrentField))
+            .AddSpec(
+                "01002da013484000",
+                spec => spec
+                    .WithDescription("based on how many Rupees you have.")
+                    .AddValueFormatter("rupees", SkywardSwordHD_Rupees))
             .AddSpec(
                 "0100000000010000",
-                spec =>
+                spec => spec
-                    spec.AddValueFormatter("is_kids_mode", SuperMarioOdyssey_AssistMode)
+                    .WithDescription("based on if you're playing with Assist Mode.")
+                    .AddValueFormatter("is_kids_mode", SuperMarioOdyssey_AssistMode)
             )
             .AddSpec(
                 "010075000ecbe000",
-                spec =>
+                spec => spec
-                    spec.AddValueFormatter("is_kids_mode", SuperMarioOdysseyChina_AssistMode)
+                    .WithDescription("based on if you're playing with Assist Mode.")
+                    .AddValueFormatter("is_kids_mode", SuperMarioOdysseyChina_AssistMode)
             )
             .AddSpec(
                 "010028600ebda000",
-                spec => spec.AddValueFormatter("mode", SuperMario3DWorldOrBowsersFury)
+                spec => spec
+                    .WithDescription("based on being in either Super Mario 3D World or Bowser's Fury.")
+                    .AddValueFormatter("mode", SuperMario3DWorldOrBowsersFury)
             )
             .AddSpec( // Global & China IDs
                 ["0100152000022000", "010075100e8ec000"],
-                spec => spec.AddValueFormatter("To", MarioKart8Deluxe_Mode)
+                spec => spec
+                    .WithDescription(
+                        "based on what modes you're selecting in the menu & whether or not you're in a race.")
+                    .AddValueFormatter("To", MarioKart8Deluxe_Mode)
             )
             .AddSpec(
                 ["0100a3d008c5c000", "01008f6008c5e000"],
                 spec => spec
+                    .WithDescription("based on what area of Paldea you're exploring.")
                     .AddValueFormatter("area_no", PokemonSVArea)
                     .AddValueFormatter("team_circle", PokemonSVUnionCircle)
             )
             .AddSpec(
                 "01006a800016e000",
                 spec => spec
+                    .WithDescription("based on what mode you're playing, who won, and what characters were present.")
                     .AddSparseMultiValueFormatter(
                         [
                             // Metadata to figure out what PlayReport we have.
@@ -59,8 +85,13 @@
             .AddSpec(
                 [
                     "0100c9a00ece6000", "01008d300c50c000", "0100d870045b6000",
-                    "010012f017576000", "0100c62011050000", "0100b3c014bda000"],
+                    "010012f017576000", "0100c62011050000", "0100b3c014bda000"
-                spec => spec.AddValueFormatter("launch_title_id", NsoEmulator_LaunchedGame)
+                ],
+                spec => spec
+                    .WithDescription(
+                        "based on what game you first launch.\n\nNSO emulators do not print any Play Report information past the first game launch so it's all we got.")
+                    .AddValueFormatter("launch_title_id", NsoEmulator_LaunchedGame)
+            )
         );
 
         private static string Playing(string game) => $"Playing {game}";

src/Ryujinx/Utilities/PlayReport/Specs.cs

@@ -23,6 +23,20 @@ namespace Ryujinx.Ava.Utilities.PlayReport
 
         public required string[] TitleIds { get; init; }
 
+        public const string DefaultDescription = "Formats the details on your Discord presence based on logged data from the game.";
+
+        private string _valueDescription;
+
+        public string Description => _valueDescription ?? DefaultDescription;
+
+        public GameSpec WithDescription(string description)
+        {
+            _valueDescription = description != null
+                ? $"Formats the details on your Discord presence {description}"
+                : null;
+            return this;
+        }
+        
         public List<FormatterSpecBase> ValueFormatters { get; } = [];
 
 
@@ -197,7 +211,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         public string[] ReportKeys { get; init; }
         public Delegate Formatter { get; init; }
 
-        public bool Format(ApplicationMetadata appMeta, Horizon.Prepo.Types.PlayReport playReport,
+        public bool TryFormat(ApplicationMetadata appMeta, Horizon.Prepo.Types.PlayReport playReport,
             out FormattedValue formattedValue)
         {
             formattedValue = default;