Carrier: Add the ability to hide the default fields.

Casterlabs · Jan 11, 2024 · 2807ab6 · 2807ab6
1 parent 842fdcb
commit 2807ab6
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 32 deletions.
diff --git a/Base/src/main/java/co/casterlabs/caffeinated/sesl/SESL.java b/Base/src/main/java/co/casterlabs/caffeinated/sesl/SESL.java
@@ -38,7 +38,6 @@
 import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsDropdownBuilder;
 import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsFileBuilder;
 import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsFontBuilder;
-import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsNumberBuilder;
 import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsRangeBuilder;
 import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsTextBuilder;
 import co.casterlabs.caffeinated.util.MimeTypes;
@@ -55,36 +54,11 @@ public class SESL {
     @SuppressWarnings("deprecation")
     public static WidgetSettingsLayout generateLayout(SESLWidget widget) {
         try {
-            WidgetSettingsLayout layout = new WidgetSettingsLayout();
-
             Map<String, WidgetSettingsSection> sections = new HashMap<>();
-            sections.put("settings", new WidgetSettingsSection("settings", "Settings"));
-
-            // Default Streamlabs fields.
-            switch (widget.getShimType()) {
-                case "chatbox": {
-                    // We intentionally leave out background_color.
-                    sections.get("settings")
-                        .addItem(
-                            new WidgetSettingsColorBuilder()
-                                .withId("text_color")
-                                .withName("Text Color")
-                                .withDefaultValue("#ffffff")
-                                .build()
-                        )
-                        .addItem(
-                            new WidgetSettingsNumberBuilder()
-                                .withId("font_size")
-                                .withName("Font Size (px)")
-                                .withStep(1)
-                                .withMin(0)
-                                .withMax(80)
-                                .withDefaultValue(18)
-                                .build()
-                        );
-                    // TODO the rest...
-                    break;
-                }
+
+            WidgetSettingsSection defaultSection = widget.getDefaultFields();
+            if (defaultSection != null) {
+                sections.put(defaultSection.getId(), defaultSection);
             }
 
             // Convert the custom fields.
@@ -243,10 +217,10 @@ public static WidgetSettingsLayout generateLayout(SESLWidget widget) {
                 section.addItem(input);
             }
 
+            WidgetSettingsLayout layout = new WidgetSettingsLayout();
             for (WidgetSettingsSection section : sections.values()) {
                 layout.addSection(section);
             }
-
             return layout;
         } catch (Throwable t) {
             LOGGER.fatal("An error occurred whilst building layout:\n%s", t);

diff --git a/Base/src/main/java/co/casterlabs/caffeinated/sesl/SESLWidget.java b/Base/src/main/java/co/casterlabs/caffeinated/sesl/SESLWidget.java
@@ -25,9 +25,14 @@
 
 import java.io.IOException;
 
+import org.jetbrains.annotations.Nullable;
+
 import co.casterlabs.caffeinated.pluginsdk.widgets.Widget;
 import co.casterlabs.caffeinated.pluginsdk.widgets.WidgetInstance;
 import co.casterlabs.caffeinated.pluginsdk.widgets.WidgetInstanceMode;
+import co.casterlabs.caffeinated.pluginsdk.widgets.settings.WidgetSettingsSection;
+import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsColorBuilder;
+import co.casterlabs.caffeinated.pluginsdk.widgets.settings.items.WidgetSettingsNumberBuilder;
 import co.casterlabs.rakurai.json.element.JsonObject;
 import lombok.NonNull;
 
@@ -45,6 +50,37 @@ public abstract class SESLWidget extends Widget {
 
     public abstract @NonNull String getCustomHTML();
 
+    @SuppressWarnings("deprecation")
+    public @Nullable WidgetSettingsSection getDefaultFields() {
+        // Default Streamlabs fields.
+        switch (this.getShimType()) {
+            case "chatbox":
+                // We intentionally leave out background_color.
+                return new WidgetSettingsSection("settings", "Settings")
+                    .addItem(
+                        new WidgetSettingsColorBuilder()
+                            .withId("text_color")
+                            .withName("Text Color")
+                            .withDefaultValue("#ffffff")
+                            .build()
+                    )
+                    .addItem(
+                        new WidgetSettingsNumberBuilder()
+                            .withId("font_size")
+                            .withName("Font Size (px)")
+                            .withStep(1)
+                            .withMin(0)
+                            .withMax(80)
+                            .withDefaultValue(18)
+                            .build()
+                    );
+
+            // TODO the rest...
+            default:
+                return null;
+        }
+    }
+
     @Override
     protected void onSettingsUpdate() {
         this.setSettingsLayout(SESL.generateLayout(this));

diff --git a/Modes/Carrier/src/main/java/co/casterlabs/caffeinated/sesl/carrier_mode/CarrierConfig.java b/Modes/Carrier/src/main/java/co/casterlabs/caffeinated/sesl/carrier_mode/CarrierConfig.java
@@ -40,6 +40,7 @@ public static class ConfigWidget {
         public String name;
         public WidgetDetailsCategory category;
         public String icon;
+        public boolean addDefaultFields;
     }
 
 }
diff --git a/Modes/Carrier/src/main/java/co/casterlabs/caffeinated/sesl/carrier_mode/CarrierWidget.java b/Modes/Carrier/src/main/java/co/casterlabs/caffeinated/sesl/carrier_mode/CarrierWidget.java
@@ -25,6 +25,9 @@
 
 import java.nio.charset.StandardCharsets;
 
+import org.jetbrains.annotations.Nullable;
+
+import co.casterlabs.caffeinated.pluginsdk.widgets.settings.WidgetSettingsSection;
 import co.casterlabs.caffeinated.sesl.SESL;
 import co.casterlabs.caffeinated.sesl.SESLWidget;
 import co.casterlabs.caffeinated.sesl.carrier_mode.CarrierConfig.ConfigWidget;
@@ -56,6 +59,15 @@ public CarrierWidget(ConfigWidget config) {
         this.customHTML = StreamUtil.toString(CarrierPlugin.class.getResourceAsStream("/sesl/" + config.id + "/custom.html"), StandardCharsets.UTF_8);
     }
 
+    @Override
+    public @Nullable WidgetSettingsSection getDefaultFields() {
+        if (this.config.addDefaultFields) {
+            return super.getDefaultFields();
+        } else {
+            return null;
+        }
+    }
+
     @Override
     public @NonNull String getShimType() {
         return this.config.type;

diff --git a/Modes/Carrier/src/main/resources/sesl/carrier.json b/Modes/Carrier/src/main/resources/sesl/carrier.json
@@ -7,7 +7,8 @@
 			"id": "my_chatbox",
 			"name": "My Chatbox",
 			"category": "OTHER",
-			"icon": "star"
+			"icon": "star",
+			"addDefaultFields": true
 		}
 	]
 }