Configurable UI for Settings to Mods menu and Mods Settings Menu

SongRankedBadge/Configuration/PluginConfig.cs

@@ -11,5 +11,6 @@ internal class PluginConfig
         public virtual bool ModEnable { get; set; } = true;
         public virtual bool DifferentText { get; set; } = true;
         public virtual bool DifferentColor { get; set; } = true;
+        public virtual bool SettingsMenuButton { get; set; } = false;
     }
 }

SongRankedBadge/Installers/MenuInstaller.cs

@@ -0,0 +1,21 @@
+using SongRankedBadge.Configuration;
+using SongRankedBadge.UI;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Zenject;
+
+namespace SongRankedBadge.Installers
+{
+    class MenuInstaller : Installer
+    {
+        public override void InstallBindings()
+        {
+            if (!PluginConfig.Instance.SettingsMenuButton)
+                Container.BindInterfacesTo<ModSettings>().FromNewComponentOnRoot().AsSingle();
+        }
+    }
+}

SongRankedBadge/Plugin.cs

@@ -11,9 +11,13 @@
 using UnityEngine;
 using UnityEngine.SceneManagement;
 using IPALogger = IPA.Logging.Logger;
+using Conf = IPA.Config.Config;
 using BeatSaberMarkupLanguage;
 using BeatSaberMarkupLanguage.MenuButtons;
 using BeatSaberMarkupLanguage.Util;
+using SongRankedBadge.Installers;
+using SongRankedBadge.Configuration;
+using SiraUtil.Zenject;
 
 namespace SongRankedBadge
 {
@@ -26,12 +30,12 @@ public class Plugin
 
         private readonly Harmony _harmony = new Harmony("com.github.qe201020335.SongRankedBadge");
 
-        private MenuButton MenuButton = new MenuButton("Ranked Badge", "PromoBadge? RankedBadge!", OnMenuButtonClick);
+        internal MenuButton MenuButton = new MenuButton("Ranked Badge", "PromoBadge? RankedBadge!", OnMenuButtonClick);
 
         private UI.ConfigViewFlowCoordinator? _configViewFlowCoordinator;
 
         [Init]
-        public void InitWithConfig(IPALogger logger, IPA.Config.Config conf)
+        public Plugin(IPALogger logger, Conf conf, Zenjector zenjector)
         {
             Instance = this;
             Log = logger;
@@ -41,12 +45,15 @@ public void InitWithConfig(IPALogger logger, IPA.Config.Config conf)
             Log.Debug("Config loaded");
             _harmony.PatchAll(Assembly.GetExecutingAssembly());
             MainMenuAwaiter.MainMenuInitializing += OnMenuLoad;
+
+            zenjector.UseLogger(logger);
+            zenjector.Install<MenuInstaller>(Location.Menu);
         }
 
         private void OnMenuLoad()
         {
-            Log.Debug("OnMenuLoad");
-            MenuButtons.Instance.RegisterButton(MenuButton);
+            if(PluginConfig.Instance.SettingsMenuButton)
+                MenuButtons.Instance.RegisterButton(MenuButton);
         }
 
         private static void OnMenuButtonClick()

SongRankedBadge/SongRankedBadge.csproj

@@ -24,17 +24,17 @@
     <Reference Include="BGLib.Polyglot">
       <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\BGLib.Polyglot.dll</HintPath>
     </Reference>
-      <Reference Include="BSML">
-          <HintPath>$(BeatSaberDir)\Plugins\BSML.dll</HintPath>
-          <Private>false</Private>
-      </Reference>
+    <Reference Include="BSML">
+      <HintPath>$(BeatSaberDir)\Plugins\BSML.dll</HintPath>
+      <Private>false</Private>
+    </Reference>
     <Reference Include="BeatSaber.ViewSystem">
       <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\BeatSaber.ViewSystem.dll</HintPath>
       <Private>false</Private>
     </Reference>
     <Reference Include="DataModels">
-        <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\DataModels.dll</HintPath>
-      </Reference>
+      <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\DataModels.dll</HintPath>
+    </Reference>
     <Reference Include="Interactable">
       <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\Interactable.dll</HintPath>
       <Private>false</Private>
@@ -43,11 +43,16 @@
       <HintPath>$(BeatSaberDir)\Libs\Newtonsoft.Json.dll</HintPath>
       <Private>false</Private>
     </Reference>
-      <Reference Include="SongCore">
-          <HintPath>$(BeatSaberDir)\Plugins\SongCore.dll</HintPath>
-          <Private>false</Private>
-      </Reference>
-      <Reference Include="SongDetailsCache">
+    <Reference Include="SiraUtil">
+      <HintPath>$(BeatSaberDir)\Plugins\SiraUtil.dll</HintPath>
+      <Private>False</Private>
+      <SpecificVersion>False</SpecificVersion>
+    </Reference>
+    <Reference Include="SongCore">
+      <HintPath>$(BeatSaberDir)\Plugins\SongCore.dll</HintPath>
+      <Private>false</Private>
+    </Reference>
+    <Reference Include="SongDetailsCache">
       <HintPath>$(BeatSaberDir)\Libs\SongDetailsCache.dll</HintPath>
       <Private>false</Private>
     </Reference>
@@ -101,8 +106,15 @@
       <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\UnityEngine.VRModule.dll</HintPath>
       <Private>False</Private>
     </Reference>
+    <Reference Include="Zenject">
+      <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\Zenject.dll</HintPath>
+      <Private>False</Private>
+      <SpecificVersion>False</SpecificVersion>
+    </Reference>
+    <Reference Include="Zenject-usage">
+      <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\Zenject-usage.dll</HintPath>
+    </Reference>
   </ItemGroup>
-
   <ItemGroup>
     <EmbeddedResource Include="manifest.json" />
     <EmbeddedResource Include="UI\configMenu.bsml" />

SongRankedBadge/UI/ConfigViewFlowCoordinator.cs

@@ -1,5 +1,6 @@
 using BeatSaberMarkupLanguage;
 using HMUI;
+using SongRankedBadge.Configuration;
 using System;
 
 namespace SongRankedBadge.UI
@@ -41,6 +42,8 @@ protected override void BackButtonWasPressed(ViewController topController)
         {
             base.BackButtonWasPressed(topController);
             BeatSaberUI.MainFlowCoordinator.DismissFlowCoordinator(this);
+            if(!PluginConfig.Instance.SettingsMenuButton)
+                FindObjectOfType<MenuTransitionsHelper>().RestartGame();
         }
     }
 }

SongRankedBadge/UI/ModSettings.cs

@@ -0,0 +1,63 @@
+using BeatSaberMarkupLanguage.Attributes;
+using BeatSaberMarkupLanguage.MenuButtons;
+using BeatSaberMarkupLanguage.Settings;
+using SongRankedBadge.Configuration;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using UnityEngine;
+using Zenject;
+
+namespace SongRankedBadge.UI
+{
+    public class ModSettings : MonoBehaviour, IInitializable, INotifyPropertyChanged
+    {
+        private static PluginConfig Config => PluginConfig.Instance;
+        private GameplaySetupViewController? gameplaySetupViewController;
+        public event PropertyChangedEventHandler PropertyChanged = null!;
+
+        [UIValue("ModEnable")]
+        private bool ModEnable
+        {
+            get => Config.ModEnable;
+            set => Config.ModEnable = value;
+        }
+
+        [UIValue("DiffText")]
+        public bool DiffText
+        {
+            get => Config.DifferentText;
+            set => Config.DifferentText = value;
+        }
+
+        [UIValue("DiffColor")]
+        public bool DiffColor
+        {
+            get => Config.DifferentColor;
+            set => Config.DifferentColor = value;
+        }        
+
+        [UIValue("MenuSettings")]
+        public bool MenuSettings
+        {
+            get => Config.SettingsMenuButton;
+            set {
+                Config.SettingsMenuButton = value;
+
+                if(value)
+                    MenuButtons.Instance.RegisterButton(Plugin.Instance.MenuButton);
+                else
+                    MenuButtons.Instance.UnregisterButton(Plugin.Instance.MenuButton);
+            }
+        }
+
+        public void Initialize()
+        {
+            BSMLSettings.Instance.AddSettingsMenu("Ranked Badge", "SongRankedBadge.UI.configMenu.bsml", this);
+        }
+    }  
+}
+

SongRankedBadge/UI/SettingMenuController.cs

@@ -4,6 +4,11 @@
 using BeatSaberMarkupLanguage.ViewControllers;
 using SongRankedBadge.Configuration;
 using TMPro;
+using BeatSaberMarkupLanguage.MenuButtons;
+using BeatSaberMarkupLanguage.Components;
+using UnityEngine;
+using UnityEngine.PlayerLoop;
+using System.ComponentModel;
 
 namespace SongRankedBadge.UI
 {
@@ -12,24 +17,23 @@ namespace SongRankedBadge.UI
     [ViewDefinition("SongRankedBadge.UI.configMenu.bsml")]
     internal class SettingMenuController : BSMLAutomaticViewController
     {
-
         private static PluginConfig Config => PluginConfig.Instance;
+        public event PropertyChangedEventHandler PropertyChanged = null!;
 
         [UIValue("ModEnable")]
         private bool ModEnable
         {
             get => Config.ModEnable;
             set => Config.ModEnable = value;
         }
-
 
         [UIValue("DiffText")]
         public bool DiffText
         {
             get => Config.DifferentText;
             set => Config.DifferentText = value;
         }
-        
+
 
         [UIValue("DiffColor")]
         public bool DiffColor
@@ -38,5 +42,11 @@ public bool DiffColor
             set => Config.DifferentColor = value;
         }
 
+        [UIValue("MenuSettings")]
+        public bool MenuSettings
+        {
+            get => Config.SettingsMenuButton;
+            set => Config.SettingsMenuButton = value;
+        }
     }
 }

SongRankedBadge/UI/configMenu.bsml

@@ -3,5 +3,6 @@
         <bool-setting text="Mod Enable" value="ModEnable" apply-on-change="true"/>
         <bool-setting text="Different Text" value="DiffText" hover-hint="Use different badge texts for BL and SS" apply-on-change="true"/>
         <bool-setting text="Different Color" value="DiffColor" hover-hint="Use different badge colors for BL and SS" apply-on-change="true"/>
+        <bool-setting text="Show Settings In Main Menu" value="MenuSettings" hover-hint="Show the mod settings within the Mods tab within the Main Menu" apply-on-change="true"/>
     </vertical>
 </settings-container>

SongRankedBadge/manifest.json

@@ -10,6 +10,7 @@
     "BSIPA": "^4.2.2",
     "SongDetailsCache": "^1.2.2",
     "SongCore": "^3.13.0",
-    "BeatSaberMarkupLanguage": "^1.12.0"
+    "BeatSaberMarkupLanguage": "^1.12.0",
+    "SiraUtil": "^3.1.12"
   }
 }