Add option to auto-skip the fail animation

Author: PulseLane

FastFail/Config.cs

@@ -0,0 +1,18 @@
+namespace FastFail
+{
+    class Config
+    {
+        public static BS_Utils.Utilities.Config config = new BS_Utils.Utilities.Config("FastFail");
+        public static bool autoSkip = false;
+
+        public static void Read()
+        {
+            autoSkip = config.GetBool("FastFail", "autoSkip", false, true);
+        }
+
+        public static void Write()
+        {
+            config.SetBool("FastFail", "autoSkip", autoSkip);
+        }
+    }
+}

FastFail/FailSkip.cs

@@ -22,20 +22,18 @@ class FailSkip : MonoBehaviour
 
         protected bool _standardLevel;
         protected bool _hasFailed = false;
+        protected bool autoSkip;
 
         public void Awake()
         {
-            Logger.Log("Awakening");
             _standardLevelGameplayManager = Resources.FindObjectsOfTypeAll<StandardLevelGameplayManager>().FirstOrDefault();
             if (_standardLevelGameplayManager)
             {
                 _standardLevelGameplayManager.levelFailedEvent += this.OnLevelFail;
                 _standardLevel = true;
-                Logger.Log("Standard");
             }
             else
             {
-                Logger.Log("Mission");
                 _missionLevelGameplayManager = Resources.FindObjectsOfTypeAll<MissionLevelGameplayManager>().FirstOrDefault();
                 _missionLevelGameplayManager.levelFailedEvent += this.OnLevelFail;
                 _standardLevel = false;
@@ -59,6 +57,8 @@ public void Awake()
 
             _vrControllersInputManager = Resources.FindObjectsOfTypeAll<PauseMenuManager>().FirstOrDefault()
                                             .GetField<VRControllersInputManager, PauseMenuManager>("_vrControllersInputManager");
+
+            autoSkip = Config.autoSkip;
         }
 
         public void OnLevelFail()
@@ -68,10 +68,8 @@ public void OnLevelFail()
 
         public void Update()
         {
-            if (_hasFailed && _vrControllersInputManager.MenuButtonDown())
+            if (_hasFailed && (autoSkip || _vrControllersInputManager.MenuButtonDown()))
             {
-                Logger.Log("pause button pressed during fail!");
-
                 if (_standardLevel)
                 {
                     _standardLevelFailedController.StopAllCoroutines();

FastFail/FastFail.csproj

@@ -32,6 +32,9 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="BSML">
+      <HintPath>E:\Steam\steamapps\common\Beat Saber\Plugins\BSML.dll</HintPath>
+    </Reference>
     <Reference Include="BS_Utils">
       <HintPath>E:\Steam\steamapps\common\Beat Saber\Plugins\BS_Utils.dll</HintPath>
     </Reference>
@@ -45,6 +48,9 @@
     <Reference Include="Main">
       <HintPath>E:\Steam\steamapps\common\Beat Saber\Beat Saber_Data\Managed\Main.dll</HintPath>
     </Reference>
+    <Reference Include="Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+      <HintPath>..\packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
+    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
     <Reference Include="System.Runtime.InteropServices.RuntimeInformation" />
@@ -66,17 +72,20 @@
     <Reference Include="UnityEngine.XRModule, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Config.cs" />
     <Compile Include="FailSkip.cs" />
     <Compile Include="Plugin.cs" />
     <Compile Include="Logger.cs" />
     <Compile Include="PluginConfig.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="UI\Settings.cs" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="manifest.json" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />
+    <EmbeddedResource Include="UI\settings.bsml" />
   </ItemGroup>
   <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

FastFail/Plugin.cs

@@ -1,9 +1,7 @@
-using BS_Utils;
+using BeatSaberMarkupLanguage.Settings;
+using FastFail.UI;
 using IPA;
 using IPALogger = IPA.Logging.Logger;
-using LogLevel = IPA.Logging.Logger.Level;
-using System;
-using System.Reflection;
 using UnityEngine;
 
 namespace FastFail
@@ -20,7 +18,9 @@ public void Init(IPALogger logger)
         [OnStart]
         public void OnStart()
         {
+            Config.Read();
             BS_Utils.Utilities.BSEvents.gameSceneLoaded += OnGameSceneLoaded;
+            BSMLSettings.instance.AddSettingsMenu("FastFail", "FastFail.UI.settings.bsml", Settings.instance);
         }
 
         private void OnGameSceneLoaded()

FastFail/UI/Settings.cs

@@ -0,0 +1,18 @@
+using BeatSaberMarkupLanguage.Attributes;
+
+namespace FastFail.UI
+{
+    class Settings : PersistentSingleton<Settings>
+    {
+        [UIValue("autoSkip")]
+        public bool autoSkip
+        {
+            get => Config.autoSkip;
+            set
+            {
+                Config.autoSkip = value;
+                Config.Write();
+            }
+        }
+    }
+}

FastFail/UI/settings.bsml

@@ -0,0 +1,3 @@
+<settings-container>
+  <checkbox text='Auto skip' value='autoSkip' hover-hint='If disabled, you will have to press the menu (pause) button to skip the fail animation'></checkbox>
+</settings-container>

FastFail/manifest.json

@@ -5,6 +5,6 @@
   "gameVersion": "1.8.0",
   "id": "FastFail",
   "name": "FastFail",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "features": []
 }

README.md

@@ -1,7 +1,4 @@
 # FastFail
 Beat Saber mod to make failing a song not take as long
 
-Desired features before 1.0 release:
-  * ~~Skip fail animation via button press~~
-  * ~~Support skipping mission fail~~
-  * Option to toggle between auto and manual skip
+By default, you must press the menu (pause) button to skip the fail animation, but there is an option to enable auto-skipping.