Merge pull request #224 from minisbett/mod-options-parameter

Add `--mod-option` parameter to simulate command
ppy · Oct 23, 2024 · 27dbd33 · 27dbd33
2 parents 73ea94e + 87fc84f
commit 27dbd33
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 69 deletions.
diff --git a/PerformanceCalculator/Difficulty/DifficultyCommand.cs b/PerformanceCalculator/Difficulty/DifficultyCommand.cs
@@ -12,9 +12,7 @@
 using Newtonsoft.Json;
 using osu.Game.Beatmaps;
 using osu.Game.Online.API;
-using osu.Game.Rulesets;
 using osu.Game.Rulesets.Difficulty;
-using osu.Game.Rulesets.Mods;
 
 namespace PerformanceCalculator.Difficulty
 {
@@ -36,6 +34,11 @@ public class DifficultyCommand : ProcessorCommand
                                                                                           + "Values: hr, dt, hd, fl, ez, 4k, 5k, etc...")]
         public string[] Mods { get; }
 
+        [UsedImplicitly]
+        [Option(CommandOptionType.MultipleValue, Template = "-o|--mod-option <option>",
+            Description = "The options of mods, with one for each setting. Specified as acryonym_settingkey=value. Example: DT_speed_change=1.35")]
+        public string[] ModOptions { get; set; } = [];
+
         public override void Execute()
         {
             var resultSet = new ResultSet();
@@ -63,9 +66,6 @@ public override void Execute()
                 string json = JsonConvert.SerializeObject(resultSet);
 
                 Console.WriteLine(json);
-
-                if (OutputFile != null)
-                    File.WriteAllText(OutputFile, json);
             }
             else
             {
@@ -120,7 +120,7 @@ private Result processBeatmap(WorkingBeatmap beatmap)
         {
             // Get the ruleset
             var ruleset = LegacyHelper.GetRulesetFromLegacyID(Ruleset ?? beatmap.BeatmapInfo.Ruleset.OnlineID);
-            var mods = getMods(ruleset);
+            var mods = ParseMods(ruleset, Mods, ModOptions);
             var attributes = ruleset.CreateDifficultyCalculator(beatmap).Calculate(mods);
 
             return new Result
@@ -133,26 +133,6 @@ private Result processBeatmap(WorkingBeatmap beatmap)
             };
         }
 
-        private Mod[] getMods(Ruleset ruleset)
-        {
-            var mods = new List<Mod>();
-            if (Mods == null)
-                return Array.Empty<Mod>();
-
-            var availableMods = ruleset.CreateAllMods().ToList();
-
-            foreach (var modString in Mods)
-            {
-                Mod newMod = availableMods.FirstOrDefault(m => string.Equals(m.Acronym, modString, StringComparison.CurrentCultureIgnoreCase));
-                if (newMod == null)
-                    throw new ArgumentException($"Invalid mod provided: {modString}");
-
-                mods.Add(newMod);
-            }
-
-            return mods.ToArray();
-        }
-
         private class ResultSet
         {
             [JsonProperty("errors")]

diff --git a/PerformanceCalculator/Difficulty/LegacyScoreAttributesCommand.cs b/PerformanceCalculator/Difficulty/LegacyScoreAttributesCommand.cs
@@ -62,9 +62,6 @@ public override void Execute()
                 string json = JsonConvert.SerializeObject(resultSet);
 
                 Console.WriteLine(json);
-
-                if (OutputFile != null)
-                    File.WriteAllText(OutputFile, json);
             }
             else
             {

diff --git a/PerformanceCalculator/Leaderboard/LeaderboardCommand.cs b/PerformanceCalculator/Leaderboard/LeaderboardCommand.cs
@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.IO;
 using System.Linq;
 using Alba.CsConsoleFormat;
 using JetBrains.Annotations;
@@ -98,9 +97,6 @@ public override void Execute()
                 var json = JsonConvert.SerializeObject(calculatedPlayers);
 
                 Console.Write(json);
-
-                if (OutputFile != null)
-                    File.WriteAllText(OutputFile, json);
             }
             else
             {

diff --git a/PerformanceCalculator/ProcessorCommand.cs b/PerformanceCalculator/ProcessorCommand.cs
@@ -12,7 +12,9 @@
 using McMaster.Extensions.CommandLineUtils;
 using Newtonsoft.Json;
 using osu.Game.Online.API;
+using osu.Game.Rulesets;
 using osu.Game.Rulesets.Difficulty;
+using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Scoring;
 
@@ -26,10 +28,6 @@ public abstract class ProcessorCommand
         /// </summary>
         public IConsole Console { get; private set; }
 
-        [UsedImplicitly]
-        [Option(Template = "-o|--output <file.txt>", Description = "Output results to text file.")]
-        public string OutputFile { get; }
-
         [UsedImplicitly]
         [Option(Template = "-j|--json", Description = "Output results as JSON.")]
         public bool OutputJson { get; }
@@ -65,9 +63,6 @@ public void OutputPerformance(ScoreInfo score, PerformanceAttributes performance
                 string json = JsonConvert.SerializeObject(result, Formatting.Indented);
 
                 Console.WriteLine(json);
-
-                if (OutputFile != null)
-                    File.WriteAllText(OutputFile, json);
             }
             else
             {
@@ -131,15 +126,44 @@ public void OutputDocument(Document document)
                 str = string.Join('\n', lines);
 
                 Console.Write(str);
-                if (OutputFile != null)
-                    File.WriteAllText(OutputFile, str);
             }
         }
 
         public virtual void Execute()
         {
         }
 
+        public static Mod[] ParseMods(Ruleset ruleset, string[] acronyms, string[] options)
+        {
+            acronyms ??= [];
+            options ??= [];
+
+            if (acronyms.Length == 0)
+                return [];
+
+            var mods = new List<Mod>();
+
+            foreach (var acronym in acronyms)
+            {
+                APIMod mod = new APIMod { Acronym = acronym };
+
+                foreach (string optionString in options.Where(x => x.StartsWith($"{acronym}_", StringComparison.CurrentCultureIgnoreCase)))
+                {
+                    string optionTuple = optionString[(acronym.Length + 1)..];
+
+                    string[] split = optionTuple.Split('=');
+                    if (split.Length != 2)
+                        throw new ArgumentException($"Invalid mod-option format (key=value): {optionTuple}");
+
+                    mod.Settings[split[0]] = split[1];
+                }
+
+                mods.Add(mod.ToMod(ruleset));
+            }
+
+            return mods.ToArray();
+        }
+
         private class Result
         {
             [JsonProperty("score")]

diff --git a/PerformanceCalculator/Profile/ProfileCommand.cs b/PerformanceCalculator/Profile/ProfileCommand.cs
@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.IO;
 using System.Linq;
 using Alba.CsConsoleFormat;
 using JetBrains.Annotations;
@@ -109,9 +108,6 @@ public override void Execute()
                 });
 
                 Console.Write(json);
-
-                if (OutputFile != null)
-                    File.WriteAllText(OutputFile, json);
             }
             else
             {

diff --git a/PerformanceCalculator/Simulate/SimulateCommand.cs b/PerformanceCalculator/Simulate/SimulateCommand.cs
@@ -4,12 +4,10 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
-using System.Linq;
 using JetBrains.Annotations;
 using McMaster.Extensions.CommandLineUtils;
 using osu.Game.Beatmaps;
 using osu.Game.Rulesets;
-using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.Scoring;
 using osu.Game.Scoring;
 
@@ -32,6 +30,11 @@ public abstract class SimulateCommand : ProcessorCommand
         [Option(CommandOptionType.MultipleValue, Template = "-m|--mod <mod>", Description = "One for each mod. The mods to compute the performance with. Values: hr, dt, hd, fl, etc...")]
         public string[] Mods { get; }
 
+        [UsedImplicitly]
+        [Option(CommandOptionType.MultipleValue, Template = "-o|--mod-option <option>",
+            Description = "The options of mods, with one for each setting. Specified as acryonym_settingkey=value. Example: DT_speed_change=1.35")]
+        public string[] ModOptions { get; set; } = [];
+
         [UsedImplicitly]
         [Option(Template = "-X|--misses <misses>", Description = "Number of misses. Defaults to 0.")]
         public int Misses { get; }
@@ -59,7 +62,7 @@ public override void Execute()
             var ruleset = Ruleset;
 
             var workingBeatmap = ProcessorWorkingBeatmap.FromFileOrId(Beatmap);
-            var mods = GetMods(ruleset);
+            var mods = ParseMods(ruleset, Mods, ModOptions);
             var beatmap = workingBeatmap.GetPlayableBeatmap(ruleset.RulesetInfo, mods);
 
             var beatmapMaxCombo = GetMaxCombo(beatmap);
@@ -80,26 +83,6 @@ public override void Execute()
             OutputPerformance(scoreInfo, performanceAttributes, difficultyAttributes);
         }
 
-        protected Mod[] GetMods(Ruleset ruleset)
-        {
-            if (Mods == null)
-                return Array.Empty<Mod>();
-
-            var availableMods = ruleset.CreateAllMods().ToList();
-            var mods = new List<Mod>();
-
-            foreach (var modString in Mods)
-            {
-                Mod newMod = availableMods.FirstOrDefault(m => string.Equals(m.Acronym, modString, StringComparison.CurrentCultureIgnoreCase));
-                if (newMod == null)
-                    throw new ArgumentException($"Invalid mod provided: {modString}");
-
-                mods.Add(newMod);
-            }
-
-            return mods.ToArray();
-        }
-
         protected abstract int GetMaxCombo(IBeatmap beatmap);
 
         protected abstract Dictionary<HitResult, int> GenerateHitResults(double accuracy, IBeatmap beatmap, int countMiss, int? countMeh, int? countGood);