From f5710d8000d3bc11c4a2065f411105c53e249914 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Mon, 22 Aug 2022 16:10:55 +0900
Subject: [PATCH] Add ruleset API versioning

---
 osu.Game.Rulesets.Catch/CatchRuleset.cs |  2 ++
 osu.Game.Rulesets.Mania/ManiaRuleset.cs |  2 ++
 osu.Game.Rulesets.Osu/OsuRuleset.cs     |  2 ++
 osu.Game.Rulesets.Taiko/TaikoRuleset.cs |  2 ++
 osu.Game/Rulesets/Ruleset.cs            | 17 +++++++++++++++++
 5 files changed, 25 insertions(+)

diff --git a/osu.Game.Rulesets.Catch/CatchRuleset.cs b/osu.Game.Rulesets.Catch/CatchRuleset.cs
index ed151855b1..f94bf276a0 100644
--- a/osu.Game.Rulesets.Catch/CatchRuleset.cs
+++ b/osu.Game.Rulesets.Catch/CatchRuleset.cs
@@ -43,6 +43,8 @@ public class CatchRuleset : Ruleset, ILegacyRuleset
 
         public const string SHORT_NAME = "fruits";
 
+        public override string RulesetAPIVersionSupported => "internal";
+
         public override IEnumerable<KeyBinding> GetDefaultKeyBindings(int variant = 0) => new[]
         {
             new KeyBinding(InputKey.Z, CatchAction.MoveLeft),
diff --git a/osu.Game.Rulesets.Mania/ManiaRuleset.cs b/osu.Game.Rulesets.Mania/ManiaRuleset.cs
index ac6060ceed..b1fe4b30c4 100644
--- a/osu.Game.Rulesets.Mania/ManiaRuleset.cs
+++ b/osu.Game.Rulesets.Mania/ManiaRuleset.cs
@@ -60,6 +60,8 @@ public class ManiaRuleset : Ruleset, ILegacyRuleset
 
         public const string SHORT_NAME = "mania";
 
+        public override string RulesetAPIVersionSupported => "internal";
+
         public override HitObjectComposer CreateHitObjectComposer() => new ManiaHitObjectComposer(this);
 
         public override ISkin CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => new ManiaLegacySkinTransformer(skin, beatmap);
diff --git a/osu.Game.Rulesets.Osu/OsuRuleset.cs b/osu.Game.Rulesets.Osu/OsuRuleset.cs
index 7f58f29d4b..4400dfbb65 100644
--- a/osu.Game.Rulesets.Osu/OsuRuleset.cs
+++ b/osu.Game.Rulesets.Osu/OsuRuleset.cs
@@ -54,6 +54,8 @@ public class OsuRuleset : Ruleset, ILegacyRuleset
 
         public const string SHORT_NAME = "osu";
 
+        public override string RulesetAPIVersionSupported => "internal";
+
         public override IEnumerable<KeyBinding> GetDefaultKeyBindings(int variant = 0) => new[]
         {
             new KeyBinding(InputKey.Z, OsuAction.LeftButton),
diff --git a/osu.Game.Rulesets.Taiko/TaikoRuleset.cs b/osu.Game.Rulesets.Taiko/TaikoRuleset.cs
index 04bb08395b..275c7144a7 100644
--- a/osu.Game.Rulesets.Taiko/TaikoRuleset.cs
+++ b/osu.Game.Rulesets.Taiko/TaikoRuleset.cs
@@ -49,6 +49,8 @@ public class TaikoRuleset : Ruleset, ILegacyRuleset
 
         public const string SHORT_NAME = "taiko";
 
+        public override string RulesetAPIVersionSupported => "internal";
+
         public override IEnumerable<KeyBinding> GetDefaultKeyBindings(int variant = 0) => new[]
         {
             new KeyBinding(InputKey.MouseLeft, TaikoAction.LeftCentre),
diff --git a/osu.Game/Rulesets/Ruleset.cs b/osu.Game/Rulesets/Ruleset.cs
index 0968d78ed7..63f5906f46 100644
--- a/osu.Game/Rulesets/Ruleset.cs
+++ b/osu.Game/Rulesets/Ruleset.cs
@@ -44,6 +44,23 @@ public abstract class Ruleset
 
         private static readonly ConcurrentDictionary<string, IMod[]> mod_reference_cache = new ConcurrentDictionary<string, IMod[]>();
 
+        /// <summary>
+        /// Version history:
+        /// 2022.205.0   FramedReplayInputHandler.CollectPendingInputs renamed to FramedReplayHandler.CollectReplayInputs.
+        /// 2022.822.0   All strings return values have been converted to LocalisableString to allow for localisation support.
+        /// </summary>
+        public const string CURRENT_RULESET_API_VERSION = "2022.822.0";
+
+        /// <summary>
+        /// Define the ruleset API version supported by this ruleset.
+        /// Ruleset implementations should be updated to support the latest version to ensure they can still be loaded.
+        /// </summary>
+        /// <remarks>
+        /// When updating a ruleset to support the latest API, you should set this to <see cref="CURRENT_RULESET_API_VERSION"/>.
+        /// See https://github.com/ppy/osu/wiki/Breaking-Changes for full details on required ongoing changes.
+        /// </remarks>
+        public virtual string RulesetAPIVersionSupported => string.Empty;
+
         /// <summary>
         /// A queryable source containing all available mods.
         /// Call <see cref="IMod.CreateInstance"/> for consumption purposes.