Merge pull request #8642 from smoogipoo/mania-skin-note-images

Implement mania note + key image configs

osu.Game.Rulesets.Mania/Skinning/ManiaLegacySkinTransformer.cs

@@ -40,7 +40,7 @@ namespace osu.Game.Rulesets.Mania.Skinning
         {
             isLegacySkin = new Lazy<bool>(() => source.GetConfig<LegacySkinConfiguration.LegacySetting, decimal>(LegacySkinConfiguration.LegacySetting.Version) != null);
             hasKeyTexture = new Lazy<bool>(() => source.GetAnimation(
-                source.GetConfig<ManiaSkinConfigurationLookup, string>(
+                GetConfig<ManiaSkinConfigurationLookup, string>(
                     new ManiaSkinConfigurationLookup(LegacyManiaSkinConfigurationLookups.KeyImage, 0))?.Value
                 ?? "mania-key1", true, true) != null);
         }

osu.Game/Skinning/LegacyManiaSkinConfiguration.cs

@@ -25,6 +25,8 @@ namespace osu.Game.Skinning
 
         public Dictionary<string, Color4> CustomColours { get; set; } = new Dictionary<string, Color4>();
 
+        public Dictionary<string, string> ImageLookups = new Dictionary<string, string>();
+
         public readonly float[] ColumnLineWidth;
         public readonly float[] ColumnSpacing;
         public readonly float[] ColumnWidth;

osu.Game/Skinning/LegacyManiaSkinDecoder.cs

@@ -71,12 +71,6 @@ namespace osu.Game.Skinning
             {
                 var pair = SplitKeyVal(line);
 
-                if (pair.Key.StartsWith("Colour"))
-                {
-                    HandleColours(currentConfig, line);
-                    continue;
-                }
-
                 switch (pair.Key)
                 {
                     case "ColumnLineWidth":
@@ -110,6 +104,18 @@ namespace osu.Game.Skinning
                     case "WidthForNoteHeightScale":
                         currentConfig.MinimumColumnWidth = float.Parse(pair.Value, CultureInfo.InvariantCulture) * LegacyManiaSkinConfiguration.POSITION_SCALE_FACTOR;
                         break;
+
+                    case string _ when pair.Key.StartsWith("Colour"):
+                        HandleColours(currentConfig, line);
+                        break;
+
+                    case string _ when pair.Key.StartsWith("NoteImage"):
+                        currentConfig.ImageLookups[pair.Key] = pair.Value;
+                        break;
+
+                    case string _ when pair.Key.StartsWith("KeyImage"):
+                        currentConfig.ImageLookups[pair.Key] = pair.Value;
+                        break;
                 }
             }
 

osu.Game/Skinning/LegacySkin.cs

@@ -207,6 +207,30 @@ namespace osu.Game.Skinning
 
                 case LegacyManiaSkinConfigurationLookups.MinimumColumnWidth:
                     return SkinUtils.As<TValue>(new Bindable<float>(existing.MinimumColumnWidth));
+
+                case LegacyManiaSkinConfigurationLookups.NoteImage:
+                    Debug.Assert(maniaLookup.TargetColumn != null);
+                    return SkinUtils.As<TValue>(getManiaImage(existing, $"NoteImage{maniaLookup.TargetColumn}"));
+
+                case LegacyManiaSkinConfigurationLookups.HoldNoteHeadImage:
+                    Debug.Assert(maniaLookup.TargetColumn != null);
+                    return SkinUtils.As<TValue>(getManiaImage(existing, $"NoteImage{maniaLookup.TargetColumn}H"));
+
+                case LegacyManiaSkinConfigurationLookups.HoldNoteTailImage:
+                    Debug.Assert(maniaLookup.TargetColumn != null);
+                    return SkinUtils.As<TValue>(getManiaImage(existing, $"NoteImage{maniaLookup.TargetColumn}T"));
+
+                case LegacyManiaSkinConfigurationLookups.HoldNoteBodyImage:
+                    Debug.Assert(maniaLookup.TargetColumn != null);
+                    return SkinUtils.As<TValue>(getManiaImage(existing, $"NoteImage{maniaLookup.TargetColumn}L"));
+
+                case LegacyManiaSkinConfigurationLookups.KeyImage:
+                    Debug.Assert(maniaLookup.TargetColumn != null);
+                    return SkinUtils.As<TValue>(getManiaImage(existing, $"KeyImage{maniaLookup.TargetColumn}"));
+
+                case LegacyManiaSkinConfigurationLookups.KeyImageDown:
+                    Debug.Assert(maniaLookup.TargetColumn != null);
+                    return SkinUtils.As<TValue>(getManiaImage(existing, $"KeyImage{maniaLookup.TargetColumn}D"));
             }
 
             return null;
@@ -215,6 +239,9 @@ namespace osu.Game.Skinning
         private IBindable<Color4> getCustomColour(IHasCustomColours source, string lookup)
             => source.CustomColours.TryGetValue(lookup, out var col) ? new Bindable<Color4>(col) : null;
 
+        private IBindable<string> getManiaImage(LegacyManiaSkinConfiguration source, string lookup)
+            => source.ImageLookups.TryGetValue(lookup, out var image) ? new Bindable<string>(image) : null;
+
         public override Drawable GetDrawableComponent(ISkinComponent component)
         {
             switch (component)
@@ -243,21 +270,24 @@ namespace osu.Game.Skinning
 
         public override Texture GetTexture(string componentName)
         {
-            componentName = getFallbackName(componentName);
-
-            float ratio = 2;
-            var texture = Textures?.Get($"{componentName}@2x");
-
-            if (texture == null)
+            foreach (var name in getFallbackNames(componentName))
             {
-                ratio = 1;
-                texture = Textures?.Get(componentName);
+                float ratio = 2;
+                var texture = Textures?.Get($"{name}@2x");
+
+                if (texture == null)
+                {
+                    ratio = 1;
+                    texture = Textures?.Get(name);
+                }
+
+                if (texture != null)
+                    texture.ScaleAdjust = ratio;
+
+                return texture;
             }
 
-            if (texture != null)
-                texture.ScaleAdjust = ratio;
-
-            return texture;
+            return null;
         }
 
         public override SampleChannel GetSample(ISampleInfo sampleInfo)
@@ -277,10 +307,14 @@ namespace osu.Game.Skinning
             return null;
         }
 
-        private string getFallbackName(string componentName)
+        private IEnumerable<string> getFallbackNames(string componentName)
         {
+            // May be something like "Gameplay/osu/approachcircle" from lazer, or "Arrows/note1" from a user skin.
+            yield return componentName;
+
+            // Fall back to using the last piece for components coming from lazer (e.g. "Gameplay/osu/approachcircle" -> "approachcircle").
             string lastPiece = componentName.Split('/').Last();
-            return componentName.StartsWith("Gameplay/taiko/") ? "taiko-" + lastPiece : lastPiece;
+            yield return componentName.StartsWith("Gameplay/taiko/") ? "taiko-" + lastPiece : lastPiece;
         }
     }
 }

osu.Game/Skinning/LegacySkinResourceStore.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using osu.Framework.Extensions;
 using osu.Framework.IO.Stores;
 using osu.Game.Database;
 
@@ -27,7 +28,7 @@ namespace osu.Game.Skinning
 
             foreach (var filename in base.GetFilenames(name))
             {
-                var path = getPathForFile(filename);
+                var path = getPathForFile(filename.ToStandardisedPath());
                 if (path != null)
                     yield return path;
             }