Add Configurable descriptions as tooltips.

common/Scripting/StoryboardObjectGenerator.cs

@@ -136,8 +136,9 @@ private Stream openFile(string path, bool watch)
 
         #region Random
 
-        [Configurable(DisplayName = "Random seed")]
-        public int RandomSeed;
+        [Group("Common")]
+        [Description("Changes the result of Random(...) calls.")]
+        [Configurable] public int RandomSeed;
 
         private Random random;
         public int Random(int minValue, int maxValue) => random.Next(minValue, maxValue);
@@ -228,7 +229,7 @@ public FontGenerator LoadFont(string directory, FontDescription description, par
         public FontGenerator LoadFont(string directory, bool asAsset, FontDescription description, params FontEffect[] effects)
         {
             var assetDirectory = asAsset ? context.ProjectAssetPath : context.MapsetPath;
-            
+
             var fontDirectory = Path.GetFullPath(Path.Combine(assetDirectory, directory));
             if (fontDirectories.Contains(fontDirectory))
                 throw new InvalidOperationException($"This effect already generated a font inside \"{fontDirectory}\"");
@@ -310,7 +311,7 @@ public void UpdateConfiguration(EffectConfig config)
                 {
                     var displayName = configurableField.Attribute.DisplayName;
                     var initialValue = Convert.ChangeType(configurableField.InitialValue, fieldType, CultureInfo.InvariantCulture);
-                    config.UpdateField(field.Name, displayName, configurableField.Order, fieldType, initialValue, allowedValues, configurableField.BeginsGroup);
+                    config.UpdateField(field.Name, displayName, configurableField.Description, configurableField.Order, fieldType, initialValue, allowedValues, configurableField.BeginsGroup);
 
                     var value = config.GetValue(field.Name);
                     field.SetValue(this, value);
@@ -361,13 +362,15 @@ private void initializeConfigurableFields()
                     continue;
 
                 var group = field.GetCustomAttribute<GroupAttribute>(true);
+                var description = field.GetCustomAttribute<DescriptionAttribute>(true);
 
                 configurableFields.Add(new ConfigurableField()
                 {
                     Field = field,
                     Attribute = configurable,
                     InitialValue = field.GetValue(this),
-                    BeginsGroup = group?.Name,
+                    BeginsGroup = group?.Name?.Trim(),
+                    Description = description?.Content?.Trim(),
                     Order = order++,
                 });
             }
@@ -379,6 +382,7 @@ private struct ConfigurableField
             public ConfigurableAttribute Attribute;
             public object InitialValue;
             public string BeginsGroup;
+            public string Description;
             public int Order;
 
             public override string ToString() => $"{Field.Name} {InitialValue}";

common/Storyboarding/DescriptionAttribute.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace StorybrewCommon.Storyboarding
+{
+    [AttributeUsage(AttributeTargets.Field)]
+    public class DescriptionAttribute : Attribute
+    {
+        public string Content { get; set; }
+
+        public DescriptionAttribute(string content)
+        {
+            Content = content;
+        }
+    }
+}

common/Storyboarding/EffectConfig.cs

@@ -32,7 +32,7 @@ public string[] FieldNames
             }
         }
 
-        public void UpdateField(string name, string displayName, int order, Type fieldType, object defaultValue, NamedValue[] allowedValues, string beginsGroup)
+        public void UpdateField(string name, string displayName, string description, int order, Type fieldType, object defaultValue, NamedValue[] allowedValues, string beginsGroup)
         {
             if (fieldType == null)
                 return;
@@ -62,6 +62,7 @@ public void UpdateField(string name, string displayName, int order, Type fieldTy
             {
                 Name = name,
                 DisplayName = displayName,
+                Description = description?.Trim(),
                 Value = value,
                 Type = fieldType,
                 AllowedValues = allowedValues,
@@ -84,9 +85,11 @@ public bool SetValue(string name, object value)
             {
                 Name = field.Name,
                 DisplayName = field.DisplayName,
+                Description = field.Description,
                 Value = value,
                 Type = field.Type,
                 AllowedValues = field.AllowedValues,
+                BeginsGroup = field.BeginsGroup,
                 Order = field.Order,
             };
             return true;
@@ -114,6 +117,7 @@ public struct ConfigField
         {
             public string Name;
             public string DisplayName;
+            public string Description;
             public object Value;
             public Type Type;
             public NamedValue[] AllowedValues;

common/common.csproj

@@ -96,6 +96,7 @@
     <Compile Include="Storyboarding3d\Sprite3d.cs" />
     <Compile Include="Storyboarding\Commands\CommandComparer.cs" />
     <Compile Include="Storyboarding\Commands\IFragmentableCommand.cs" />
+    <Compile Include="Storyboarding\DescriptionAttribute.cs" />
     <Compile Include="Storyboarding\GroupAttribute.cs" />
     <Compile Include="Storyboarding\OsbAnimationWriter.cs" />
     <Compile Include="Storyboarding\OsbSpriteWriter.cs" />

editor/Resources/skin_drawables.json

@@ -163,11 +163,10 @@
 
 		"groupBg":
 		{
-			_type: "NinePatch",
-			Texture: "ui-rounded-borders.png",
-			Borders: [3, 5, 5, 3],
+			_type: "Sprite",
+			Texture: "ui-stripes.png",
 			Color: "@colorGroupBg",
-			Outset: [2, 2],
+			ScaleMode: "Fill",
 		},
 
 		"previewBg":

editor/Resources/skin_styles.json

@@ -26,7 +26,7 @@
 			{
 				FontSize: "@fontSizeNormal",
 				Color: "@colorGroupText",
-				TextAlignment: "Centre",
+				TextAlignment: "Left",
 				Background: "groupBg",
 			},
 			"listHeader":

editor/Resources/ui-stripes-opt.json

@@ -0,0 +1,2 @@
+{
+}

editor/Storyboarding/Project.cs

@@ -577,7 +577,7 @@ private void loadBinary(string path)
                                     Value = allowedValue,
                                 };
                             }
-                            effect.Config.UpdateField(fieldName, fieldDisplayName, fieldIndex, fieldValue?.GetType(), fieldValue, allowedValues, null);
+                            effect.Config.UpdateField(fieldName, fieldDisplayName, null, fieldIndex, fieldValue?.GetType(), fieldValue, allowedValues, null);
                         }
                     }
                 }
@@ -792,7 +792,7 @@ private void loadText(string path)
                                 .Select(p => new NamedValue { Name = p.Key, Value = ObjectSerializer.FromString(fieldTypeName, p.Value.Value<string>()), })
                                 .ToArray();
 
-                        effect.Config.UpdateField(fieldProperty.Key, fieldRoot.Value<string>("DisplayName"), fieldIndex++, fieldValue?.GetType(), fieldValue, allowedValues, beginsGroup);
+                        effect.Config.UpdateField(fieldProperty.Key, fieldRoot.Value<string>("DisplayName"), null, fieldIndex++, fieldValue?.GetType(), fieldValue, allowedValues, beginsGroup);
                     }
 
                     var layersRoot = effectRoot.Value<TinyObject>("Layers");

editor/UserInterface/Components/EffectConfigUi.cs

@@ -167,7 +167,9 @@ private void updateFields()
                 if (currentGroup != null)
                     displayName = Regex.Replace(displayName, $@"^{Regex.Escape(currentGroup)}\s+", "");
 
-                var description = $"Variable: {field.Name}";
+                var description = $"Variable: {field.Name} ({field.Type.Name})";
+                if (!string.IsNullOrWhiteSpace(field.Description))
+                    description = "  " + description + "\n" + field.Description;
 
                 configFieldsLayout.Add(new LinearLayout(Manager)
                 {

editor/editor.csproj

@@ -150,6 +150,7 @@
     <Compile Include="Util\OsuHelper.cs" />
     <Compile Include="Util\NetHelper.cs" />
     <EmbeddedResource Include="Resources\project\vscode_settings.json" />
+    <EmbeddedResource Include="Resources\ui-stripes-opt.json" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />
@@ -196,6 +197,9 @@
       <Install>false</Install>
     </BootstrapperPackage>
   </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="Resources\ui-stripes.png" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>

scripts/Background.cs

@@ -6,10 +6,12 @@ namespace StorybrewScripts
 {
     public class Background : StoryboardObjectGenerator
     {
+        [Group("Timing")]
         [Configurable] public int StartTime = 0;
         [Configurable] public int EndTime = 0;
 
         [Group("Sprite")]
+        [Description("Leave empty to automatically use the map's background.")]
         [Configurable] public string SpritePath = "";
         [Configurable] public double Opacity = 0.2;
 

scripts/HitObjectHighlight.cs

@@ -6,6 +6,7 @@ namespace StorybrewScripts
 {
     public class HitObjectHighlight : StoryboardObjectGenerator
     {
+        [Group("Timing")]
         [Configurable] public int StartTime = 0;
         [Configurable] public int EndTime = 0;
         [Configurable] public int BeatDivisor = 8;

scripts/ImportOsb.cs

@@ -12,9 +12,10 @@ namespace StorybrewScripts
 {
     public class ImportOsb : StoryboardObjectGenerator
     {
+        [Description("Path to the .osb to import, relative to the project folder.")]
         [Configurable] public string Path = "storyboard.osb";
 
-        private Dictionary<string, string> variables = new Dictionary<string, string>();
+        private readonly Dictionary<string, string> variables = new Dictionary<string, string>();
 
         public override void Generate()
         {

scripts/Karaoke.cs

@@ -12,13 +12,18 @@ namespace StorybrewScripts
 {
     public class Karaoke : StoryboardObjectGenerator
     {
+        [Description("Path to a .sbv, .srt, .ass or .ssa file in your project's folder.\nThese can be made with a tool like aegisub.")]
         [Configurable] public string SubtitlesPath = "lyrics.srt";
         [Configurable] public float SubtitleY = 400;
 
         [Group("Font")]
+        [Description("The name of a system font, or the path to a font relative to your project's folder.\nIt is preferable to add fonts to the project folder and use their file name rather than installing fonts.")]
         [Configurable] public string FontName = "Verdana";
+        [Description("A path inside your mapset's folder where lyrics images will be generated.")]
         [Configurable] public string SpritesPath = "sb/f";
+        [Description("The Size of the font.\nIncreasing the font size creates larger images.")]
         [Configurable] public int FontSize = 26;
+        [Description("The Scale of the font.\nIncreasing the font scale does not creates larger images, but the result may be blurrier.")]
         [Configurable] public float FontScale = 0.5f;
         [Configurable] public Color4 FontColor = Color4.White;
         [Configurable] public FontStyle FontStyle = FontStyle.Regular;
@@ -39,6 +44,7 @@ public class Karaoke : StoryboardObjectGenerator
         [Group("Misc")]
         [Configurable] public bool TrimTransparency = true;
         [Configurable] public bool EffectsOnly = false;
+        [Description("How much extra space is allocated around the text when generating it.\nShould be increased when characters look cut off.")]
         [Configurable] public Vector2 Padding = Vector2.Zero;
         [Configurable] public OsbOrigin Origin = OsbOrigin.Centre;
 

scripts/Lyrics.cs

@@ -11,13 +11,18 @@ namespace StorybrewScripts
 {
     public class Lyrics : StoryboardObjectGenerator
     {
+        [Description("Path to a .sbv, .srt, .ass or .ssa file in your project's folder.\nThese can be made with a tool like aegisub.")]
         [Configurable] public string SubtitlesPath = "lyrics.srt";
         [Configurable] public float SubtitleY = 400;
 
         [Group("Font")]
+        [Description("The name of a system font, or the path to a font relative to your project's folder.\nIt is preferable to add fonts to the project folder and use their file name rather than installing fonts.")]
         [Configurable] public string FontName = "Verdana";
+        [Description("A path inside your mapset's folder where lyrics images will be generated.")]
         [Configurable] public string SpritesPath = "sb/f";
+        [Description("The Size of the font.\nIncreasing the font size creates larger images.")]
         [Configurable] public int FontSize = 26;
+        [Description("The Scale of the font.\nIncreasing the font scale does not creates larger images, but the result may be blurrier.")]
         [Configurable] public float FontScale = 0.5f;
         [Configurable] public Color4 FontColor = Color4.White;
         [Configurable] public FontStyle FontStyle = FontStyle.Regular;
@@ -39,6 +44,7 @@ public class Lyrics : StoryboardObjectGenerator
         [Configurable] public bool PerCharacter = true;
         [Configurable] public bool TrimTransparency = true;
         [Configurable] public bool EffectsOnly = false;
+        [Description("How much extra space is allocated around the text when generating it.\nShould be increased when characters look cut off.")]
         [Configurable] public Vector2 Padding = Vector2.Zero;
         [Configurable] public OsbOrigin Origin = OsbOrigin.Centre;
 

scripts/Particles.cs

@@ -11,28 +11,37 @@ namespace StorybrewScripts
 {
     public class Particles : StoryboardObjectGenerator
     {
+        [Group("Timing")]
         [Configurable] public int StartTime;
         [Configurable] public int EndTime;
-        [Configurable] public int ParticleCount = 32;
-        [Configurable] public float Lifetime = 1000;
 
         [Group("Sprite")]
         [Configurable] public string Path = "sb/particle.png";
         [Configurable] public OsbOrigin Origin = OsbOrigin.Centre;
         [Configurable] public Vector2 Scale = new Vector2(1, 1);
+        [Description("Rotation of the sprite; does not influences particle motion direction.")]
         [Configurable] public float Rotation = 0;
         [Configurable] public Color4 Color = Color4.White;
+        [Description("Varies the saturation and brightness of the selected Color for each particle.")]
         [Configurable] public float ColorVariance = 0.6f;
         [Configurable] public bool Additive = false;
 
         [Group("Spawn")]
+        [Configurable] public int ParticleCount = 32;
+        [Configurable] public float Lifetime = 1000;
+        [Description("The point around which particles will be created.")]
         [Configurable] public Vector2 SpawnOrigin = new Vector2(420, 0);
+        [Description("The distance around the Spawn Origin point where particles will be created.")]
         [Configurable] public float SpawnSpread = 360;
 
         [Group("Motion")]
+        [Description("The angle in degrees at which particles will be moving.\n0 is to the right, positive values rotate counterclockwise.")]
         [Configurable] public float Angle = 110;
+        [Description("The spread in degrees around Angle.")]
         [Configurable] public float AngleSpread = 60;
+        [Description("The speed at which particles move, in osupixels.")]
         [Configurable] public float Speed = 480;
+        [Description("Eases the motion of particles.")]
         [Configurable] public OsbEasing Easing = OsbEasing.None;
 
         public override void Generate()

scripts/RadialSpectrum.cs

@@ -12,20 +12,27 @@ namespace StorybrewScripts
     /// </summary>
     public class RadialSpectrum : StoryboardObjectGenerator
     {
+        [Group("Timing")]
         [Configurable] public int StartTime = 0;
         [Configurable] public int EndTime = 10000;
-        [Configurable] public Vector2 Position = new Vector2(320, 240);
         [Configurable] public int BeatDivisor = 8;
-        [Configurable] public int BarCount = 20;
+
+        [Group("Sprite")]
         [Configurable] public string SpritePath = "sb/bar.png";
         [Configurable] public OsbOrigin SpriteOrigin = OsbOrigin.Centre;
         [Configurable] public Vector2 SpriteScale = Vector2.One;
+
+        [Group("Bars")]
+        [Configurable] public Vector2 Position = new Vector2(320, 240);
+        [Configurable] public int BarCount = 20;
         [Configurable] public int Radius = 50;
         [Configurable] public float Scale = 50;
         [Configurable] public int LogScale = 600;
+        [Configurable] public OsbEasing FftEasing = OsbEasing.InExpo;
+
+        [Group("Optimization")]
         [Configurable] public double Tolerance = 2;
         [Configurable] public int CommandDecimals = 0;
-        [Configurable] public OsbEasing FftEasing = OsbEasing.InExpo;
         [Configurable] public int FrequencyCutOff = 16000;
 
         public override void Generate()