Merge pull request #82 from All-Of-Us-Mods/dev

MiraAPI 0.3.9

.gitignore

@@ -6,5 +6,4 @@ bin/
 .qodo/
 
 *.user
-*.lock.json
-.qodo
+*.lock.json

Directory.Build.props

@@ -8,7 +8,7 @@
 
         <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
 
-        <VersionPrefix>0.3.3</VersionPrefix>
+        <VersionPrefix>0.3.8</VersionPrefix>
         <VersionSuffix>dev</VersionSuffix>
 
         <Authors>All Of Us, XtraCube, Angxl</Authors>
@@ -42,4 +42,4 @@
     <PropertyGroup>
         <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)\stylecop.ruleset</CodeAnalysisRuleSet>
     </PropertyGroup>
-</Project>
+</Project>

MiraAPI.Example/ExampleEventHandlers.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System.Globalization;
+using System.Linq;
 using MiraAPI.Events;
 using MiraAPI.Events.Mira;
 using MiraAPI.Events.Vanilla.Gameplay;
@@ -17,7 +18,7 @@ public static class ExampleEventHandlers
 {
     public static void Initialize()
     {
-        // You can register event handlers with the MiraEventManager class.
+        // You can register event handlers with the MiraEventManager class
         var handle = MiraEventManager.RegisterEventHandler<BeforeMurderEvent>(@event =>
         {
             Logger<ExamplePlugin>.Info($"{@event.Source.Data.PlayerName} is about to kill {@event.Target.Data.PlayerName}");
@@ -37,6 +38,21 @@ public static class ExampleEventHandlers
         MiraEventManager.UnregisterEventHandler(handle);
     }
 
+    // If you want to check vanilla buttons, use something like this!
+    [RegisterEvent]
+    public static void VanillaButtonClickHandler(VanillaButtonClickEvent @event)
+    {
+        Logger<ExamplePlugin>.Info($"{@event.Button.buttonLabelText.text} is being used!");
+        if (@event.PlayerTarget != null)
+        {
+            Logger<ExamplePlugin>.Info($"{@event.PlayerTarget.Data.PlayerName} is being targeted!");
+        }
+        else if (@event.VentTarget != null)
+        {
+            Logger<ExamplePlugin>.Info($"Vent with id {@event.VentTarget.Id.ToString(CultureInfo.InvariantCulture)} is being targeted!");
+        }
+    }
+
     // If you want to add extra votes to a player, do something like this.
     [RegisterEvent]
     public static void StartMeetingEvent(StartMeetingEvent _)

MiraAPI.Example/Options/ExampleOptions.cs

@@ -19,14 +19,11 @@ public class ExampleOptions : AbstractOptionGroup
     [ModdedNumberOption("Number Opt", min: 0, max: 10, increment: .25f, formatString: "0.00", suffixType: MiraNumberSuffixes.Percent)]
     public float NumberOpt { get; set; } = 4f;
 
-    [ModdedEnumOption("Best API", typeof(AuApis), ["Mira API", "Mitochondria", "Reactor"])]
-    public AuApis BestApiOpt { get; set; } = AuApis.MiraAPI;
-
-    [ModdedEnumOption<AuApis>("Worst API", ["Mira API", "Mitochondria", "Reactor"])]
-    public AuApis WorstApiOpt { get; set; } = AuApis.Mitochondria;
+    [ModdedEnumOption("Best API", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
+    public BestApi Opt { get; set; } = BestApi.MiraAPI;
 }
 
-public enum AuApis
+public enum BestApi
 {
     MiraAPI,
     Mitochondria,

MiraAPI.Example/Options/ExampleOptions2.cs

@@ -23,12 +23,6 @@ public class ExampleOptions2 : AbstractOptionGroup
     {
         ChangedEvent = x => Logger<ExamplePlugin>.Info($"changed Enum Opt to {x}"),
     };
-
-    public ModdedMultiSelectOption<TestingData> MultiSelectOption { get; } = new(
-        "Emotions",
-        TestingData.Happy,
-        TestingData.All,
-        TestingData.None);
 }
 
 public enum TestingData : ulong
@@ -36,6 +30,4 @@ public enum TestingData : ulong
     Happy,
     Sad,
     Neutral,
-    All,
-    None,
 }

MiraAPI/Events/Vanilla/Gameplay/BeforeMurderEvent.cs

@@ -1,4 +1,6 @@
-namespace MiraAPI.Events.Vanilla.Gameplay;
+using MiraAPI.Networking;
+
+namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
 /// Event that is invoked before a player is murdered. This event is cancelable.
@@ -15,6 +17,24 @@ public sealed class BeforeMurderEvent : MiraCancelableEvent
     /// </summary>
     public PlayerControl Target { get; }
 
+    /// <summary>
+    /// Gets whether the murder was meant to be done in a meeting via an enum.
+    /// </summary>
+    public MeetingCheck InMeeting { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="BeforeMurderEvent"/> class.
+    /// </summary>
+    /// <param name="source">The player that is killing the target.</param>
+    /// <param name="target">The player that is being killed.</param>
+    /// <param name="inMeeting">Whether the murder is intended to be triggered in a meeting.</param>
+    public BeforeMurderEvent(PlayerControl source, PlayerControl target, MeetingCheck inMeeting)
+    {
+        Source = source;
+        Target = target;
+        InMeeting = inMeeting;
+    }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="BeforeMurderEvent"/> class.
     /// </summary>
@@ -24,5 +44,6 @@ public sealed class BeforeMurderEvent : MiraCancelableEvent
     {
         Source = source;
         Target = target;
+        InMeeting = MeetingCheck.Ignore;
     }
 }

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonCancelledEvent.cs

@@ -0,0 +1,44 @@
+using MiraAPI.Hud;
+
+namespace MiraAPI.Events.Vanilla.Gameplay;
+
+/// <summary>
+/// Invoked when a Vanilla Button click is cancelled. Do not use for custom buttons.
+/// </summary>
+/// <typeparam name="T">The Vanilla Button type.</typeparam>
+public sealed class VanillaButtonCancelledEvent<T> : MiraEvent where T : AbilityButton
+{
+    /// <summary>
+    /// Gets Vanilla Button whose click was cancelled.
+    /// </summary>
+    public T Button { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonCancelledEvent{T}"/> class.
+    /// </summary>
+    /// <param name="button">The Mira Button whose click was cancelled.</param>
+    public VanillaButtonCancelledEvent(T button)
+    {
+        Button = button;
+    }
+}
+
+/// <summary>
+/// Invoked when a Vanilla Button click is cancelled. Do not use for custom buttons.
+/// </summary>
+public sealed class VanillaButtonCancelledEvent : MiraEvent
+{
+    /// <summary>
+    /// Gets Vanilla Button whose click was cancelled.
+    /// </summary>
+    public AbilityButton Button { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonCancelledEvent"/> class.
+    /// </summary>
+    /// <param name="button">The Vanilla Button whose click was cancelled.</param>
+    public VanillaButtonCancelledEvent(AbilityButton button)
+    {
+        Button = button;
+    }
+}

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonClickEvent.cs

@@ -0,0 +1,65 @@
+using MiraAPI.Hud;
+
+namespace MiraAPI.Events.Vanilla.Gameplay;
+
+/// <summary>
+/// Button click event for Vanilla Buttons only. Do not use for custom buttons.
+/// </summary>
+/// <typeparam name="T">The Vanilla Button type.</typeparam>
+public sealed class VanillaButtonClickEvent<T> : MiraCancelableEvent where T : AbilityButton
+{
+    /// <summary>
+    /// Gets Vanilla Button that was clicked.
+    /// </summary>
+    public T Button { get; }
+
+    /// <summary>
+    /// Gets the generic click event that is invoked before this button-specific event.
+    /// </summary>
+    public VanillaButtonClickEvent GenericClickEvent { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonClickEvent{T}"/> class.
+    /// </summary>
+    /// <param name="button">The Mira Button that was clicked.</param>
+    /// <param name="genericClickEvent">The generic click event invoked before button-specific events.</param>
+    public VanillaButtonClickEvent(T button, VanillaButtonClickEvent genericClickEvent)
+    {
+        GenericClickEvent = genericClickEvent;
+        Button = button;
+    }
+}
+
+/// <summary>
+/// Button click event for Vanilla Buttons only. Do not use for custom buttons.
+/// </summary>
+public sealed class VanillaButtonClickEvent : MiraCancelableEvent
+{
+    /// <summary>
+    /// Gets Vanilla Button that was clicked.
+    /// </summary>
+    public AbilityButton Button { get; }
+
+    /// <summary>
+    /// Gets the target player, if any, of the Vanilla Button that was clicked.
+    /// </summary>
+    public PlayerControl? PlayerTarget { get; }
+
+    /// <summary>
+    /// Gets the target vent, if any, of the Vanilla Button that was clicked.
+    /// </summary>
+    public Vent? VentTarget { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="VanillaButtonClickEvent"/> class.
+    /// </summary>
+    /// <param name="button">The Vanilla Button that was clicked.</param>
+    /// <param name="playerTarget">The Player target, if any.</param>
+    /// <param name="ventTarget">The Vent target, if any.</param>
+    public VanillaButtonClickEvent(AbilityButton button, PlayerControl? playerTarget = null, Vent? ventTarget = null)
+    {
+        Button = button;
+        PlayerTarget = playerTarget;
+        VentTarget = ventTarget;
+    }
+}

MiraAPI/Events/Vanilla/Player/CompleteHnsTaskEvent.cs

@@ -0,0 +1,35 @@
+namespace MiraAPI.Events.Vanilla.Player;
+
+/// <summary>
+/// The event that is invoked when a player completes a task within Hide and Seek. Non-cancelable.
+/// </summary>
+public class CompleteHnsTaskEvent : MiraEvent
+{
+    /// <summary>
+    /// Gets the instance of the <see cref="PlayerControl"/>.
+    /// </summary>
+    public PlayerControl Player { get; }
+
+    /// <summary>
+    /// Gets the instance of the <see cref="PlayerTask"/> that the player completed.
+    /// </summary>
+    public PlayerTask Task { get; }
+
+    /// <summary>
+    /// Gets the instance of the <see cref="HnsManager"/> attached to the game.
+    /// </summary>
+    public HideAndSeekManager HnsManager { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CompleteHnsTaskEvent"/> class.
+    /// </summary>
+    /// <param name="hnsManager">The Hide and Seek Manager currently active.</param>
+    /// <param name="player">The player who completed the task.</param>
+    /// <param name="task">The task that the player completed.</param>
+    public CompleteHnsTaskEvent(HideAndSeekManager hnsManager, PlayerControl player, PlayerTask task)
+    {
+        HnsManager = hnsManager;
+        Player = player;
+        Task = task;
+    }
+}

MiraAPI/GameOptions/Attributes/ModdedEnumOptionAttribute.cs

@@ -32,33 +32,3 @@ public class ModdedEnumOptionAttribute(string title, Type enumType, string[]? va
             : throw new InvalidOperationException($"HolderOption for option \"{Title}\" with EnumType ${enumType.FullName} is not a ModdedEnumOption");
     }
 }
-
-/// <summary>
-/// Generic attribute for creating an enum option.
-/// </summary>
-/// <typeparam name="T">An enum type.</typeparam>
-[AttributeUsage(AttributeTargets.Property)]
-public class ModdedEnumOptionAttribute<T>(string title, string[]? values = null)
-    : ModdedOptionAttribute(title) where T : struct, Enum
-{
-    internal override IModdedOption CreateOption(object? value, PropertyInfo property)
-    {
-        var opt = new ModdedEnumOption<T>(Title, (T)(value ?? 0), values);
-        return opt;
-    }
-
-    /// <inheritdoc />
-    public override void SetValue(object value)
-    {
-        var opt = HolderOption as ModdedEnumOption;
-        opt?.SetValue((int)value);
-    }
-
-    /// <inheritdoc />
-    public override object GetValue()
-    {
-        return HolderOption is ModdedEnumOption<T> opt
-            ? Enum.ToObject(typeof(T), opt.Value)
-            : throw new InvalidOperationException($"HolderOption for option \"{Title}\" is not a ModdedEnumOption<{typeof(T).Name}>");
-    }
-}

MiraAPI/GameOptions/IModdedOption.cs

@@ -17,9 +17,9 @@ public interface IModdedOption
     uint Id { get; }
 
     /// <summary>
-    /// Gets the title of the option.
+    /// Gets or sets the title of the option.
     /// </summary>
-    string Title { get; }
+    string Title { get; set; }
 
     /// <summary>
     /// Gets the StringName for the option, used for localization.
@@ -92,11 +92,6 @@ public interface IModdedOption
     /// <param name="saveDefault">Indicates whether to save the default value instead of the current value.</param>
     void SaveToPreset(ConfigFile presetConfig, bool saveDefault = false);
 
-    /// <summary>
-    /// Changes the scales and positions of the option if it's attached to the game options menu.
-    /// </summary>
-    void ChangeGameSetting();
-
     /// <summary>
     /// Binds the option to a configuration file.
     /// </summary>

MiraAPI/GameOptions/MiraNumberOptionComponent.cs

@@ -1,4 +1,5 @@
 using System;
+using Il2CppInterop.Runtime.Attributes;
 using MiraAPI.GameOptions.OptionTypes;
 using Reactor.Utilities.Attributes;
 using UnityEngine;
@@ -14,6 +15,7 @@ public class MiraNumberOptionComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr)
     /// <summary>
     /// Gets or sets the modded option associated with the object.
     /// </summary>
+    [HideFromIl2Cpp]
     public ModdedNumberOption NumberOption { get; set; }
 
     /// <summary>
@@ -22,7 +24,17 @@ public class MiraNumberOptionComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr)
     public float DefaultIncrement { get; set; }
 
     /// <summary>
-    /// Gets or sets the value of whether or not holding shift will split the increment in half.
+    /// Gets or sets a value indicating whether holding shift will split the increment in half.
     /// </summary>
     public bool ShiftIncrementToggle { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating what Zero displays.
+    /// </summary>
+    public string ZeroValue { get; set; } = "#";
+
+    /// <summary>
+    /// Gets or sets a value indicating what Negative One displays.
+    /// </summary>
+    public string NegativeValue { get; set; } = "#";
 }

MiraAPI/GameOptions/ModdedOptionsManager.cs

@@ -47,13 +47,11 @@ public static class ModdedOptionsManager
         TypeToGroup.Add(type, group);
         pluginInfo.InternalOptionGroups.Add(group);
 
-#pragma warning disable S3011 // Reflection should not be used to increase accessibility of classes, methods, or fields
         typeof(OptionGroupSingleton<>).MakeGenericType(type)
 #pragma warning disable S3011
             .GetField("_instance", BindingFlags.Static | BindingFlags.NonPublic)!
 #pragma warning restore S3011
             .SetValue(null, group);
-#pragma warning restore S3011 // Reflection should not be used to increase accessibility of classes, methods, or fields
 
         return true;
     }

MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs

@@ -53,11 +53,7 @@ public class ModdedEnumOption : ModdedOption<int>
         stringOption.SetUpFromData(Data, 20);
         stringOption.OnValueChanged = (Il2CppSystem.Action<OptionBehaviour>)ValueChanged;
 
-        // Changing the button text to make them more distinct from number options
-        stringOption.MinusBtn.ChangeButtonText("<");
-        stringOption.PlusBtn.ChangeButtonText(">");
-
-        // SetUpFromData method doesn't work correctly so we must set the values manually
+        // SetUpFromData method doesnt work correctly so we must set the values manually
         stringOption.Title = StringName;
         stringOption.Values = (Data as StringGameSetting)?.Values ?? new Il2CppStructArray<StringNames>(0);
         stringOption.Value = Value;
@@ -67,32 +63,6 @@ public class ModdedEnumOption : ModdedOption<int>
         return stringOption;
     }
 
-    /// <inheritdoc />
-    public override void ChangeGameSetting()
-    {
-        var stringOption = OptionBehaviour as StringOption;
-
-        stringOption!.MinusBtn.transform.localPosition += new Vector3(0.6f, 0f, 0f);
-        stringOption.PlusBtn.transform.localPosition += new Vector3(1.5f, 0f, 0f);
-
-        // The value box itself becomes the button
-        stringOption.PlusBtn.gameObject.SetActive(false);
-        stringOption.MinusBtn.gameObject.SetActive(false);
-
-        var background = stringOption.transform.GetChild(0);
-        background.localPosition += new Vector3(-0.8f, 0f, 0f);
-        background.localScale += new Vector3(1f, 0f, 0f);
-
-        var title = stringOption.TitleText;
-        title.transform.localPosition = new(-2.0466f, 0f, -2.9968f);
-        title.GetComponent<RectTransform>().sizeDelta = new(5.8f, 0.458f);
-        title.fontSize = 2.9f; // Why is it different for string options??
-
-        var valueBox = stringOption.transform.GetChild(5);
-        valueBox.localPosition += new Vector3(1.05f, 0f, 0f);
-        valueBox.localScale += new Vector3(0.2f, 0f, 0f);
-    }
-
     /// <inheritdoc />
     public override float GetFloatData()
     {
@@ -137,7 +107,7 @@ public class ModdedEnumOption : ModdedOption<int>
 /// An option for selecting an enum value.
 /// </summary>
 /// <typeparam name="T">The enum type.</typeparam>
-public class ModdedEnumOption<T> : ModdedOption<T> where T : struct, Enum
+public class ModdedEnumOption<T> : ModdedOption<T> where T : Enum
 {
     /// <summary>
     /// Gets the string values of the enum.
@@ -148,12 +118,12 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : struct, Enum
     /// Initializes a new instance of the <see cref="ModdedEnumOption{T}"/> class.
     /// </summary>
     /// <param name="title">The title of the option.</param>
-    /// <param name="defaultValue">The default value.</param>
+    /// <param name="defaultValue">The default value as an int.</param>
     /// <param name="values">An option list of string values to use in place of the enum name.</param>
     /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
     public ModdedEnumOption(string title, T defaultValue, string[]? values = null, bool includeInPreset=true) : base(title, defaultValue, includeInPreset)
     {
-        Values = values ?? Enum.GetNames<T>();
+        Values = values ?? Enum.GetNames(typeof(T));
         Data = ScriptableObject.CreateInstance<StringGameSetting>();
         var data = (StringGameSetting)Data;
 
@@ -174,13 +144,9 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : struct, Enum
             $"{ParentMod!.OptionsTitleText}.EnumOption.{TranslationController.Instance.GetString(StringName)}";
 
         stringOption.SetUpFromData(Data, 20);
-        stringOption.OnValueChanged = (Action<OptionBehaviour>)ValueChanged;
+        stringOption.OnValueChanged = (Il2CppSystem.Action<OptionBehaviour>)ValueChanged;
 
-        // Changing the button text to make them more distinct from number options
-        stringOption.MinusBtn.ChangeButtonText("<");
-        stringOption.PlusBtn.ChangeButtonText(">");
-
-        // SetUpFromData method doesn't work correctly so we must set the values manually
+        // SetUpFromData method doesnt work correctly so we must set the values manually
         stringOption.Title = StringName;
         stringOption.Values = (Data as StringGameSetting)?.Values ?? new Il2CppStructArray<StringNames>(0);
         stringOption.Value = Convert.ToInt32(Value, NumberFormatInfo.InvariantInfo);
@@ -190,32 +156,6 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : struct, Enum
         return stringOption;
     }
 
-    /// <inheritdoc />
-    public override void ChangeGameSetting()
-    {
-        var stringOption = OptionBehaviour as StringOption;
-
-        stringOption!.MinusBtn.transform.localPosition += new Vector3(0.6f, 0f, 0f);
-        stringOption.PlusBtn.transform.localPosition += new Vector3(1.5f, 0f, 0f);
-
-        // The value box itself becomes the button
-        stringOption.PlusBtn.gameObject.SetActive(false);
-        stringOption.MinusBtn.gameObject.SetActive(false);
-
-        var background = stringOption.transform.GetChild(0);
-        background.localPosition += new Vector3(-0.8f, 0f, 0f);
-        background.localScale += new Vector3(1f, 0f, 0f);
-
-        var title = stringOption.TitleText;
-        title.transform.localPosition = new(-2.0466f, 0f, -2.9968f);
-        title.GetComponent<RectTransform>().sizeDelta = new(5.8f, 0.458f);
-        title.fontSize = 2.9f; // Why is it different for string options??
-
-        var valueBox = stringOption.transform.GetChild(5);
-        valueBox.localPosition += new Vector3(1.05f, 0f, 0f);
-        valueBox.localScale += new Vector3(0.2f, 0f, 0f);
-    }
-
     /// <inheritdoc />
     public override float GetFloatData()
     {
@@ -231,19 +171,19 @@ public class ModdedEnumOption<T> : ModdedOption<T> where T : struct, Enum
     /// <inheritdoc />
     public override void HandleNetData(byte[] data)
     {
-        SetValue(Enum.Parse<T>(Encoding.Unicode.GetString(data)));
+        SetValue((T)Enum.Parse(typeof(T), Encoding.Unicode.GetString(data)));
     }
 
     /// <inheritdoc />
     public override T GetValueFromOptionBehaviour(OptionBehaviour optionBehaviour)
     {
-        return Enum.Parse<T>(optionBehaviour.GetInt().ToString(NumberFormatInfo.InvariantInfo));
+        return (T)Enum.Parse(typeof(T), optionBehaviour.GetInt().ToString(NumberFormatInfo.InvariantInfo));
     }
 
     /// <inheritdoc />
     protected override void OnValueChanged(T newValue)
     {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data!.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)), false);
+        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)), false);
         if (!OptionBehaviour)
         {
             return;

MiraAPI/GameOptions/OptionTypes/ModdedMultiSelectOption.cs

@@ -1,182 +0,0 @@
-using AmongUs.GameOptions;
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.Linq;
-using System.Reflection;
-using Il2CppInterop.Runtime.InteropTypes.Arrays;
-using MiraAPI.Modules;
-using MiraAPI.Networking;
-using MiraAPI.Utilities;
-using MiraAPI.Utilities.Assets;
-using Reactor.Utilities.Extensions;
-using UnityEngine;
-using Object = UnityEngine.Object;
-
-namespace MiraAPI.GameOptions.OptionTypes;
-
-/// <summary>
-/// An option for selecting an enum value.
-/// </summary>
-/// <typeparam name="T">The enum type.</typeparam>
-public class ModdedMultiSelectOption<T> : ModdedOption<T> where T : struct, Enum
-{
-    /// <summary>
-    /// Gets the string values of the enum.
-    /// </summary>
-    public string[]? Values { get; }
-
-    /// <summary>
-    /// Gets a value indicating "all of the above".
-    /// </summary>
-    public T All { get; }
-
-    /// <summary>
-    /// Gets a value indicating "none of the above".
-    /// </summary>
-    public T None { get; }
-
-    /// <summary>
-    /// Gets the list of buttons that relate to the current instance.
-    /// </summary>
-    public List<MonoBehaviour> Buttons { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="ModdedMultiSelectOption{T}"/> class.
-    /// </summary>
-    /// <param name="title">The title of the option.</param>
-    /// <param name="defaultValue">The default value as an int.</param>
-    /// <param name="all">The all value.</param>
-    /// <param name="none">The none value.</param>
-    /// <param name="values">An option list of string values to use in place of the enum name.</param>
-    /// <exception cref="ArgumentException">The enum type doesn't have the flags attribute.</exception>
-    public ModdedMultiSelectOption(string title, T defaultValue, T all, T none, string[]? values = null) : base(title, defaultValue)
-    {
-        var tType = typeof(T);
-
-        if (tType.GetCustomAttribute<FlagsAttribute>() == null)
-            throw new ArgumentException($"{tType.Name} is not a flag enum type");
-
-        Values = values ?? Enum.GetNames<T>();
-        All = all;
-        None = none;
-        Data = ScriptableObject.CreateInstance<MultiSelectGameSetting>();
-        Buttons = [];
-
-        var data = (MultiSelectGameSetting)Data;
-        data.Title = StringName;
-        data.OptionName = Int32OptionNames.Invalid;
-        data.Type = global::OptionTypes.MultipleChoice; // How nice of the game to provide an enum value themselves
-        data.EnumNames = []; // We don't initialise the translation here, we just add one as and when needed
-    }
-
-    /// <inheritdoc />
-    public override OptionBehaviour CreateOption(
-        ToggleOption toggleOpt,
-        NumberOption numberOpt,
-        StringOption stringOpt,
-        PlayerOption playerOpt,
-        Transform container)
-    {
-        var stringOption = Object.Instantiate(stringOpt, container);
-
-        stringOption.SetUpFromData(Data, 20);
-        stringOption.OnValueChanged = (Action<OptionBehaviour>)ValueChanged;
-
-        var toggle = Object.Instantiate(toggleOpt.GetComponentInChildren<PassiveButton>(), stringOption.transform);
-        toggle.name = "Button";
-        toggle.transform.DestroyChildren();
-        toggle.OverrideOnClickListeners(ToggleButtons);
-
-        var box = toggle.GetComponent<BoxCollider2D>();
-        var prevColliderSize = box.size;
-        prevColliderSize.x *= 4.97f;
-        box.size = prevColliderSize;
-
-        var rend = stringOption.transform.GetChild(5).GetComponent<SpriteRenderer>();
-        toggle.OverrideOnMouseOverListeners(() => rend.color = Buttons.Count > 0 ? Color.white : MiraAssets.AcceptedTeal);
-        toggle.OverrideOnMouseOutListeners(() => rend.color = Buttons.Count > 0 ? MiraAssets.AcceptedTeal : Color.white);
-
-        // SetUpFromData method doesn't work correctly so we must set the values manually
-        stringOption.Title = StringName;
-        stringOption.Values = (Data as MultiSelectGameSetting)?.EnumNames?.Values?.ToArray() ?? new Il2CppStructArray<StringNames>(0);
-        stringOption.Value = Convert.ToInt32(Value, NumberFormatInfo.InvariantInfo);
-
-        OptionBehaviour = stringOption;
-
-        return stringOption;
-    }
-
-    /// <inheritdoc />
-    public override void ChangeGameSetting()
-    {
-        var stringOption = OptionBehaviour as StringOption;
-
-        // The value box itself becomes the button
-        stringOption!.PlusBtn.gameObject.SetActive(false);
-        stringOption.MinusBtn.gameObject.SetActive(false);
-
-        var background = stringOption.transform.GetChild(0);
-        background.localPosition += new Vector3(-0.8f, 0f, 0f);
-        background.localScale += new Vector3(1f, 0f, 0f);
-
-        var title = stringOption.TitleText;
-        title.transform.localPosition = new(-2.0466f, 0f, -2.9968f);
-        title.GetComponent<RectTransform>().sizeDelta = new(5.8f, 0.458f);
-        title.fontSize = 2.9f; // Why is it different for string options??
-
-        var valueBox = stringOption.transform.GetChild(5);
-        valueBox.localPosition += new Vector3(1.05f, 0f, 0f);
-        valueBox.localScale += new Vector3(0.2f, 0f, 0f);
-    }
-
-    private void ToggleButtons()
-    {
-        if (Buttons.Count > 0)
-        {
-            Buttons.ForEach(x => x.gameObject.Destroy());
-            return;
-        }
-
-        // TODO: Implement this
-    }
-
-    /// <inheritdoc />
-    public override float GetFloatData()
-    {
-        return Convert.ToSingle(Value, NumberFormatInfo.InvariantInfo);
-    }
-
-    /// <inheritdoc />
-    public override NetData GetNetData()
-    {
-        return new NetData(Id, EnumSerializer.EnumToBytes(Value));
-    }
-
-    /// <inheritdoc />
-    public override void HandleNetData(byte[] data)
-    {
-        SetValue(EnumSerializer.EnumFromBytes<T>(data, 0));
-    }
-
-    /// <inheritdoc />
-    public override T GetValueFromOptionBehaviour(OptionBehaviour optionBehaviour)
-    {
-        return Enum.Parse<T>(optionBehaviour.GetInt().ToString(NumberFormatInfo.InvariantInfo));
-    }
-
-    /// <inheritdoc />
-    protected override void OnValueChanged(T newValue)
-    {
-        HudManager.Instance.Notifier.AddSettingsChangeMessage(StringName, Data!.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)), false);
-        if (!OptionBehaviour)
-        {
-            return;
-        }
-
-        if (OptionBehaviour is StringOption opt)
-        {
-            opt.Value = Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo);
-        }
-    }
-}

MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs

@@ -32,16 +32,83 @@ public class ModdedNumberOption : ModdedOption<float>
     /// </summary>
     public MiraNumberSuffixes SuffixType { get; }
 
+    /// <summary>
+    /// Gets a value indicating what zero appears as.
+    /// </summary>
+    public string ZeroWordValue { get; }
+
+    /// <summary>
+    /// Gets a value indicating what a negative one appears as.
+    /// </summary>
+    public string NegativeWordValue { get; }
+
     /// <summary>
     /// Gets a value indicating whether zero is infinity.
     /// </summary>
-    public bool ZeroInfinity { get; }
+    public bool ZeroInfinity => ZeroWordValue == "∞";
 
     /// <summary>
     /// Gets a value indicating whether holding shift will divide the increment.
     /// </summary>
     public bool ShiftIncrement { get; }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ModdedNumberOption"/> class.
+    /// </summary>
+    /// <param name="title">The title of the option.</param>
+    /// <param name="defaultValue">The default value as a float.</param>
+    /// <param name="min">The minimum value.</param>
+    /// <param name="max">The maximum value.</param>
+    /// <param name="increment">The increment.</param>
+    /// <param name="suffixType">The suffix type.</param>
+    /// <param name="formatString">Optional format string for the option screen.</param>
+    /// <param name="zeroBehavior">Determines what is shown for zero. Options: ∞, #, or a word value (such as Off).</param>
+    /// <param name="negativeBehavior">Determines what is shown for negative 1. Options: ∞, #, or a word value (such as Off).</param>
+    /// <param name="halfIncrements">Whether increments can be split in half.</param>
+    /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
+    public ModdedNumberOption(
+        string title,
+        float defaultValue,
+        float min,
+        float max,
+        float increment,
+        string zeroBehavior,
+        string negativeBehavior,
+        MiraNumberSuffixes suffixType,
+        string? formatString = null,
+        bool halfIncrements = false,
+        bool includeInPreset = true) : base(title, defaultValue, includeInPreset)
+    {
+        Min = min;
+        Max = max;
+        Increment = increment;
+        SuffixType = suffixType;
+        ZeroWordValue = zeroBehavior;
+        NegativeWordValue = negativeBehavior;
+        ShiftIncrement = halfIncrements;
+
+        Value = Mathf.Clamp(defaultValue, min, max);
+
+        Data = ScriptableObject.CreateInstance<FloatGameSetting>();
+
+        var data = (FloatGameSetting)Data;
+        data.Type = global::OptionTypes.Float;
+        data.Title = StringName;
+        data.Value = Value;
+        data.Increment = Increment;
+        data.ValidRange = new FloatRange(Min, Max);
+        data.FormatString = formatString ??
+                            (defaultValue.IsInteger() &&
+                             Increment.IsInteger() &&
+                             Value.IsInteger() &&
+                             Min.IsInteger() &&
+                             Max.IsInteger() ? "0" : "0.0");
+
+        data.ZeroIsInfinity = ZeroInfinity;
+        data.SuffixType = (NumberSuffixes)SuffixType;
+        data.OptionName = FloatOptionNames.Invalid;
+    }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="ModdedNumberOption"/> class.
     /// </summary>
@@ -54,7 +121,6 @@ public class ModdedNumberOption : ModdedOption<float>
     /// <param name="formatString">Optional format string for the option screen.</param>
     /// <param name="zeroInfinity">Whether zero is infinity or not.</param>
     /// <param name="includeInPreset">Whether to include this option in the preset or not.</param>
-    /// <param name="shiftIncrement">Whether holding shift will divide the increment or not.</param>
     public ModdedNumberOption(
         string title,
         float defaultValue,
@@ -70,7 +136,8 @@ public class ModdedNumberOption : ModdedOption<float>
         Max = max;
         Increment = increment;
         SuffixType = suffixType;
-        ZeroInfinity = zeroInfinity;
+        ZeroWordValue = zeroInfinity ? "∞" : "#";
+        NegativeWordValue = "#";
         ShiftIncrement = increment != 1f;
 
         Value = Mathf.Clamp(defaultValue, min, max);
@@ -110,6 +177,8 @@ public class ModdedNumberOption : ModdedOption<float>
         optionComponent.NumberOption = this;
         optionComponent.DefaultIncrement = Increment;
         optionComponent.ShiftIncrementToggle = ShiftIncrement;
+        optionComponent.NegativeValue = NegativeWordValue;
+        optionComponent.ZeroValue = ZeroWordValue;
 
         numberOption.SetUpFromData(Data, 20);
         numberOption.OnValueChanged = (Il2CppSystem.Action<OptionBehaviour>)ValueChanged;
@@ -128,27 +197,6 @@ public class ModdedNumberOption : ModdedOption<float>
         return numberOption;
     }
 
-    /// <inheritdoc />
-    public override void ChangeGameSetting()
-    {
-        var numberOption = OptionBehaviour as NumberOption;
-
-        numberOption!.PlusBtn.transform.localPosition += new Vector3(0.6f, 0f, 0f);
-        numberOption.MinusBtn.transform.localPosition += new Vector3(1.5f, 0f, 0f);
-
-        var background = numberOption.transform.GetChild(0);
-        background.localPosition += new Vector3(-0.8f, 0f, 0f);
-        background.localScale += new Vector3(1f, 0f, 0f);
-
-        var title = numberOption.TitleText;
-        title.transform.localPosition = new(-2.0466f, 0f, -2.9968f);
-        title.GetComponent<RectTransform>().sizeDelta = new(5.8f, 0.458f);
-
-        var valueBox = numberOption.transform.GetChild(5);
-        valueBox.localPosition += new Vector3(1.05f, 0f, 0f);
-        valueBox.localScale += new Vector3(0.2f, 0f, 0f);
-    }
-
     /// <inheritdoc />
     public override float GetFloatData()
     {
@@ -179,7 +227,7 @@ public class ModdedNumberOption : ModdedOption<float>
         Value = Mathf.Clamp(newValue, Min, Max);
         HudManager.Instance.Notifier.AddSettingsChangeMessage(
             StringName,
-            Data!.GetValueString(Value),
+            Data.GetValueString(Value),
             false);
 
         if (OptionBehaviour is NumberOption opt)

MiraAPI/GameOptions/OptionTypes/ModdedOption.cs

@@ -21,7 +21,7 @@ public abstract class ModdedOption<T> : IModdedOption
     public uint Id { get; }
 
     /// <inheritdoc />
-    public string Title { get; }
+    public string Title { get; set; }
 
     /// <inheritdoc />
     public StringNames StringName { get; }
@@ -181,23 +181,6 @@ public abstract class ModdedOption<T> : IModdedOption
         PlayerOption playerOpt,
         Transform container);
 
-    /// <summary>
-    /// Visually adjust the game option as needed.
-    /// </summary>
-    public abstract void ChangeGameSetting();
-
-    /// <summary>
-    /// Binds the option to the configuration file of the parent mod, if available.
-    /// </summary>
-    public virtual void BindConfig()
-    {
-        var entry = ParentMod?.GetConfigFile().Bind(ConfigDefinition, DefaultValue);
-        if (entry != null)
-        {
-            Value = entry.Value;
-        }
-    }
-
     /// <summary>
     /// Implicitly converts the option to type of <typeparamref name="T"/>.
     /// </summary>

MiraAPI/GameOptions/OptionTypes/ModdedPlayerOption.cs

@@ -28,27 +28,6 @@ public class ModdedPlayerOption : ModdedOption<int>
     /// </summary>
     public bool AllowNone { get; set; }
 
-    /// <inheritdoc />
-    public override void ChangeGameSetting()
-    {
-        var numberOption = OptionBehaviour as PlayerOption;
-
-        numberOption!.PlusBtn.transform.localPosition += new Vector3(0.6f, 0f, 0f);
-        numberOption.MinusBtn.transform.localPosition += new Vector3(1.5f, 0f, 0f);
-
-        var background = numberOption.transform.GetChild(0);
-        background.localPosition += new Vector3(-0.8f, 0f, 0f);
-        background.localScale += new Vector3(1f, 0f, 0f);
-
-        var title = numberOption.TitleText;
-        title.transform.localPosition = new(-2.0466f, 0f, -2.9968f);
-        title.GetComponent<RectTransform>().sizeDelta = new(5.8f, 0.458f);
-
-        var valueBox = numberOption.transform.GetChild(5);
-        valueBox.localPosition += new Vector3(1.05f, 0f, 0f);
-        valueBox.localScale += new Vector3(0.2f, 0f, 0f);
-    }
-
     /// <summary>
     /// Initializes a new instance of the <see cref="ModdedPlayerOption"/> class.
     /// </summary>

MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs

@@ -44,21 +44,6 @@ public class ModdedToggleOption : ModdedOption<bool>
         return toggleOption;
     }
 
-    /// <inheritdoc />
-    public override void ChangeGameSetting()
-    {
-        var toggleOption = OptionBehaviour as ToggleOption;
-        toggleOption!.transform.GetChild(1).localPosition += new Vector3(2.2f, 0f, 0f); // Checkbox
-
-        var title = toggleOption.TitleText;
-        title.transform.localPosition = new(-2.0466f, 0f, -2.9968f);
-        title.GetComponent<RectTransform>().sizeDelta = new(5.8f, 0.458f);
-
-        var background = toggleOption.transform.GetChild(2);
-        background.localPosition += new Vector3(-0.8f, 0f, 0f);
-        background.localScale += new Vector3(1f, 0f, 0f);
-    }
-
     /// <inheritdoc />
     public override float GetFloatData()
     {

MiraAPI/Hud/CustomActionButton.cs

@@ -64,9 +64,14 @@ public abstract class CustomActionButton
     public virtual float EffectDuration => 0;
 
     /// <summary>
-    /// Gets the maximum amount of uses the button has. If the button has infinite uses, set to 0.
+    /// Gets a value indicating whether the button has limited uses.
     /// </summary>
-    public virtual int MaxUses => 0;
+    public bool LimitedUses => ZeroIsInfinite ? MaxUses > 0 : MaxUses >= 0;
+
+    /// <summary>
+    /// Gets the maximum number of uses the button has. If the button has infinite uses, set to 0 or -1 based on what value that ZeroIsInfinite is set to.
+    /// </summary>
+    public virtual int MaxUses => ZeroIsInfinite ? 0 : -1;
 
     /// <summary>
     /// Gets the value indicating uses mode.
@@ -89,9 +94,9 @@ public abstract class CustomActionButton
     public virtual ButtonLocation Location { get; set; } = ButtonLocation.BottomLeft;
 
     /// <summary>
-    /// Gets a value indicating whether the button has limited uses.
+    /// Gets or sets a value indicating whether limited uses are determined via zero or a negative number of uses.
     /// </summary>
-    public bool LimitedUses => MaxUses > 0;
+    public virtual bool ZeroIsInfinite { get; set; } = true;
 
     /// <summary>
     /// Gets or sets a value indicating whether the effect is currently active, if there is one.
@@ -206,7 +211,39 @@ public abstract class CustomActionButton
             {
                 if (Enabled(PlayerControl.LocalPlayer.Data.Role))
                 {
-                    ClickHandler();
+                    // Invoke the generic button click event.
+                    var genericEvent = new MiraButtonClickEvent(this);
+                    MiraEventManager.InvokeEvent(genericEvent);
+                    if (genericEvent.IsCancelled)
+                    {
+                        MiraEventManager.InvokeEvent(new MiraButtonCancelledEvent(this));
+                    }
+
+                    // Invoke the button click event for specific button.
+                    var eventType = CustomButtonManager.ButtonEventTypes[GetType()];
+                    var @event = (MiraCancelableEvent)Activator.CreateInstance(eventType, this, genericEvent)!;
+                    var specificInvoked = MiraEventManager.InvokeEvent(@event, eventType);
+                    if (@event.IsCancelled)
+                    {
+                        var cancelEventType = CustomButtonManager.ButtonCancelledEventTypes[GetType()];
+                        var cancelEvent = (MiraEvent)Activator.CreateInstance(cancelEventType, this)!;
+                        MiraEventManager.InvokeEvent(cancelEvent, cancelEventType);
+                    }
+
+                    if (specificInvoked)
+                    {
+                        if (!@event.IsCancelled)
+                        {
+                            ClickHandler();
+                        }
+                    }
+                    else
+                    {
+                        if (!genericEvent.IsCancelled)
+                        {
+                            ClickHandler();
+                        }
+                    }
                 }
             });
 
@@ -214,10 +251,10 @@ public abstract class CustomActionButton
                 Helpers.CreateKeybindIcon(
                     Button.gameObject,
                     Keybind.CurrentKey,
-                    new Vector3(MaxUses <= 0 ? -0.4f : 0.4f, 0.45f, -9f)
+                    new Vector3(0.4f, 0.45f, -9f)
                 );
             KeybindText = KeybindIcon.transform.GetChild(0).GetComponent<TextMeshPro>();
-            HudManagerPatches.moddedKeybindIcons.Add(KeybindText);
+            HudManagerPatches.ModdedKeybindIcons.Add(KeybindText);
             Button.usesRemainingSprite.transform.localPosition = new(-0.341f, 0.45f, -0.1f);
         }
     }

MiraAPI/Keybinds/BaseKeybind.cs

@@ -69,4 +69,4 @@ public class BaseKeybind
     {
         Handler -= action;
     }
-}
+}

MiraAPI/Keybinds/MiraKeybind.cs

@@ -9,7 +9,7 @@ namespace MiraAPI.Keybinds;
 public class MiraKeybind : BaseKeybind
 {
     /// <summary>
-    /// Gets name of the keybind
+    /// Gets name of the keybind.
     /// </summary>
     public string Name { get; }
 

MiraAPI/Keybinds/VanillaKeybind.cs

@@ -19,6 +19,6 @@ public class VanillaKeybind : BaseKeybind
     public VanillaKeybind(int id)
     {
         RewiredInputAction = KeybindUtils.GetInputActionById(id);
-        Id = RewiredInputAction?.name;
+        Id = RewiredInputAction != null ? RewiredInputAction.name : id.ToString();
     }
 }

MiraAPI/MiraApiPlugin.cs

@@ -1,6 +1,6 @@
 global using static Reactor.Utilities.Logger<MiraAPI.MiraApiPlugin>;
+using System;
 using BepInEx;
-using BepInEx.Configuration;
 using BepInEx.Unity.IL2CPP;
 using HarmonyLib;
 using MiraAPI.PluginLoading;
@@ -22,6 +22,11 @@ namespace MiraAPI;
 [ReactorModFlags(ModFlags.RequireOnAllClients)]
 public partial class MiraApiPlugin : BasePlugin
 {
+    /// <summary>
+    /// Gets a value indicating whether the current device is running Starlight (on mobile).
+    /// </summary>
+    public static bool IsMobile => Constants.GetPlatformType() is Platforms.Android or Platforms.IPhone;
+
     /// <summary>
     /// Gets the branding Mira API color.
     /// </summary>
@@ -32,7 +37,11 @@ public partial class MiraApiPlugin : BasePlugin
     /// </summary>
     public static Color DefaultHeaderColor { get; } = new Color32(77, 77, 77, 255);
 
-    internal static ConfigEntry<string>? DistanceSuffix { get; private set; }
+    /// <summary>
+    /// Gets a value indicating whether the current build is a development build or not. This mostly avoids confusion for users asking why the mod appears red.
+    /// </summary>
+    public static bool IsDevBuild => Version.Contains("ci", StringComparison.OrdinalIgnoreCase) || Version.Contains("dev", StringComparison.OrdinalIgnoreCase);
+
     private static MiraPluginManager? PluginManager { get; set; }
     internal Harmony Harmony { get; } = new(Id);
 
@@ -41,9 +50,7 @@ public partial class MiraApiPlugin : BasePlugin
     {
         Harmony.PatchAll();
 
-        ReactorCredits.Register("Mira API", Version, true, ReactorCredits.AlwaysShow);
-
-        DistanceSuffix = Config.Bind("Display", "Distance", "unit(s)", "Dictates how a distance is shown in numeric option displays");
+        ReactorCredits.Register("Mira API", Version, IsDevBuild, ReactorCredits.AlwaysShow);
 
         PluginManager = new MiraPluginManager();
         PluginManager.Initialize();

MiraAPI/MiraApiSettings.cs

@@ -1,12 +1,15 @@
 using BepInEx.Configuration;
 using MiraAPI.LocalSettings;
 using MiraAPI.LocalSettings.Attributes;
+using MiraAPI.Patches;
+using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
+using UnityEngine;
 
 namespace MiraAPI;
 
 /// <summary>
-/// Mira API Config File Handler
+/// Mira API Config File Handler.
 /// </summary>
 public class MiraApiSettings(ConfigFile config) : LocalSettingsTab(config)
 {
@@ -21,22 +24,78 @@ public class MiraApiSettings(ConfigFile config) : LocalSettingsTab(config)
         HideIconOnHover = false,
     };
 
+    /// <summary>
+    /// Gets or sets the value stored for scaling buttons properly.
+    /// </summary>
+    public static float OldButtonScaleFactor { get; set; }
+
+    /// <inheritdoc />
+    public override void Open()
+    {
+        base.Open();
+        OldButtonScaleFactor = ButtonUIFactorSlider.Value;
+    }
+
+    /// <inheritdoc />
+    public override void OnOptionChanged(ConfigEntryBase configEntry)
+    {
+        base.OnOptionChanged(configEntry);
+        if (configEntry == ButtonUIFactorSlider)
+        {
+            if (HudManager.InstanceExists)
+            {
+                HudManagerPatches.ResizeUI(1f / OldButtonScaleFactor);
+                HudManagerPatches.ResizeUI(ButtonUIFactorSlider.Value);
+            }
+            OldButtonScaleFactor = ButtonUIFactorSlider.Value;
+        }
+        else if (configEntry == SetFpsSlider)
+        {
+            Application.targetFrameRate = (int)SetFpsSlider.Value;
+        }
+    }
+
     /// <summary>
     /// Gets whether the modifiers hud should be on the left side of the screen (under roles/task tab). Recommended for streamers.
     /// </summary>
     [LocalToggleSetting]
-    public ConfigEntry<bool> ModifiersHudLeftSide { get; private set; } = config.Bind("Displays", "Show Modifiers HUD on Left Side", false);
+    public ConfigEntry<bool> ModifiersHudLeftSide { get; private set; } = config.Bind("Visuals/UI", "Show Modifiers HUD on Left Side", false);
 
     /// <summary>
     /// Gets whether to show keybinds on buttons.
     /// </summary>
     [LocalToggleSetting]
-    public ConfigEntry<bool> ShowKeybinds { get; private set; } = config.Bind("Keybinds", "Show Keybinds on Buttons", true);
-    // This would be placed in the keybinds menu, but it crashes for Epic Games users. - Atony
+    public ConfigEntry<bool> ShowKeybinds { get; private set; } = config.Bind("Visuals/UI", "Show Keybinds on Buttons", true);
+
+    /// <summary>
+    /// Gets the scale of the buttons.
+    /// </summary>
+    [LocalSliderSetting(min: 0.5f, max: 1.5f, suffixType: MiraNumberSuffixes.Multiplier, formatString: "0.00", displayValue: true)]
+    public ConfigEntry<float> ButtonUIFactorSlider { get; private set; } =
+        config.Bind("Visuals/UI", "Button Scale Factor", 0.75f);
+
+    /// <summary>
+    /// Gets the fps specified by the player.
+    /// </summary>
+    [LocalSliderSetting(min: 60f, max: 240f, suffixType: MiraNumberSuffixes.None, formatString: "0", displayValue: true, roundValue: true)]
+    public ConfigEntry<float> SetFpsSlider { get; private set; } =
+        config.Bind("Visuals/UI", "Max FPS", 120f);
 
     /// <summary>
     /// Gets whether to apply cosmetic changes to the TaskAdder.
     /// </summary>
     [LocalToggleSetting]
     public ConfigEntry<bool> PrettyTaskAdder { get; private set; } = config.Bind("Freeplay", "Pretty Task Laptop", true);
+
+    /// <summary>
+    /// Gets whether to show the red flash from sabotages.
+    /// </summary>
+    [LocalToggleSetting]
+    public ConfigEntry<bool> EnableSabotageFlashes { get; private set; } = config.Bind("Accessibility", "Enable Sabotage Flashes", true);
+
+    /// <summary>
+    /// Gets whether to enable the sabotage sound effects or not.
+    /// </summary>
+    [LocalToggleSetting]
+    public ConfigEntry<bool> EnableSabotageBlares { get; private set; } = config.Bind("Accessibility", "Enable Sabotage Blare", true);
 }

MiraAPI/Modifiers/ModifierManager.cs

@@ -179,6 +179,7 @@ public static class ModifierManager
     private static bool IsGameModifierValid(PlayerControl player, GameModifier modifier, uint modifierId)
     {
         return (player.Data.Role is not ICustomRole role || role.IsModifierApplicable(modifier)) &&
-               modifier.IsModifierValidOn(player.Data.Role) && !player.HasModifier(modifierId);
+               modifier.IsModifierValidOn(player.Data.Role) && !player.HasModifier(modifierId) &&
+               modifier.CanSpawnOnCurrentMode();
     }
 }

MiraAPI/Modifiers/Types/GameModifier.cs

@@ -39,4 +39,10 @@ public abstract class GameModifier : BaseModifier
     /// <param name="reason">The reason why the game ended.</param>
     /// <returns>True if the player won, false if they lost. Return null to use the player's default win condition.</returns>
     public virtual bool? DidWin(GameOverReason reason) => null;
+
+    /// <summary>
+    /// Determines whether the modifier can spawn in general, accounting for gamemodes and everything else.
+    /// </summary>
+    /// <returns>True if the modifier is able to spawn, otherwise false.</returns>
+    public virtual bool CanSpawnOnCurrentMode() => !GameManager.Instance.IsHideAndSeek();
 }

MiraAPI/Modules/ConversionFailException.cs

@@ -1,9 +0,0 @@
-using System;
-
-namespace MiraAPI.Modules;
-
-/// <summary>
-/// Denotes a failure in conversion of values.
-/// </summary>
-/// <param name="message">The message to log.</param>
-public class ConversionFailException(string message) : Exception(message);

MiraAPI/Modules/MultiSelectGameSetting.cs

@@ -1,19 +0,0 @@
-// TODO: Remove later before completing the pr
-#pragma warning disable
-using System;
-using System.Collections.Generic;
-using AmongUs.GameOptions;
-using Il2CppInterop.Runtime.Attributes;
-using Il2CppInterop.Runtime.InteropTypes.Arrays;
-using Reactor.Utilities.Attributes;
-
-namespace MiraAPI.Modules;
-
-[RegisterInIl2Cpp, Serializable]
-public class MultiSelectGameSetting : BaseGameSetting
-{
-    public Int32OptionNames OptionName;
-    public Dictionary<int, StringNames> EnumNames;
-
-    public override string GetValueString(float value) => TranslationController.Instance.GetString(EnumNames[(int)value]);
-}

MiraAPI/Modules/MultiSelectValue.cs

@@ -1,202 +0,0 @@
-using System;
-using System.Collections;
-using System.Collections.Generic;
-using System.Linq;
-using MiraAPI.Utilities;
-
-namespace MiraAPI.Modules;
-
-/// <summary>
-/// Represents a collection of enum values that can be stored and manipulated as a comma-separated string.
-/// </summary>
-/// <typeparam name="T">The enum type that this collection will store.</typeparam>
-/// <param name="values">One or more enum values to initialize the collection with.</param>
-[Serializable]
-public struct MultiSelectValue<T>(params T[] values) : IEnumerable<T>, IEquatable<MultiSelectValue<T>>, IDisposable where T : struct, Enum
-{
-    /// <summary>
-    /// Gets or sets the underlying comma-separated string representation of enum values.
-    /// </summary>
-    public string Values
-    {
-        readonly get => Helpers.Join(',', _values);
-        set => _values = [.. value.TrueSplit(',').Select(Enum.Parse<T>)];
-    }
-    private HashSet<T> _values = [.. values];
-
-    /// <summary>
-    /// Gets the number of values contained within.
-    /// </summary>
-    public readonly int Count => _values.Count;
-
-    /// <summary>
-    /// Adds a single enum value to the end of the collection.
-    /// </summary>
-    /// <param name="item">The enum value to add.</param>
-    /// <returns><c>true</c> if successfully added; otherwise, <c>false</c>.</returns>
-    public readonly bool Add(T item) => _values.Add(item);
-
-    /// <summary>
-    /// Removes the first occurrence of the specified enum value.<br/>
-    /// Returns <c>true</c> if the value was found and removed, <c>false</c> otherwise.
-    /// </summary>
-    /// <param name="item">The enum value to remove.</param>
-    /// <returns><c>true</c> if successfully removed; otherwise, <c>false</c>.</returns>
-    public readonly bool Remove(T item) => _values.Remove(item);
-
-    /// <summary>
-    /// Adds multiple enum values to the end of the collection.
-    /// </summary>
-    /// <param name="items">The collection of enum values to add.</param>
-    public readonly void AddRange(IEnumerable<T> items)
-    {
-        foreach (var item in items)
-            _values.Add(item);
-    }
-
-    /// <summary>
-    /// Removes multiple enum values from the collection.
-    /// </summary>
-    /// <param name="items">The enum values to remove.</param>
-    /// <returns>The number of items successfully removed.</returns>
-    public readonly int RemoveRange(params T[] items) => RemoveRange((IEnumerable<T>)items);
-
-    /// <summary>
-    /// Removes multiple enum values from the collection.
-    /// </summary>
-    /// <param name="items">The collection of enum values to remove.</param>
-    /// <returns>The number of items successfully removed.</returns>
-    public readonly int RemoveRange(IEnumerable<T> items) => items.Count(Remove);
-
-    /// <summary>
-    /// Determines whether the collection contains the specified enum value.
-    /// </summary>
-    /// <param name="item">The enum value to locate.</param>
-    /// <returns>true if the item is found in the collection; otherwise, false.</returns>
-    public readonly bool Contains(T item) => _values.Contains(item);
-
-    /// <summary>
-    /// Removes all enum values that match the specified predicate condition.<br/>
-    /// Iterates through the collection and removes each matching value.
-    /// </summary>
-    /// <param name="predicate">A function that defines the condition for removing items.</param>
-    /// <returns>The number of items removed from the collection.</returns>
-    public readonly int RemoveAll(Func<T, bool> predicate)
-    {
-        var count = 0;
-
-        foreach (var item in this)
-        {
-            if (predicate(item) && Remove(item))
-                count++;
-        }
-
-        return count;
-    }
-
-    /// <summary>
-    /// Removes all enum values from the collection.
-    /// </summary>
-    public readonly void Clear() => _values.Clear();
-
-    /// <summary>
-    /// Gets the first value in the collection.
-    /// </summary>
-    /// <returns>Returns the first value.</returns>
-    public readonly T First() => _values.First();
-
-    /// <summary>
-    /// Serializes the current instance to an array of bytes.
-    /// </summary>
-    /// <returns>An array of bytes representing the current instance.</returns>
-    public readonly byte[] ToBytes() => EnumSerializer.EnumsToBytes(this);
-
-    /// <summary>
-    /// Converts the collection to its string representation.
-    /// </summary>
-    /// <returns>A comma-separated string of enum values.</returns>
-    public readonly override string ToString() => Values;
-
-    /// <inheritdoc/>
-    public readonly override bool Equals(object? obj) => obj is MultiSelectValue<T> other && Equals(other);
-
-    /// <inheritdoc/>
-    public readonly bool Equals(MultiSelectValue<T> other) => _values.SetEquals(other._values);
-
-    /// <inheritdoc/>
-    public readonly override int GetHashCode() => Values.GetHashCode();
-
-    /// <inheritdoc/>
-    public readonly IEnumerator<T> GetEnumerator() => ((IEnumerable<T>)_values).GetEnumerator();
-
-    /// <inheritdoc/>
-    readonly IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
-
-    /// <inheritdoc/>
-    public readonly void Dispose() => _values.Clear();
-
-    /// <summary>
-    /// Creates an instance of <see cref="MultiSelectValue{T}"/> from the provided byte array.
-    /// </summary>
-    /// <param name="bytes">The bytes to deserialize from.</param>
-    /// <returns>An instance of <see cref="MultiSelectValue{T}"/>.</returns>
-#pragma warning disable CA1000 // Do not declare static members on generic types
-    public static MultiSelectValue<T> FromBytes(byte[] bytes) => new([.. EnumSerializer.EnumsFromBytes<T>(bytes)]);
-#pragma warning restore CA1000 // Do not declare static members on generic types
-
-    /// <summary>
-    /// Converts the current instance to its string representation.
-    /// </summary>
-    /// <param name="value">The value to convert.</param>
-    public static implicit operator string(MultiSelectValue<T> value) => value.Values;
-
-    /// <summary>
-    /// Converts the current instance to its array representation of values.
-    /// </summary>
-    /// <param name="value">The value to convert.</param>
-    public static implicit operator T[](MultiSelectValue<T> value) => [.. value._values];
-
-    /// <summary>
-    /// Converts the current instance to one singular value.
-    /// </summary>
-    /// <param name="value">The value to convert.</param>
-    /// <exception cref="ConversionFailException">There were either no values, or more than one value.</exception>
-#pragma warning disable S3877 // Exceptions should not be thrown from unexpected methods
-    public static implicit operator T(MultiSelectValue<T> value) =>
-        value.Count == 1
-            ? value._values.First()
-            : throw new ConversionFailException($"Tried to convert multiple or no values ({value.Values}) to a singular one");
-#pragma warning restore S3877 // Exceptions should not be thrown from unexpected methods
-
-    /// <summary>
-    /// Converts the value to an instance of MultiSelectValue.
-    /// </summary>
-    /// <param name="value">The value to convert.</param>
-    public static implicit operator MultiSelectValue<T>(T value) => new(value);
-
-    /// <summary>
-    /// Converts the array of values to an instance of MultiSelectValue.
-    /// </summary>
-    /// <param name="values">The values to convert.</param>
-    public static implicit operator MultiSelectValue<T>(T[] values) => new(values);
-
-    /// <summary>
-    /// Converts the value string to an instance of MultiSelectValue.
-    /// </summary>
-    /// <param name="values">The values to convert.</param>
-    public static implicit operator MultiSelectValue<T>(string values) => new([.. values.TrueSplit(',').Select(Enum.Parse<T>)]);
-
-    /// <summary>
-    /// Equality comparison.
-    /// </summary>
-    /// <param name="left">Left.</param>
-    /// <param name="right">Right.</param>
-    public static bool operator ==(MultiSelectValue<T> left, MultiSelectValue<T> right) => left.Equals(right);
-
-    /// <summary>
-    /// Inequality comparison.
-    /// </summary>
-    /// <param name="left">Left.</param>
-    /// <param name="right">Right.</param>
-    public static bool operator !=(MultiSelectValue<T> left, MultiSelectValue<T> right) => !left.Equals(right);
-}

MiraAPI/Networking/CustomMurderRpc.cs

@@ -7,10 +7,12 @@ using Assets.CoreScripts;
 using BepInEx.Unity.IL2CPP.Utils;
 using MiraAPI.Events;
 using MiraAPI.Events.Vanilla.Gameplay;
+using MiraAPI.Utilities;
 using Reactor.Networking.Attributes;
 using Reactor.Networking.Rpc;
 using Reactor.Utilities;
 using Reactor.Utilities.Extensions;
+using Rewired;
 using UnityEngine;
 using Object = UnityEngine.Object;
 
@@ -22,7 +24,7 @@ namespace MiraAPI.Networking;
 public static class CustomMurderRpc
 {
     /// <summary>
-    /// Networked Custom Murder method.
+    /// Networked Custom Murder method, ran by clients for the host to confirm kills.
     /// </summary>
     /// <param name="source">The killer.</param>
     /// <param name="target">The player to murder.</param>
@@ -32,7 +34,6 @@ public static class CustomMurderRpc
     /// <param name="teleportMurderer">Should the killer be snapped to the dead player.</param>
     /// <param name="showKillAnim">Should the kill animation be shown.</param>
     /// <param name="playKillSound">Should the kill sound be played.</param>
-    [MethodRpc((uint)MiraRpc.CustomMurder, LocalHandling = RpcLocalHandling.Before)]
     public static void RpcCustomMurder(
         this PlayerControl source,
         PlayerControl target,
@@ -43,16 +44,106 @@ public static class CustomMurderRpc
         bool showKillAnim = true,
         bool playKillSound = true)
     {
+        source.RpcCustomMurder(
+            target,
+            MeetingCheck.Ignore,
+            didSucceed,
+            resetKillTimer,
+            createDeadBody,
+            teleportMurderer,
+            showKillAnim,
+            playKillSound);
+    }
+
+    /// <summary>
+    /// Networked Custom Murder method, which checks for meetings as well, ran by clients for the host to confirm kills.
+    /// </summary>
+    /// <param name="source">The killer.</param>
+    /// <param name="target">The player to murder.</param>
+    /// <param name="inMeeting">Whether the murder is intended to be triggered in a meeting.</param>
+    /// <param name="didSucceed">Whether the murder was successful or not.</param>
+    /// <param name="resetKillTimer">Should the kill timer be reset.</param>
+    /// <param name="createDeadBody">Should a dead body be created.</param>
+    /// <param name="teleportMurderer">Should the killer be snapped to the dead player.</param>
+    /// <param name="showKillAnim">Should the kill animation be shown.</param>
+    /// <param name="playKillSound">Should the kill sound be played.</param>
+    [MethodRpc((uint)MiraRpc.CustomMurder, LocalHandling = RpcLocalHandling.Before)]
+    public static void RpcCustomMurder(
+        this PlayerControl source,
+        PlayerControl target,
+        MeetingCheck inMeeting,
+        bool didSucceed = true,
+        bool resetKillTimer = true,
+        bool createDeadBody = true,
+        bool teleportMurderer = true,
+        bool showKillAnim = true,
+        bool playKillSound = true)
+    {
+        if (LobbyBehaviour.Instance)
+        {
+            return;
+        }
         var murderResultFlags = didSucceed ? MurderResultFlags.Succeeded : MurderResultFlags.FailedError;
 
-        var beforeMurderEvent = new BeforeMurderEvent(source, target);
+        var beforeMurderEvent = new BeforeMurderEvent(source, target, inMeeting);
         MiraEventManager.InvokeEvent(beforeMurderEvent);
+        var isMeetingActive = MeetingHud.Instance != null || ExileController.Instance != null;
+        if ((inMeeting is MeetingCheck.ForMeeting && !isMeetingActive) || (inMeeting is MeetingCheck.OutsideMeeting && isMeetingActive))
+        {
+            beforeMurderEvent.Cancel();
+        }
 
         if (beforeMurderEvent.IsCancelled)
         {
             murderResultFlags = MurderResultFlags.FailedError;
         }
 
+        if (!PlayerControl.LocalPlayer.IsHost())
+        {
+            return;
+        }
+
+        RpcConfirmCustomMurder(
+            PlayerControl.LocalPlayer,
+            source,
+            target,
+            murderResultFlags,
+            resetKillTimer,
+            createDeadBody,
+            teleportMurderer,
+            showKillAnim,
+            playKillSound);
+    }
+
+    /// <summary>
+    /// Networked Custom Murder method, which checks for meetings as well, ran by clients for the host to confirm kills.
+    /// </summary>
+    /// <param name="host">The game host.</param>
+    /// <param name="source">The killer.</param>
+    /// <param name="target">The player to murder.</param>
+    /// <param name="murderResultFlags">End result for the murder.</param>
+    /// <param name="resetKillTimer">Should the kill timer be reset.</param>
+    /// <param name="createDeadBody">Should a dead body be created.</param>
+    /// <param name="teleportMurderer">Should the killer be snapped to the dead player.</param>
+    /// <param name="showKillAnim">Should the kill animation be shown.</param>
+    /// <param name="playKillSound">Should the kill sound be played.</param>
+    [MethodRpc((uint)MiraRpc.ConfirmCustomMurder, LocalHandling = RpcLocalHandling.After)]
+    public static void RpcConfirmCustomMurder(
+        this PlayerControl host,
+        PlayerControl source,
+        PlayerControl target,
+        MurderResultFlags murderResultFlags,
+        bool resetKillTimer = true,
+        bool createDeadBody = true,
+        bool teleportMurderer = true,
+        bool showKillAnim = true,
+        bool playKillSound = true)
+    {
+        if (LobbyBehaviour.Instance || !host.IsHost() || target.Data.IsDead || target.Data.Disconnected)
+        {
+            return;
+        }
+
         var murderResultFlags2 = MurderResultFlags.DecisionByHost | murderResultFlags;
 
         source.CustomMurder(
@@ -87,8 +178,7 @@ public static class CustomMurderRpc
         bool playKillSound = true)
     {
         source.isKilling = false;
-        var data = target.Data;
-        if (resultFlags.HasFlag(MurderResultFlags.FailedError))
+        if (resultFlags.HasFlag(MurderResultFlags.FailedError) || LobbyBehaviour.Instance)
         {
             return;
         }
@@ -174,7 +264,7 @@ public static class CustomMurderRpc
             {
                 try
                 {
-                    HudManager.Instance.KillOverlay.ShowKillAnimation(source.Data, data);
+                    HudManager.Instance.KillOverlay.ShowKillAnimation(source.Data, target.Data);
                 }
                 catch (Exception e)
                 {
@@ -211,6 +301,10 @@ public static class CustomMurderRpc
         bool createDeadBody = true,
         bool teleportMurderer = true)
     {
+        if (LobbyBehaviour.Instance)
+        {
+            yield break;
+        }
         var cam = Camera.main?.GetComponent<FollowerCamera>();
         var isParticipant = source.AmOwner || target.AmOwner;
         var sourcePhys = source.MyPhysics;
@@ -298,3 +392,24 @@ public static class CustomMurderRpc
         source.isKilling = false;
     }
 }
+
+/// <summary>
+/// Checks for custom murders.
+/// </summary>
+public enum MeetingCheck
+{
+    /// <summary>
+    /// Checks for meetings.
+    /// </summary>
+    ForMeeting,
+
+    /// <summary>
+    /// Checks for a meeting to not be active.
+    /// </summary>
+    OutsideMeeting,
+
+    /// <summary>
+    /// Doesn't check for a meeting at all.
+    /// </summary>
+    Ignore,
+}

MiraAPI/Networking/MiraRpc.cs

@@ -35,6 +35,11 @@ public enum MiraRpc : uint
     /// </summary>
     CustomMurder,
 
+    /// <summary>
+    /// Custom Murder RPC Confirmation.
+    /// </summary>
+    ConfirmCustomMurder,
+
     /// <summary>
     /// Custom Game Over RPC.
     /// </summary>

MiraAPI/Patches/Accessibility/HudManagerFlashPatches.cs

@@ -0,0 +1,67 @@
+using System.Collections;
+using BepInEx.Unity.IL2CPP.Utils.Collections;
+using HarmonyLib;
+using MiraAPI.LocalSettings;
+using UnityEngine;
+
+namespace MiraAPI.Patches.Accessibility;
+[HarmonyPatch]
+public static class HudManagerFlashPatches
+{
+    [HarmonyPatch(typeof(HudManager), nameof(HudManager.StartReactorFlash))]
+    [HarmonyPrefix]
+    public static bool ReactorFlashPrefix(HudManager __instance)
+    {
+        if (__instance.ReactorFlash == null)
+        {
+            __instance.ReactorFlash = __instance.StartCoroutine(CoReactorFlash().WrapToIl2Cpp());
+        }
+
+        return false;
+    }
+    [HarmonyPatch(typeof(HudManager), nameof(HudManager.StartOxyFlash))]
+    [HarmonyPrefix]
+    public static bool OxygenFlashPrefix(HudManager __instance)
+    {
+        if (__instance.OxyFlash == null)
+        {
+            __instance.OxyFlash = __instance.StartCoroutine(CoReactorFlash().WrapToIl2Cpp());
+        }
+
+        return false;
+    }
+    public static IEnumerator CoReactorFlash()
+    {
+        if (!HudManager.InstanceExists)
+        {
+            yield break;
+        }
+        var hudManager = HudManager.Instance;
+        WaitForSeconds wait = new WaitForSeconds(1f);
+        bool light = false;
+
+        hudManager.FullScreen.color = new Color(1f, 0f, 0f, 0.37254903f);
+        while (true)
+        {
+            var settins = LocalSettingsTabSingleton<MiraApiSettings>.Instance;
+            hudManager.FullScreen.gameObject.SetActive(settins.EnableSabotageFlashes.Value && !hudManager.FullScreen.gameObject.activeSelf);
+            if (settins.EnableSabotageBlares.Value)
+            {
+                SoundManager.Instance.PlaySound(ShipStatus.Instance.SabotageSound, false, 1f, null);
+            }
+            light = !light;
+
+            /*if (!MiraApiPlugin.IsMobile)
+            {
+                if (hudManager.lightFlashHandle == null)
+                {
+                    hudManager.lightFlashHandle = DualshockLightManager.Instance.AllocateLight();
+                    hudManager.lightFlashHandle.color = new Color(1f, 0f, 0f, 1f);
+                    hudManager.lightFlashHandle.intensity = 1f;
+                }
+                hudManager.lightFlashHandle.color.SetAlpha(light ? 1f : 0f);
+            }*/
+            yield return wait;
+        }
+    }
+}

MiraAPI/Patches/Events/HnsFinishTaskPatch.cs

@@ -0,0 +1,17 @@
+using HarmonyLib;
+using MiraAPI.Events;
+using MiraAPI.Events.Vanilla.Player;
+
+namespace MiraAPI.Patches.Events;
+
+[HarmonyPatch(typeof(HideAndSeekManager))]
+public static class HnsFinishTaskPatch
+{
+    [HarmonyPostfix]
+    [HarmonyPatch(nameof(HideAndSeekManager.FinishTask))]
+    public static void FinishTaskPostfix(HideAndSeekManager __instance, PlayerTask task)
+    {
+        var completeTaskEvent = new CompleteHnsTaskEvent(__instance, task.Owner, task);
+        MiraEventManager.InvokeEvent(completeTaskEvent);
+    }
+}

MiraAPI/Patches/Events/SpawnInMinigamePatch.cs

@@ -1,4 +1,5 @@
-using HarmonyLib;
+/*
+using HarmonyLib;
 using MiraAPI.Events;
 using MiraAPI.Events.Vanilla.Gameplay;
 
@@ -18,3 +19,4 @@ internal static class SpawnInMinigamePatch
         MiraEventManager.InvokeEvent(@event2);
     }
 }
+*/

MiraAPI/Patches/Events/SubmergedSpawnGamePatch.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+/*
+using System.Collections.Generic;
 using System.Reflection;
 using HarmonyLib;
 using MiraAPI.Events;
@@ -34,3 +35,4 @@ internal static class SubmergedSpawnGamePatch
         MiraEventManager.InvokeEvent(@event2);
     }
 }
+*/

MiraAPI/Patches/Events/VanillaButtonPatches.cs

@@ -0,0 +1,75 @@
+using System.Linq;
+using AmongUs.GameOptions;
+using HarmonyLib;
+using MiraAPI.Events;
+using MiraAPI.Events.Vanilla.Gameplay;
+using MiraAPI.Events.Vanilla.Usables;
+
+namespace MiraAPI.Patches.Events;
+
+/// <summary>
+/// Patches to invoke vent related MiraEvents.
+/// </summary>
+[HarmonyPatch]
+public static class VanillaButtonPatches
+{
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(AbilityButton), nameof(AbilityButton.DoClick))]
+    public static bool DoClickPrefix(AbilityButton __instance)
+    {
+        // Invoke the generic button click event.
+        PlayerControl? playerTarget = null;
+        Vent? ventTarget = null;
+        var role = PlayerControl.LocalPlayer.Data.Role;
+        if (role.Role is RoleTypes.Tracker)
+        {
+            playerTarget = role.Cast<TrackerRole>().currentTarget;
+        }
+        else if (role.Role is RoleTypes.GuardianAngel)
+        {
+            playerTarget = role.Cast<GuardianAngelRole>().currentTarget;
+        }
+        else if (role.Role is RoleTypes.Engineer)
+        {
+            ventTarget = role.Cast<EngineerRole>().currentTarget;
+        }
+        var genericEvent = new VanillaButtonClickEvent(__instance, playerTarget, ventTarget);
+        MiraEventManager.InvokeEvent(genericEvent);
+        if (genericEvent.IsCancelled)
+        {
+            MiraEventManager.InvokeEvent(new VanillaButtonCancelledEvent(__instance));
+        }
+
+        if (!genericEvent.IsCancelled)
+        {
+            return true;
+        }
+
+        return false;
+    }
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(SecondaryAbilityButton), nameof(SecondaryAbilityButton.DoClick))]
+    public static bool SecondaryDoClickPrefix(AbilityButton __instance)
+    {
+        // Invoke the generic button click event.
+        PlayerControl? playerTarget = null;
+        var role = PlayerControl.LocalPlayer.Data.Role;
+        if (role.Role is RoleTypes.Detective)
+        {
+            playerTarget = role.Cast<DetectiveRole>().currentTarget;
+        }
+        var genericEvent = new VanillaButtonClickEvent(__instance, playerTarget);
+        MiraEventManager.InvokeEvent(genericEvent);
+        if (genericEvent.IsCancelled)
+        {
+            MiraEventManager.InvokeEvent(new VanillaButtonCancelledEvent(__instance));
+        }
+
+        if (!genericEvent.IsCancelled)
+        {
+            return true;
+        }
+
+        return false;
+    }
+}

MiraAPI/Patches/Freeplay/TaskAdderPatches.cs

@@ -21,10 +21,14 @@ using Object = UnityEngine.Object;
 namespace MiraAPI.Patches.Freeplay;
 
 [HarmonyPatch(typeof(TaskAdderGame))]
-internal static class TaskAdderPatches
+public static class TaskAdderPatches
 {
     private static Scroller _scroller = null!;
     private static Dictionary<string, TaskFolder> folders = new();
+    public static string CrewmateName => TranslationController.Instance.GetString(StringNames.Crewmate);
+    public static string ImpostorName => TranslationController.Instance.GetString(StringNames.Impostor);
+    public static string NeutralName => "Neutral";
+    public static string ModifiersName => "Modifiers";
 
     [HarmonyPostfix]
     [HarmonyPatch(nameof(TaskAdderGame.Begin))]
@@ -66,19 +70,16 @@ internal static class TaskAdderPatches
         __instance.RootFolderPrefab.GetComponent<PassiveButton>().ClickMask = collider;
         __instance.RootFolderPrefab.gameObject.SetActive(false);
         __instance.TaskParent = inner.transform;
-        var crewLocale = TranslationController.Instance.GetString(StringNames.Crewmate);
-        var impLocale = TranslationController.Instance.GetString(StringNames.Impostor);
-
-        var crewmateFolder = __instance.Root.SubFolders.ToArray().FirstOrDefault(x => x.FolderName == crewLocale)!;
-        var impostorFolder = __instance.Root.SubFolders.ToArray().FirstOrDefault(x => x.FolderName == impLocale)!;
+        var crewmateFolder = __instance.Root.SubFolders.ToArray().FirstOrDefault(x => x.FolderName == CrewmateName)!;
+        var impostorFolder = __instance.Root.SubFolders.ToArray().FirstOrDefault(x => x.FolderName == ImpostorName)!;
         //var neutralFolder = __instance.CreateFolder("Neutral", __instance.Root, 2, Color.gray);
-        var modifiersFolder = __instance.CreateFolder("Modifiers", __instance.Root, 0, Color.blue);
+        var modifiersFolder = __instance.CreateFolder(ModifiersName, __instance.Root, 0, Color.blue);
 
         folders.Clear();
         folders.Add(crewmateFolder.FolderName, crewmateFolder);
         folders.Add(impostorFolder.FolderName, impostorFolder);
         //folders.Add("Neutrals", neutralFolder);
-        folders.Add("Modifiers", modifiersFolder);
+        folders.Add(ModifiersName, modifiersFolder);
 
         int folderIdx = 2;
         foreach (var plugin in MiraPluginManager.Instance.RegisteredPlugins)
@@ -137,8 +138,8 @@ internal static class TaskAdderPatches
                 Object.Instantiate(__instance.RootFolderPrefab, __instance.transform);
             impFolder.gameObject.SetActive(false);
             impFolder.SetFolderColor(TaskFolder.FolderColor.Red);
-            crewFolder.FolderName = TranslationController.Instance.GetString(StringNames.Crewmate);
-            impFolder.FolderName = TranslationController.Instance.GetString(StringNames.Impostor);
+            crewFolder.FolderName = CrewmateName;
+            impFolder.FolderName = ImpostorName;
             rootFolder.SubFolders.Insert(0, crewFolder);
             rootFolder.SubFolders.Insert(0, impFolder);
             Il2CppSystem.Collections.Generic.List<RoleBehaviour> impRoles = new();
@@ -440,7 +441,7 @@ internal static class TaskAdderPatches
             }
         }
 
-        if (folders.TryGetValue("Modifiers", out var modifiersFolder) && taskFolder.IsChildOf(modifiersFolder))
+        if (folders.TryGetValue(ModifiersName, out var modifiersFolder) && taskFolder.IsChildOf(modifiersFolder))
         {
             var plugin = MiraPluginManager.GetPluginByGuid(taskFolder.name.Replace("(Clone)", string.Empty));
             if (plugin != null)

MiraAPI/Patches/HudManagerPatches.cs

@@ -1,5 +1,5 @@
-using System.Collections.Generic;
-using System.Linq;
+using System.Collections;
+using System.Collections.Generic;
 using HarmonyLib;
 using MiraAPI.Hud;
 using MiraAPI.Keybinds;
@@ -25,9 +25,87 @@ public static class HudManagerPatches
     public static Transform? BottomRight { get; private set; }
     public static Transform? Buttons { get; private set; }
 
-    private static Dictionary<TextMeshPro, int> vanillaKeybindIcons = new();
+    private static Dictionary<TextMeshPro, int> vanillaKeybindIcons = [];
 
-    internal static List<TextMeshPro> moddedKeybindIcons = new();
+    internal static List<TextMeshPro> ModdedKeybindIcons = [];
+
+    public static IEnumerator CoResizeUI()
+    {
+        while (!HudManager.Instance)
+        {
+            yield return null;
+        }
+
+        yield return new WaitForSeconds(0.01f);
+        ResizeUI(LocalSettingsTabSingleton<MiraApiSettings>.Instance.ButtonUIFactorSlider.Value);
+    }
+
+    public static void ResizeUI(float scaleFactor)
+    {
+        var baseButtons = HudManager.Instance.transform.FindChild("Buttons");
+        if (baseButtons != null)
+        {
+            foreach (var aspect in baseButtons.GetComponentsInChildren<AspectPosition>(true))
+            {
+                if (aspect.gameObject == null)
+                {
+                    continue;
+                }
+
+                if (aspect.gameObject.transform.parent.name == "TopRight")
+                {
+                    continue;
+                }
+
+                if (aspect.gameObject.transform.parent.transform.parent.name == "TopRight")
+                {
+                    continue;
+                }
+
+                aspect.gameObject.SetActive(!aspect.isActiveAndEnabled);
+                aspect.DistanceFromEdge *= new Vector2(scaleFactor, scaleFactor);
+                aspect.gameObject.SetActive(!aspect.isActiveAndEnabled);
+            }
+        }
+
+        foreach (var button in HudManager.Instance.GetComponentsInChildren<ActionButton>(true))
+        {
+            if (button.gameObject == null)
+            {
+                continue;
+            }
+
+            button.gameObject.SetActive(!button.isActiveAndEnabled);
+            button.gameObject.transform.localScale *= scaleFactor;
+            button.gameObject.SetActive(!button.isActiveAndEnabled);
+        }
+
+        if (baseButtons != null)
+        {
+            foreach (var arrange in baseButtons.GetComponentsInChildren<GridArrange>(true))
+            {
+                if (!arrange.gameObject || !arrange.transform)
+                {
+                    continue;
+                }
+
+                arrange.gameObject.SetActive(!arrange.isActiveAndEnabled);
+                arrange.CellSize = new Vector2(scaleFactor, scaleFactor);
+                arrange.gameObject.SetActive(!arrange.isActiveAndEnabled);
+                if (arrange.isActiveAndEnabled && arrange.gameObject.transform.childCount != 0)
+                {
+                    try
+                    {
+                        arrange.ArrangeChilds();
+                    }
+                    catch
+                    {
+                        // Error($"Error arranging child objects in GridArrange: {e}");
+                    }
+                }
+            }
+        }
+    }
 
     /*
     /// <summary>
@@ -90,7 +168,7 @@ public static class HudManagerPatches
             fakeButton.ToggleVisible(true);
             fakeButton.Destroy();
         }
-        moddedKeybindIcons = [];
+        ModdedKeybindIcons = [];
 
         foreach (var button in CustomButtonManager.CustomButtons)
         {
@@ -123,7 +201,7 @@ public static class HudManagerPatches
         aspectPosition.AdjustPosition();
 
         vanillaKeybindIcons = [];
-        var keybindIconPos = new Vector3(-0.4f, 0.4f, -9.5f);
+        var keybindIconPos = new Vector3(0.4f, 0.4f, -9.5f);
         var vanillaButtons = new Dictionary<GameObject, int>
         {
             { __instance.KillButton.gameObject, 8 },
@@ -146,9 +224,15 @@ public static class HudManagerPatches
             }
             var icon = Helpers.CreateKeybindIcon(buttonObj, key, keybindIconPos);
             vanillaKeybindIcons.Add(icon.transform.GetChild(0).GetComponent<TextMeshPro>(), actionId);
-            var comp = buttonObj.GetComponent<ActionButton>();
-            KeybindManager.VanillaKeybinds[comp.GetType()].Button = comp;
+            if (!MiraApiPlugin.IsMobile)
+            {
+                var comp = buttonObj.GetComponent<ActionButton>();
+                KeybindManager.VanillaKeybinds[comp.GetType()].Button = comp;
+            }
         }
+        MiraApiSettings.OldButtonScaleFactor =
+            LocalSettingsTabSingleton<MiraApiSettings>.Instance.ButtonUIFactorSlider.Value;
+        Coroutines.Start(CoResizeUI());
     }
 
     /// <summary>
@@ -187,31 +271,54 @@ public static class HudManagerPatches
     {
         var canSeeBinds = ActiveInputManager.currentControlType == ActiveInputManager.InputType.Keyboard &&
                           LocalSettingsTabSingleton<MiraApiSettings>.Instance.ShowKeybinds.Value;
+
         foreach (var btnIcon in vanillaKeybindIcons)
         {
             btnIcon.Key.text = KeybindUtils.GetKeycodeByActionId(btnIcon.Value).ToString();
             btnIcon.Key.transform.parent.gameObject.SetActive(canSeeBinds);
         }
-        foreach (var btnIcon in moddedKeybindIcons)
+
+        foreach (var btnIcon in ModdedKeybindIcons)
         {
             btnIcon.transform.parent.gameObject.SetActive(canSeeBinds);
         }
 
         var player = ReInput.players.GetPlayer(0);
+        var keyboard = player.controllers.Keyboard;
         foreach (var entry in KeybindManager.Keybinds)
         {
-            var keyboard = player.controllers.Keyboard;
-            bool modifierKeysPressed = entry.ModifierKeys.All(k => keyboard.GetModifierKey(k)) ||
-                                       entry.ModifierKeys.Length <= 0;
+            var modKeys = entry.ModifierKeys;
+            bool modifierKeysPressed;
+            if (modKeys.Length == 0)
+            {
+                modifierKeysPressed = true;
+            }
+            else
+            {
+                modifierKeysPressed = true;
+                foreach (var key in modKeys)
+                {
+                    if (keyboard.GetModifierKey(key)) continue;
+                    modifierKeysPressed = false;
+                    break;
+                }
+            }
+
             if (player.GetButtonDown(entry.Id) && modifierKeysPressed)
             {
                 entry.Invoke();
             }
         }
 
-        foreach (var entry in KeybindManager.VanillaKeybinds.Values.Where(x => player.GetButtonDown(x.Id)))
+        // suppressed warning because we want minimum allocations here
+#pragma warning disable S3267
+        foreach (var entry in KeybindManager.VanillaKeybinds.Values)
+#pragma warning restore S3267
         {
-            entry.Invoke();
+            if (player.GetButtonDown(entry.Id))
+            {
+                entry.Invoke();
+            }
         }
     }
 }

MiraAPI/Patches/Menu/MainMenuManagerPatches.cs

@@ -1,5 +1,7 @@
 using HarmonyLib;
+using MiraAPI.LocalSettings;
 using MiraAPI.Utilities.Assets;
+using UnityEngine;
 
 namespace MiraAPI.Patches.Menu;
 
@@ -17,5 +19,6 @@ public static class MainMenuManagerPatches
     public static void AwakePostfix()
     {
         AddressablesLoader.LoadAll();
+        Application.targetFrameRate = (int)LocalSettingsTabSingleton<MiraApiSettings>.Instance.SetFpsSlider.Value;
     }
 }

MiraAPI/Patches/Options/GameOptionsMenuPatch.cs

@@ -1,8 +1,11 @@
 using System;
 using System.Linq;
+using AmongUs.GameOptions;
 using HarmonyLib;
+using Il2CppInterop.Runtime.Attributes;
 using MiraAPI.GameOptions;
 using MiraAPI.Modifiers;
+using MiraAPI.Presets;
 using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
 using Reactor.Localization.Utilities;
@@ -10,6 +13,7 @@ using Reactor.Utilities.Extensions;
 using TMPro;
 using UnityEngine;
 using UnityEngine.Events;
+using UnityEngine.UI;
 using Object = UnityEngine.Object;
 
 namespace MiraAPI.Patches.Options;
@@ -17,6 +21,20 @@ namespace MiraAPI.Patches.Options;
 [HarmonyPatch(typeof(GameOptionsMenu))]
 internal static class GameOptionsMenuPatch
 {
+    [HarmonyPostfix]
+    [HarmonyPatch(nameof(GameOptionsMenu.OnEnable))]
+    public static void OpenPatch(GameOptionsMenu __instance)
+    {
+        HudManager.Instance.PlayerCam.OverrideScreenShakeEnabled = false;
+    }
+
+    [HarmonyPostfix]
+    [HarmonyPatch(nameof(GameOptionsMenu.OnDisable))]
+    public static void ClosePatch(GameOptionsMenu __instance)
+    {
+        HudManager.Instance.PlayerCam.OverrideScreenShakeEnabled = true;
+    }
+
     [HarmonyPostfix]
     [HarmonyPatch(nameof(GameOptionsMenu.Update))]
     // ReSharper disable once InconsistentNaming
@@ -153,7 +171,7 @@ internal static class GameOptionsMenuPatch
     private static void ModifiersUpdate(ref float num)
     {
         var groups = GameSettingMenuPatches.SelectedMod?.InternalOptionGroups
-            .Where(x => x.ShowInModifiersMenu || x.OptionableType?.IsAssignableTo(typeof(BaseModifier))==true) ?? [];
+            .Where(x => x.ShowInModifiersMenu || x.OptionableType?.IsAssignableTo(typeof(BaseModifier)) == true) ?? [];
 
         foreach (var modGroup in groups)
         {
@@ -164,7 +182,7 @@ internal static class GameOptionsMenuPatch
     private static void ModifiersCreate(GameOptionsMenu menu)
     {
         var groups = GameSettingMenuPatches.SelectedMod?.InternalOptionGroups
-            .Where(x => x.ShowInModifiersMenu || x.OptionableType?.IsAssignableTo(typeof(BaseModifier))==true) ?? [];
+            .Where(x => x.ShowInModifiersMenu || x.OptionableType?.IsAssignableTo(typeof(BaseModifier)) == true) ?? [];
         foreach (var group in groups)
         {
             CreateGroup(menu, group);
@@ -257,7 +275,9 @@ internal static class GameOptionsMenuPatch
         categoryHeaderMasked.SetHeader(CustomStringName.CreateAndRegister(group.GroupName), 20);
         categoryHeaderMasked.Background.color = group.GroupColor;
         categoryHeaderMasked.Divider.color = group.GroupColor;
-        categoryHeaderMasked.Title.color = group.GroupColor.Equals(MiraApiPlugin.DefaultHeaderColor) ? Color.white : group.GroupColor.FindAlternateColor();
+        categoryHeaderMasked.Title.color = group.GroupColor.Equals(MiraApiPlugin.DefaultHeaderColor)
+            ? Color.white
+            : group.GroupColor.FindAlternateColor();
 
         categoryHeaderMasked.Background.sprite = MiraAssets.CategoryHeader.LoadAsset();
         categoryHeaderMasked.Background.sprite.texture.filterMode = FilterMode.Bilinear;
@@ -276,16 +296,20 @@ internal static class GameOptionsMenuPatch
         newText.transform.localPosition = new Vector3(2.6249f, -0.165f, 0f);
         newText.gameObject.GetComponent<TextTranslatorTMP>().Destroy();
 
-        var options = group.Options.Select(
-            opt => opt.CreateOption(
-                menu.checkboxOrigin,
-                menu.numberOptionOrigin,
-                menu.stringOptionOrigin,
-                menu.playerOptionOrigin,
-                menu.settingsContainer));
+        var options = group.Options.Select(opt => opt.CreateOption(
+            menu.checkboxOrigin,
+            menu.numberOptionOrigin,
+            menu.stringOptionOrigin,
+            menu.playerOptionOrigin,
+            menu.settingsContainer));
 
-        // TODO: Reimplement this without breaking the menu.
-        // group.Options.ForEach(x => x.ChangeGameSetting());
+        OptionPreset? defaultPreset = null;
+        if (GameSettingMenuPatches.SelectedMod != null && PresetManager.DefaultPresets.TryGetValue(
+                GameSettingMenuPatches.SelectedMod,
+                out var preset))
+        {
+            defaultPreset = preset;
+        }
 
         foreach (var newOpt in options)
         {
@@ -321,14 +345,79 @@ internal static class GameOptionsMenuPatch
             if (newOpt is ToggleOption toggle)
             {
                 toggle.CheckMark.sprite = MiraAssets.Checkmark.LoadAsset();
-                toggle.CheckMark.color = group.GroupColor != MiraApiPlugin.DefaultHeaderColor ? group.GroupColor : MiraAssets.AcceptedTeal;
+                toggle.CheckMark.color = group.GroupColor != MiraApiPlugin.DefaultHeaderColor
+                    ? group.GroupColor
+                    : MiraAssets.AcceptedTeal;
                 var rend = toggle.CheckMark.transform.parent.FindChild("ActiveSprite")
                     .GetComponent<SpriteRenderer>();
                 rend.sprite = MiraAssets.CheckmarkBox.LoadAsset();
-                rend.color = group.GroupColor != MiraApiPlugin.DefaultHeaderColor ? group.GroupColor : MiraAssets.AcceptedTeal;
+                rend.color = group.GroupColor != MiraApiPlugin.DefaultHeaderColor
+                    ? group.GroupColor
+                    : MiraAssets.AcceptedTeal;
             }
 
             menu.Children.Add(newOpt);
+            var resetBtn = new GameObject("ResetOption");
+            resetBtn.transform.parent = newOpt.transform;
+            resetBtn.transform.localScale = new(.5f, .5f, 1);
+            resetBtn.layer = LayerMask.NameToLayer("UI");
+            resetBtn.transform.localPosition = new Vector3(-3.1f, 0f, -2f);
+            var resetRend = resetBtn.AddComponent<SpriteRenderer>();
+            resetRend.sprite = MiraAssets.ResetButton.LoadAsset();
+            resetRend.maskInteraction = SpriteMaskInteraction.VisibleInsideMask;
+            resetRend.color = group.GroupColor.Equals(MiraApiPlugin.DefaultHeaderColor)
+                ? Color.white
+                : group.GroupColor.FindAlternateColor();
+            var resetBoxCol = resetBtn.gameObject.AddComponent<BoxCollider2D>();
+            resetBoxCol.size = new Vector2(1f, 1f);
+            resetBoxCol.offset = new Vector2(0, 0);
+            var passiveButton = resetBtn.AddComponent<PassiveButton>();
+            passiveButton.OnClick = new Button.ButtonClickedEvent();
+            passiveButton.ClickSound = menu.BackButton.GetComponent<PassiveButton>().ClickSound;
+            passiveButton.OnMouseOver = new UnityEvent();
+            passiveButton.OnMouseOver.AddListener(
+                (UnityAction)(() =>
+                {
+                    resetRend.color = group.GroupColor != MiraApiPlugin.DefaultHeaderColor
+                        ? group.GroupColor
+                        : MiraAssets.AcceptedTeal;
+                }));
+            passiveButton.OnMouseOut = new UnityEvent();
+            passiveButton.OnMouseOut.AddListener(
+                (UnityAction)(() =>
+                {
+                    resetRend.color = group.GroupColor.Equals(MiraApiPlugin.DefaultHeaderColor)
+                        ? Color.white
+                        : group.GroupColor.FindAlternateColor();
+                }));
+            if (newOpt is ToggleOption toggleOpt)
+            {
+                passiveButton.OnClick.AddListener(
+                    (UnityAction)(() =>
+                    {
+                        defaultPreset!.ResetOption(toggleOpt);
+                    }));
+            }
+            else if (newOpt is NumberOption numOpt)
+            {
+                passiveButton.OnClick.AddListener(
+                    (UnityAction)(() =>
+                    {
+                        defaultPreset!.ResetOption(numOpt);
+                    }));
+            }
+            else if (newOpt is StringOption strOpt)
+            {
+                passiveButton.OnClick.AddListener(
+                    (UnityAction)(() =>
+                    {
+                        defaultPreset!.ResetOption(strOpt);
+                    }));
+            }
+            if (!defaultPreset!.IsOptionInPreset(newOpt))
+            {
+                resetBtn.Destroy();
+            }
 
             newOpt.Initialize();
             newOpt.gameObject.SetActive(false);

MiraAPI/Patches/Options/GameSettingMenuPatches.cs

@@ -110,12 +110,15 @@ internal static class GameSettingMenuPatches
                     {
                         case 3:
                             _modifiersButton?.SelectButton(true);
+                            __instance.MenuDescriptionText.text = SelectedMod != null ? SelectedMod.MiraPlugin.ModifierMenuDescription : "Configure modifiers and their settings here!";
                             break;
                         case 4:
                             _customOneButton?.SelectButton(true);
+                            __instance.MenuDescriptionText.text = SelectedMod != null ? SelectedMod.MiraPlugin.CustomOptionMenuOneDescription : "Apply game settings for this mod!";
                             break;
                         case 5:
                             _customTwoButton?.SelectButton(true);
+                            __instance.MenuDescriptionText.text = SelectedMod != null ? SelectedMod.MiraPlugin.CustomOptionMenuTwoDescription : "Apply game settings for this mod!";
                             break;
                     }
                 }

MiraAPI/Patches/Options/LobbyViewPanePatches.cs

@@ -185,7 +185,9 @@ public static class LobbyViewPanePatches
                 __instance.settingsInfo.Add(categoryHeaderRoleVariant.gameObject);
                 num -= 0.696f;
                 var roles = RoleManager.Instance.AllRoles.ToArray().Where(x =>
-                    x is not ICustomRole && x.Role != RoleTypes.Crewmate && x.Role != RoleTypes.Impostor &&
+                    x is not ICustomRole && !x.IsRoleBlacklisted() && x.Role != RoleTypes.Crewmate &&
+                    x.Role != RoleTypes.Impostor && ((i == 0 && x.TeamType is RoleTeamTypes.Crewmate) ||
+                                                     (i == 1 && x.TeamType is RoleTeamTypes.Impostor)) &&
                     x.Role != RoleTypes.CrewmateGhost && x.Role != RoleTypes.ImpostorGhost).ToList();
                 for (int j = 0; j < roles.Count; j++)
                 {
@@ -208,12 +210,19 @@ public static class LobbyViewPanePatches
                         list.Add(roleBehaviour);
                     }
 
+                    var color = (i == 0) ? Palette.CrewmateRoleBlue : Palette.ImpostorRoleRed;
+                    if (roleBehaviour is ICustomRole custom && (custom.Team is not ModdedRoleTeams.Crewmate &&
+                                                                custom.Team is not ModdedRoleTeams.Impostor))
+                    {
+                        color = Color.grey;
+                    }
+
                     viewSettingsInfoPanelRoleVariant.SetInfo(
                         roleBehaviour.NiceName,
                         numPerGame,
                         chancePerGame,
                         61,
-                        (i == 0) ? Palette.CrewmateRoleBlue : Palette.ImpostorRoleRed,
+                        color,
                         roleBehaviour.RoleIconSolid,
                         i == 0,
                         flag);
@@ -380,7 +389,7 @@ public static class LobbyViewPanePatches
 
         foreach (var grouping in sortedRoleGroups)
         {
-            if (!grouping.Any() || grouping.All(x => x.Configuration.HideSettings))
+            if (!grouping.Any() || grouping.All(x => x.Configuration.HideSettings || !x.VisibleInSettings()))
             {
                 continue;
             }
@@ -411,7 +420,7 @@ public static class LobbyViewPanePatches
 
             foreach (var customRole in grouping)
             {
-                if (customRole.Configuration.HideSettings)
+                if (customRole.Configuration.HideSettings || !customRole.VisibleInSettings())
                 {
                     continue;
                 }
@@ -511,6 +520,34 @@ public static class LobbyViewPanePatches
         instance.scrollBar.SetYBoundsMax(-num);
     }
 
+    public static void SetModdedHeader(this CategoryHeaderRoleVariant header, StringNames roleName, int maskLayer, ModdedRoleTeams team, Sprite? roleIcon = null)
+    {
+        header.SetHeader(roleName, maskLayer);
+        if (team is ModdedRoleTeams.Crewmate)
+        {
+            header.Background.color = Palette.CrewmateRoleHeaderBlue;
+            header.Divider.color = Palette.CrewmateRoleHeaderBlue;
+            header.Title.color = Palette.CrewmateRoleHeaderTextBlue;
+        }
+        else if (team is ModdedRoleTeams.Impostor)
+        {
+            header.Background.color = Palette.ImpostorRoleHeaderRed;
+            header.Divider.color = Palette.ImpostorRoleHeaderRed;
+            header.Title.color = Palette.ImpostorRoleHeaderTextRed;
+        }
+        else
+        {
+            header.Background.color = Color.grey;
+            header.Divider.color = Color.grey;
+            header.Title.color = new Color32(50, 50, 50, 255);
+        }
+        if (roleIcon != null && header.icon != null)
+        {
+            header.icon.material.SetInt(PlayerMaterial.MaskLayer, maskLayer);
+            header.icon.sprite = roleIcon;
+        }
+    }
+
     private static float SetUpAdvancedRoleViewPanel(
         AdvancedRoleViewPanel viewPanel,
         Type roleType,
@@ -534,10 +571,10 @@ public static class LobbyViewPanePatches
             return 0;
         }
 
-        viewPanel.header.SetHeader(
+        viewPanel.header.SetModdedHeader(
             role.StringName,
             maskLayer,
-            role.TeamType == RoleTeamTypes.Crewmate,
+            customRole.Team,
             customRole.Configuration.Icon != null ? customRole.Configuration.Icon.LoadAsset() : MiraAssets.Empty.LoadAsset());
         viewPanel.header.icon.transform.localScale = new Vector3(0.465f, 0.465f, 1f);
         viewPanel.divider.material.SetInt(PlayerMaterial.MaskLayer, maskLayer);

MiraAPI/Patches/Options/RoleSettingMenuPatches.cs

@@ -35,6 +35,19 @@ public static class RoleSettingMenuPatches
     private static RoleBehaviour? CurrentRole { get; set; }
     private static List<IModdedOption>? CurrentRoleOptions { get; set; }
 
+    [HarmonyPostfix]
+    [HarmonyPatch(nameof(RolesSettingsMenu.OnEnable))]
+    public static void OpenPatch(RolesSettingsMenu __instance)
+    {
+        HudManager.Instance.PlayerCam.OverrideScreenShakeEnabled = false;
+    }
+    [HarmonyPostfix]
+    [HarmonyPatch(nameof(RolesSettingsMenu.OnDisable))]
+    public static void ClosePatch(RolesSettingsMenu __instance)
+    {
+        HudManager.Instance.PlayerCam.OverrideScreenShakeEnabled = true;
+    }
+
     [HarmonyPostfix]
     [HarmonyPatch(nameof(RolesSettingsMenu.SetQuotaTab))]
     public static void SetQuotaTabPostfix(RolesSettingsMenu __instance)
@@ -74,10 +87,10 @@ public static class RoleSettingMenuPatches
             var num = 0.662f;
 
             var list = CustomRoleManager.AllRoles.Where(
-                r => !r.IsCustomRole() && r.TeamType == RoleTeamTypes.Crewmate && r.Role != RoleTypes.Crewmate &&
+                r => !r.IsCustomRole() && !r.IsRoleBlacklisted() && r.TeamType == RoleTeamTypes.Crewmate && r.Role != RoleTypes.Crewmate &&
                      r.Role != RoleTypes.CrewmateGhost).ToList();
             var list2 = CustomRoleManager.AllRoles.Where(
-                r => !r.IsCustomRole() && r.TeamType == RoleTeamTypes.Impostor && r.Role != RoleTypes.Impostor &&
+                r => !r.IsCustomRole() && !r.IsRoleBlacklisted() && r.TeamType == RoleTeamTypes.Impostor && r.Role != RoleTypes.Impostor &&
                      r.Role != RoleTypes.ImpostorGhost).ToList();
 
             if (__instance.roleTabs == null || __instance.roleTabs.Count == 0)
@@ -160,7 +173,7 @@ public static class RoleSettingMenuPatches
 
         foreach (var grouping in sortedRoleGroups)
         {
-            if (!grouping.Any() || grouping.All(x=>x.Configuration.HideSettings))
+            if (!grouping.Any() || grouping.All(x=> x.Configuration.HideSettings || !x.VisibleInSettings()))
             {
                 continue;
             }

MiraAPI/Patches/Options/SettingPatches.cs

@@ -1,5 +1,8 @@
 using System.Globalization;
+using System.Linq;
 using HarmonyLib;
+using MiraAPI.GameOptions;
+using MiraAPI.GameOptions.OptionTypes;
 using MiraAPI.Utilities;
 using UnityEngine;
 
@@ -28,7 +31,33 @@ public static class SettingPatches
         string result;
         var suffix = (MiraNumberSuffixes)__instance.SuffixType;
 
-        if (__instance.ZeroIsInfinity && Mathf.Abs(value) < 0.0001f)
+        var custom =
+            ModdedOptionsManager.ModdedOptions.Values.FirstOrDefault(opt =>
+                opt.OptionBehaviour != null && opt.OptionBehaviour.Data == __instance);
+        if (custom is ModdedNumberOption moddedNumberOption)
+        {
+            if (moddedNumberOption.NegativeWordValue != "#" && (int)value == -1)
+            {
+                result = $"<b>{moddedNumberOption.NegativeWordValue}</b>";
+            }
+            else if (moddedNumberOption.ZeroWordValue != "#" && Mathf.Abs(value) < 0.0001f)
+            {
+                result = $"<b>{moddedNumberOption.ZeroWordValue}</b>";
+            }
+            else
+            {
+                result = suffix switch
+                {
+                    MiraNumberSuffixes.None => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo),
+                    MiraNumberSuffixes.Multiplier => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo) + "x",
+                    MiraNumberSuffixes.Percent => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo) + "%",
+                    _ => TranslationController.Instance.GetString(
+                        StringNames.GameSecondsAbbrev,
+                        (Il2CppSystem.Object[])[value.ToString(__instance.FormatString, CultureInfo.InvariantCulture)]),
+                };
+            }
+        }
+        else if (__instance.ZeroIsInfinity && Mathf.Abs(value) < 0.0001f)
         {
             result = "<b>∞</b>";
         }
@@ -39,7 +68,6 @@ public static class SettingPatches
                 MiraNumberSuffixes.None => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo),
                 MiraNumberSuffixes.Multiplier => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo) + "x",
                 MiraNumberSuffixes.Percent => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo) + "%",
-                MiraNumberSuffixes.Distance => value.ToString(__instance.FormatString, NumberFormatInfo.InvariantInfo) + MiraApiPlugin.DistanceSuffix.Value,
                 _ => TranslationController.Instance.GetString(
                     StringNames.GameSecondsAbbrev,
                     (Il2CppSystem.Object[])[value.ToString(__instance.FormatString, CultureInfo.InvariantCulture)]),

MiraAPI/Patches/PlayerControlPatches.cs

@@ -117,6 +117,20 @@ internal static class PlayerControlPatches
         __instance.RpcMurderPlayer(target, true);
     }
 
+    [HarmonyPrefix]
+    [HarmonyPatch(nameof(PlayerControl.RpcMurderPlayer))]
+    [HarmonyPatch(nameof(PlayerControl.MurderPlayer))]
+    // ReSharper disable once InconsistentNaming
+    public static bool MurderPlayerPrefix(PlayerControl __instance)
+    {
+        if (LobbyBehaviour.Instance)
+        {
+            return false;
+        }
+
+        return true;
+    }
+
     [HarmonyPostfix]
     [HarmonyPatch(nameof(PlayerControl.FixedUpdate))]
     // ReSharper disable once InconsistentNaming

MiraAPI/Patches/Roles/HowToPlayPatch.cs

@@ -13,6 +13,10 @@ internal static class HowToPlayPatch
     // yes i patched the entire method
     private static void Prefix(HowToPlayScene __instance)
     {
+        if (RoleManager.Instance.AllRoles.ToArray().All(x => !x.IsCustomRole()))
+        {
+            return;
+        }
         __instance.sceneIndex = 0;
         __instance.category = HowToPlayScene.HowToPlayCategory.RolesSelection;
         __instance.startPage.SetActive(false);

MiraAPI/Patches/Roles/KillButtonPatches.cs

@@ -46,7 +46,7 @@ public static class KillButtonPatches
     }
 
     /// <summary>
-    /// Use Custom Murder if player is custom role.
+    /// Use Custom Murder instead of Murder Player from vanilla.
     /// </summary>
     [HarmonyPrefix]
     [HarmonyPatch(nameof(KillButton.DoClick))]
@@ -58,12 +58,7 @@ public static class KillButtonPatches
             return false;
         }
 
-        if (PlayerControl.LocalPlayer.Data.Role is not ICustomRole)
-        {
-            return true;
-        }
-
-        PlayerControl.LocalPlayer.RpcCustomMurder(__instance.currentTarget);
+        PlayerControl.LocalPlayer.RpcCustomMurder(__instance.currentTarget, MeetingCheck.OutsideMeeting);
         __instance.SetTarget(null);
 
         return false;

MiraAPI/Patches/Roles/LogicRoleSelectionHnsPatch.cs

@@ -0,0 +1,183 @@
+using AmongUs.GameOptions;
+using HarmonyLib;
+using Il2CppSystem.Collections.Generic;
+using System.Linq;
+using MiraAPI.Roles;
+
+namespace MiraAPI.Patches.Roles;
+
+[HarmonyPatch(typeof(LogicRoleSelectionHnS))]
+public static class LogicRoleSelectionHnsPatch
+{
+    [HarmonyPrefix]
+    [HarmonyPatch(nameof(LogicRoleSelectionHnS.AssignRolesForTeam))]
+    public static bool AssignRolesForTeam(
+        LogicRoleSelectionHnS __instance,
+        List<NetworkedPlayerInfo> players,
+        IGameOptions opts,
+        RoleTeamTypes team,
+        int teamMax,
+        Il2CppSystem.Nullable<RoleTypes> defaultRole)
+    {
+        Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Team: {team}, Max: {teamMax}, Players: {players.Count}, DefaultRole: {defaultRole}");
+        int num = 0;
+        IRoleOptionsCollection roleOptions = opts.RoleOptions;
+        var source = RoleManager.Instance.AllRoles.ToArray()
+            .Where(role => role.TeamType == team && !RoleManager.IsGhostRole(role.Role) &&
+                           CustomRoleUtils.CanSpawnOnCurrentMode(role));
+        var assignmentData = source.Where(x => !x.IsDead).Select(role =>
+            new RoleManager.RoleAssignmentData(
+                role,
+                roleOptions.GetNumPerGame(role.Role),
+                roleOptions.GetChancePerGame(role.Role))).ToList();
+        var source2 = CustomRoleUtils.GetPossibleRoles(assignmentData, x => x.Chance == 100);
+        var guaranteedRoles = source.Where(x => source2.Contains(((ushort)x.Role, 100)));
+        List<RoleTypes> list = new List<RoleTypes>();
+        if (team == RoleTeamTypes.Crewmate)
+        {
+            Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Before Guaranteed Assignment");
+            foreach (RoleManager.RoleAssignmentData roleAssignmentData in guaranteedRoles.Select((x) =>
+                         new RoleManager.RoleAssignmentData(x, roleOptions.GetNumPerGame(x.Role), 100)))
+            {
+                while (true)
+                {
+                    RoleManager.RoleAssignmentData roleAssignmentData2 = roleAssignmentData;
+                    int count = roleAssignmentData2.Count;
+                    roleAssignmentData2.Count = count - 1;
+                    if (count <= 0)
+                    {
+                        break;
+                    }
+
+                    list.Add(roleAssignmentData.Role.Role);
+                }
+            }
+            Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Guaranteed Assignment");
+            AssignRolesFromList(players, teamMax, list, ref num);
+
+            var list2 = source.Where(x => !x.IsDead).Select(role =>
+                new RoleManager.RoleAssignmentData(
+                    role,
+                    roleOptions.GetNumPerGame(role.Role),
+                    roleOptions.GetChancePerGame(role.Role))).ToList();
+
+            list.Clear();
+            foreach (RoleManager.RoleAssignmentData roleAssignmentData3 in list2)
+            {
+                for (int i = 0; i < roleAssignmentData3.Count; i++)
+                {
+                    if (HashRandom.Next(101) < roleAssignmentData3.Chance)
+                    {
+                        list.Add(roleAssignmentData3.Role.Role);
+                    }
+                }
+            }
+            Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Potential Assignment");
+
+            AssignRolesFromList(players, teamMax, list, ref num);
+            var basicRole = RoleTypes.Engineer;
+            while (list.Count < players.Count && list.Count + num < teamMax)
+            {
+                list.Add(basicRole);
+            }
+
+            AssignRolesFromList(players, teamMax, list, ref num);
+            Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Fallback Assignment");
+        }
+        else if (team == RoleTeamTypes.Impostor)
+        {
+            Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Before Guaranteed Assignment");
+            var newImpostors = new List<NetworkedPlayerInfo>();
+            // Specified Seeker
+            if (__instance.hnsManager.LogicOptionsHnS.HasImpostorPlayerID() &&
+                __instance.hnsManager.LogicOptionsHnS.ValidateImpostorPlayerID(players) &&
+                !AmongUsClient.Instance.IsGamePublic)
+            {
+                NetworkedPlayerInfo networkedPlayerInfo = players.ToArray()
+                    .First(p => p.PlayerId == __instance.hnsManager.LogicOptionsHnS.ImpostorPlayerID());
+                players.Remove(networkedPlayerInfo);
+                newImpostors.Add(networkedPlayerInfo);
+                Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Seeker is {networkedPlayerInfo.PlayerName}, ID: {networkedPlayerInfo.PlayerId}");
+            }
+            // Random Seeker
+            else
+            {
+                int num2 = 0;
+                while (num2 < teamMax && players.Count > 0)
+                {
+                    PseudoRandomList<NetworkedPlayerInfo> pseudoRandomList = new PseudoRandomList<NetworkedPlayerInfo>(AmongUsClient.Instance.GameId);
+                    players._items.Do(x => pseudoRandomList.Add(x));
+                    for (int i = 0; i < GameData.RoundsPlayedInSession; i++)
+                    {
+                        pseudoRandomList.PickRandom();
+                    }
+                    NetworkedPlayerInfo networkedPlayerInfo = pseudoRandomList.PickRandom();
+                    players.Remove(networkedPlayerInfo);
+                    newImpostors.Add(networkedPlayerInfo);
+                    num2++;
+                    Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Seeker is {networkedPlayerInfo.PlayerName}, ID: {networkedPlayerInfo.PlayerId}");
+                }
+            }
+            Error($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Guaranteed Assignment");
+            foreach (RoleManager.RoleAssignmentData roleAssignmentData in guaranteedRoles.Select((x) =>
+                         new RoleManager.RoleAssignmentData(x, roleOptions.GetNumPerGame(x.Role), 100)))
+            {
+                while (true)
+                {
+                    RoleManager.RoleAssignmentData roleAssignmentData2 = roleAssignmentData;
+                    int count = roleAssignmentData2.Count;
+                    roleAssignmentData2.Count = count - 1;
+                    if (count <= 0)
+                    {
+                        break;
+                    }
+
+                    list.Add(roleAssignmentData.Role.Role);
+                }
+            }
+            AssignRolesFromList(newImpostors, teamMax, list, ref num);
+
+            var list2 = source.Where(x => !x.IsDead).Select(role =>
+                new RoleManager.RoleAssignmentData(
+                    role,
+                    roleOptions.GetNumPerGame(role.Role),
+                    roleOptions.GetChancePerGame(role.Role))).ToList();
+
+            list.Clear();
+            foreach (RoleManager.RoleAssignmentData roleAssignmentData3 in list2)
+            {
+                for (int i = 0; i < roleAssignmentData3.Count; i++)
+                {
+                    if (HashRandom.Next(101) < roleAssignmentData3.Chance)
+                    {
+                        list.Add(roleAssignmentData3.Role.Role);
+                    }
+                }
+            }
+
+            AssignRolesFromList(newImpostors, teamMax, list, ref num);
+            var basicRole = RoleTypes.Impostor;
+            while (list.Count < newImpostors.Count && list.Count + num < teamMax)
+            {
+                list.Add(basicRole);
+            }
+
+            AssignRolesFromList(newImpostors, teamMax, list, ref num);
+        }
+        return false;
+    }
+
+    public static void AssignRolesFromList(List<NetworkedPlayerInfo> players, int teamMax, List<RoleTypes> roleList, ref int rolesAssigned)
+    {
+        while (roleList.Count > 0 && players.Count > 0 && rolesAssigned < teamMax)
+        {
+            int index = HashRandom.FastNext(roleList.Count);
+            RoleTypes roleType = roleList[index];
+            roleList.RemoveAt(index);
+            int index2 = HashRandom.FastNext(players.Count);
+            players[index2].Object.RpcSetRole(roleType, false);
+            players.RemoveAt(index2);
+            rolesAssigned++;
+        }
+    }
+}

MiraAPI/Patches/Roles/LogicRoleSelectionNormalPatch.cs

@@ -0,0 +1,93 @@
+using AmongUs.GameOptions;
+using HarmonyLib;
+using Il2CppSystem.Collections.Generic;
+using System.Linq;
+using MiraAPI.Roles;
+
+namespace MiraAPI.Patches.Roles;
+
+[HarmonyPatch(typeof(LogicRoleSelectionNormal))]
+public static class LogicRoleSelectionNormalPatch
+{
+    [HarmonyPrefix]
+    [HarmonyPatch(nameof(LogicRoleSelectionNormal.AssignRolesForTeam))]
+    public static bool AssignRolesForTeam(
+        LogicRoleSelectionNormal __instance,
+        List<NetworkedPlayerInfo> players,
+        IGameOptions opts,
+        RoleTeamTypes team,
+        int teamMax,
+        Il2CppSystem.Nullable<RoleTypes> defaultRole)
+    {
+        int num = 0;
+        var source = RoleManager.Instance.AllRoles.ToArray()
+            .Where(role => role.TeamType == team && !RoleManager.IsGhostRole(role.Role) &&
+                           CustomRoleUtils.CanSpawnOnCurrentMode(role));
+        List<RoleTypes> list = new List<RoleTypes>();
+        IRoleOptionsCollection roleOptions = opts.RoleOptions;
+
+        var assignmentData = source.Where(x => !x.IsDead).Select(role =>
+            new RoleManager.RoleAssignmentData(
+                role,
+                roleOptions.GetNumPerGame(role.Role),
+                roleOptions.GetChancePerGame(role.Role))).ToList();
+        var source2 = CustomRoleUtils.GetPossibleRoles(assignmentData, x => x.Chance == 100);
+        var guaranteedRoles = source.Where(x => source2.Contains(((ushort)x.Role, 100)));
+        foreach (RoleManager.RoleAssignmentData roleAssignmentData in guaranteedRoles.Select((x) =>
+                     new RoleManager.RoleAssignmentData(x, roleOptions.GetNumPerGame(x.Role), 100)))
+        {
+            while (true)
+            {
+                RoleManager.RoleAssignmentData roleAssignmentData2 = roleAssignmentData;
+                int count = roleAssignmentData2.Count;
+                roleAssignmentData2.Count = count - 1;
+                if (count <= 0)
+                {
+                    break;
+                }
+
+                list.Add(roleAssignmentData.Role.Role);
+            }
+        }
+
+        __instance.AssignRolesFromList(players, teamMax, list, ref num);
+
+        var list2 = source.Where(x => !x.IsDead).Select(role =>
+            new RoleManager.RoleAssignmentData(
+                role,
+                roleOptions.GetNumPerGame(role.Role),
+                roleOptions.GetChancePerGame(role.Role))).ToList();
+
+        list.Clear();
+        foreach (RoleManager.RoleAssignmentData roleAssignmentData3 in list2)
+        {
+            for (int i = 0; i < roleAssignmentData3.Count; i++)
+            {
+                if (HashRandom.Next(101) < roleAssignmentData3.Chance)
+                {
+                    list.Add(roleAssignmentData3.Role.Role);
+                }
+            }
+        }
+
+        __instance.AssignRolesFromList(players, teamMax, list, ref num);
+        var defaultRole2 = team is RoleTeamTypes.Crewmate ? RoleTypes.Crewmate : RoleTypes.Impostor;
+        try
+        {
+            defaultRole2 = defaultRole.Value;
+        }
+        catch
+        {
+            // Ignored
+        }
+
+        while (list.Count < players.Count && list.Count + num < teamMax)
+        {
+            list.Add(defaultRole2);
+        }
+
+        __instance.AssignRolesFromList(players, teamMax, list, ref num);
+
+        return false;
+    }
+}

MiraAPI/Patches/Roles/NameTagPatch.cs

@@ -20,7 +20,7 @@ public static class NameTagPatch
             return false;
         }
 
-        if (PlayerControl.LocalPlayer.Data.Role.IsImpostor && otherPlayerRole.IsImpostor)
+        if (PlayerControl.LocalPlayer.Data?.Role?.IsImpostor == true && otherPlayerRole.IsImpostor)
         {
             return true;
         }
@@ -30,7 +30,7 @@ public static class NameTagPatch
             return true;
         }
 
-        if (!PlayerControl.LocalPlayer || !PlayerControl.LocalPlayer.Data || !PlayerControl.LocalPlayer.Data.Role || !otherPlayerRole)
+        if (!PlayerControl.LocalPlayer || !PlayerControl.LocalPlayer.Data || !PlayerControl.LocalPlayer.Data?.Role || !otherPlayerRole)
         {
             __result = Color.white;
         }

MiraAPI/Patches/Roles/RoleManagerPatches.cs

@@ -1,6 +1,7 @@
 using System.Linq;
 using AmongUs.GameOptions;
 using HarmonyLib;
+using InnerNet;
 using MiraAPI.Events;
 using MiraAPI.Events.Vanilla.Gameplay;
 using MiraAPI.Modifiers;

MiraAPI/PluginLoading/IMiraPlugin.cs

@@ -22,6 +22,21 @@ public interface IMiraPlugin
     /// </summary>
     public virtual string CustomOptionMenuNameTwo => "Custom Category 2";
 
+    /// <summary>
+    /// Gets the description for the second custom category in the game options menu, if any.
+    /// </summary>
+    public virtual string ModifierMenuDescription => "Configure modifiers and their settings here!";
+
+    /// <summary>
+    /// Gets the description for the first custom category in the game options menu, if any.
+    /// </summary>
+    public virtual string CustomOptionMenuOneDescription => "Apply game settings for this mod!";
+
+    /// <summary>
+    /// Gets the description for the second custom category in the game options menu, if any.
+    /// </summary>
+    public virtual string CustomOptionMenuTwoDescription => "Apply game settings for this mod!";
+
     /// <summary>
     /// Gets the BepInEx configuration file for the plugin.
     /// </summary>

MiraAPI/PluginLoading/MiraPluginInfo.cs

@@ -51,7 +51,7 @@ public class MiraPluginInfo
     public IReadOnlyCollection<CustomActionButton> Buttons { get; private set; } = null!;
 
     /// <summary>
-    /// Gets a read only dictionary of this plugin's custom game modes.
+    /// Gets a read only dictionary of this plugin's custom presets.
     /// </summary>
     public IReadOnlyCollection<OptionPreset> Presets { get; internal set; } = null!;
 

MiraAPI/Presets/OptionPreset.cs

@@ -71,4 +71,26 @@ public class OptionPreset
 
         CustomRoleManager.SyncAllRoleSettings();
     }
+
+    /// <summary>
+    /// Resets the specified option with the preset provided.
+    /// </summary>
+    public void ResetOption(OptionBehaviour baseOption)
+    {
+        var selectedOpt = Plugin.InternalOptions.First(x => x.OptionBehaviour == baseOption);
+        selectedOpt.LoadFromPreset(PresetConfig);
+        /*ModdedOptionsManager.SyncAllOptions();
+
+        CustomRoleManager.SyncAllRoleSettings();*/
+    }
+
+    /// <summary>
+    /// Gets whether the specified option is included in the preset.
+    /// </summary>
+    /// <returns>>The value of whether the option is in the preset.</returns>
+    public bool IsOptionInPreset(OptionBehaviour baseOption)
+    {
+        var selectedOpt = Plugin.InternalOptions.First(x => x.OptionBehaviour == baseOption);
+        return selectedOpt.ConfigDefinition != null && PresetConfig.ContainsKey(selectedOpt.ConfigDefinition);
+    }
 }

MiraAPI/Presets/PresetManager.cs

@@ -1,4 +1,5 @@
-using System.IO;
+using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using BepInEx.Configuration;
 using MiraAPI.PluginLoading;
@@ -18,6 +19,14 @@ public static class PresetManager
     /// </summary>
     public static string PresetDirectory { get; } = Path.GetFullPath("mira_presets", Application.persistentDataPath);
 
+    internal static Dictionary<MiraPluginInfo, OptionPreset> DefaultPresets { get; } = [];
+    internal static List<OptionPreset> InternalMasterPresets { get; } = [];
+
+    /// <summary>
+    /// Gets a read only dictionary of this plugin's custom presets.
+    /// </summary>
+    public static IReadOnlyCollection<OptionPreset> MasterPresets { get; internal set; } = null!;
+
     internal static void CreateDefaultPreset(MiraPluginInfo plugin)
     {
         var presetPath = Path.Combine(PresetDirectory, plugin.PluginId);
@@ -39,6 +48,7 @@ public static class PresetManager
         }
 
         presetConfig.Save();
+        DefaultPresets.Add(plugin, new OptionPreset("Default", plugin, presetConfig));
     }
 
     /// <summary>
@@ -93,4 +103,58 @@ public static class PresetManager
         }
         plugin.Presets = [..plugin.InternalPresets];
     }
+
+    /// <summary>
+    /// Loads the master presets by reading the configuration files from the preset directory.
+    /// </summary>
+    public static void LoadMasterPreset()
+    {
+        /*foreach (var btn in plugin.InternalPresets.Select(x=>x.PresetButton))
+        {
+            if (btn != null)
+            {
+                Object.DestroyImmediate(btn);
+            }
+        }
+
+        plugin.InternalPresets.Clear();*/
+        if (!Directory.Exists(PresetDirectory))
+        {
+            Directory.CreateDirectory(PresetDirectory);
+        }
+
+        var pluginPresetPath = Path.Combine(PresetDirectory, "MasterPresets");
+        if (!Directory.Exists(pluginPresetPath))
+        {
+            Directory.CreateDirectory(pluginPresetPath);
+        }
+
+        foreach (var file in Directory.GetFiles(pluginPresetPath, "*.cfg"))
+        {
+            var fileName = Path.GetFileName(file);
+            Info($"Loading preset file {fileName}");
+            var presetName = Path.GetFileNameWithoutExtension(file);
+            var presetConfig = new ConfigFile(file, false)
+            {
+                SaveOnConfigSet = false,
+            };
+            foreach (var plugin in MiraPluginManager.Instance.RegisteredPlugins)
+            {
+                foreach (var option in plugin.InternalOptions.Where(x=>x.IncludeInPreset))
+                {
+                    option.Bind(presetConfig);
+                }
+
+                foreach (var role in plugin.InternalRoles.Values.OfType<ICustomRole>().Where(x=>!x.Configuration.HideSettings))
+                {
+                    role.BindConfig(presetConfig);
+                }
+            }
+
+            presetConfig.Save();
+
+            // InternalMasterPresets.Add(new OptionPreset(presetName, plugin, presetConfig));
+        }
+        MasterPresets = [..InternalMasterPresets];
+    }
 }

MiraAPI/Roles/CustomRoleConfiguration.cs

@@ -1,7 +1,9 @@
-using AmongUs.GameOptions;
+using AmongUs.GameOptions;
+using System;
+using Il2CppInterop.Runtime.Attributes;
+using MiraAPI.Patches.Freeplay;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
-
 namespace MiraAPI.Roles;
 
 /// <summary>
@@ -9,6 +11,16 @@ namespace MiraAPI.Roles;
 /// </summary>
 public record struct CustomRoleConfiguration
 {
+#pragma warning disable S1133
+    [Obsolete("Default constructor is not supported. Please use the constructor that takes an ICustomRole parameter.")]
+#pragma warning restore S1133
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+    public CustomRoleConfiguration()
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
+    {
+        throw new NotImplementedException("Default constructor is not supported. Please use the constructor that takes an ICustomRole parameter.");
+    }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="CustomRoleConfiguration"/> struct.
     /// </summary>
@@ -36,7 +48,7 @@ public record struct CustomRoleConfiguration
         {
             ModdedRoleTeams.Crewmate => TranslationController.Instance.GetString(StringNames.Crewmate),
             ModdedRoleTeams.Impostor => TranslationController.Instance.GetString(StringNames.Impostor),
-            _ => "Neutral",
+            _ => TaskAdderPatches.NeutralName,
         };
         IntroSound = role.Team is ModdedRoleTeams.Crewmate
             ? CustomRoleManager.CrewmateIntroSound
@@ -66,16 +78,19 @@ public record struct CustomRoleConfiguration
     /// <summary>
     /// Gets or sets the Sprite used for the Role Options menu screenshot.
     /// </summary>
+    [HideFromIl2Cpp]
     public LoadableAsset<Sprite>? OptionsScreenshot { get; set; } = null;
 
     /// <summary>
     /// Gets or sets the Sprite used for the Role Icon.
     /// </summary>
+    [HideFromIl2Cpp]
     public LoadableAsset<Sprite>? Icon { get; set; } = null;
 
     /// <summary>
     /// Gets or sets the Intro sound for the Role.
     /// </summary>
+    [HideFromIl2Cpp]
     public LoadableAsset<AudioClip>? IntroSound { get; set; } = null;
 
     /// <summary>

MiraAPI/Roles/CustomRoleManager.cs

@@ -89,15 +89,22 @@ public static class CustomRoleManager
 
         foreach (var roleType in roles)
         {
-            ClassInjector.RegisterTypeInIl2Cpp(roleType);
-
-            var role = RegisterRole(roleType, pluginInfo);
-            if (role is null)
+            try
             {
-                continue;
-            }
+                ClassInjector.RegisterTypeInIl2Cpp(roleType);
 
-            pluginInfo.InternalRoles.Add((ushort)role.Role, role);
+                var role = RegisterRole(roleType, pluginInfo);
+                if (role is null)
+                {
+                    continue;
+                }
+
+                pluginInfo.InternalRoles.Add((ushort)role.Role, role);
+            }
+            catch (Exception ex)
+            {
+                Error($"Failed to register role type {roleType.Name}: {ex}");
+            }
         }
 
         pluginInfo.PluginConfig.Save();

MiraAPI/Roles/CustomRoleUtils.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
 using System.Text;
@@ -13,6 +14,62 @@ namespace MiraAPI.Roles;
 /// </summary>
 public static class CustomRoleUtils
 {
+    /// <summary>
+    /// Determines whether the specified role can spawn in general, accounting for gamemodes and everything else.
+    /// </summary>
+    /// <param name="role">The role you would like to check for.</param>
+    /// <returns>True if the role is able to spawn, otherwise false.</returns>
+    public static bool CanSpawnOnCurrentMode(RoleBehaviour role)
+    {
+        if (role is ICustomRole custom)
+        {
+            return custom.CanSpawnOnCurrentMode();
+        }
+
+        if (GameManager.Instance.IsHideAndSeek())
+        {
+            return role.Role is RoleTypes.Engineer || role.Role is RoleTypes.Impostor;
+        }
+        return true;
+    }
+
+    public static List<(ushort RoleType, int Chance)> GetPossibleRoles(
+        List<RoleManager.RoleAssignmentData> assignmentData,
+        Func<RoleManager.RoleAssignmentData, bool>? predicate = null)
+    {
+        var roles = new List<(ushort, int)>();
+
+        assignmentData.Where(x => predicate == null || predicate(x)).ToList().ForEach(x =>
+        {
+            for (var i = 0; i < x.Count; i++)
+            {
+                roles.Add(((ushort)x.Role.Role, x.Chance));
+            }
+        });
+
+        return roles;
+    }
+
+    public static RoleManager.RoleAssignmentData GetAssignData(RoleTypes roleType)
+    {
+        var currentGameOptions = GameOptionsManager.Instance.CurrentGameOptions;
+        var roleOptions = currentGameOptions.RoleOptions;
+
+        var role = GetRegisteredRole(roleType);
+        var assignmentData = new RoleManager.RoleAssignmentData(role, roleOptions.GetNumPerGame(role!.Role),
+            roleOptions.GetChancePerGame(role.Role));
+
+        return assignmentData;
+    }
+
+    public static RoleBehaviour? GetRegisteredRole(RoleTypes roleType)
+    {
+        // we want to prioritize the custom roles because the role has the right RoleColour/TeamColor
+        var role = CustomRoleManager.AllRoles.FirstOrDefault(x => x.Role == roleType);
+
+        return role;
+    }
+
     /// <summary>
     /// Gets all active in-game roles.
     /// </summary>

MiraAPI/Roles/ICustomRole.cs

@@ -1,4 +1,5 @@
-using System.Text;
+using System;
+using System.Text;
 using BepInEx.Configuration;
 using MiraAPI.GameOptions;
 using MiraAPI.Modifiers;
@@ -239,4 +240,15 @@ public interface ICustomRole : IOptionable
     {
         return true;
     }
+
+    /// <summary>
+    /// Determines whether the role can spawn in general, accounting for gamemodes and everything else.
+    /// </summary>
+    /// <returns>True if the role is able to spawn, otherwise false.</returns>
+    public virtual bool CanSpawnOnCurrentMode() => !GameManager.Instance.IsHideAndSeek();
+
+    /// <summary>
+    /// Gets the function that determines whether the role should be toggled on or off in the game settings.
+    /// </summary>
+    public virtual Func<bool> VisibleInSettings => () => true;
 }

MiraAPI/Utilities/Assets/MiraAssets.cs

@@ -90,6 +90,11 @@ public static class MiraAssets
     /// </summary>
     public static LoadableResourceAsset CheckmarkBox { get; } = new("MiraAPI.Resources.CheckMarkBox.png");
 
+    /// <summary>
+    /// Gets the Reset Box used in the Settings Menu.
+    /// </summary>
+    public static LoadableResourceAsset ResetButton { get; } = new("MiraAPI.Resources.ResetButton.png");
+
     /// <summary>
     /// Gets the Checkmark used in the Settings Menu.
     /// </summary>

MiraAPI/Utilities/EnumSerializer.cs

@@ -1,145 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
-namespace MiraAPI.Utilities;
-
-/// <summary>
-/// Enum serializer for converting enums to and from byte arrays.
-/// </summary>
-public static class EnumSerializer
-{
-    /// <summary>
-    /// Serializes an enum to an array of bytes.
-    /// </summary>
-    /// <param name="value">The enum value to serialize.</param>
-    /// <typeparam name="T">The enum type.</typeparam>
-    /// <returns>A byte array representing the enum value.</returns>
-    /// <exception cref="ArgumentException">Thrown when the underlying type is not recognized.</exception>
-    public static byte[] EnumToBytes<T>(T value) where T : struct, Enum
-    {
-        var underlyingType = typeof(T).GetEnumUnderlyingType();
-
-        return underlyingType switch
-        {
-            not null when underlyingType == typeof(byte) => [(byte)(object)value],
-            not null when underlyingType == typeof(sbyte) => [(byte)(sbyte)(object)value],
-            not null when underlyingType == typeof(short) => BitConverter.GetBytes((short)(object)value),
-            not null when underlyingType == typeof(ushort) => BitConverter.GetBytes((ushort)(object)value),
-            not null when underlyingType == typeof(int) => BitConverter.GetBytes((int)(object)value),
-            not null when underlyingType == typeof(uint) => BitConverter.GetBytes((uint)(object)value),
-            not null when underlyingType == typeof(long) => BitConverter.GetBytes((long)(object)value),
-            not null when underlyingType == typeof(ulong) => BitConverter.GetBytes((ulong)(object)value),
-            _ => throw new ArgumentException("Unknown underlying type for " + typeof(T).Name),
-        };
-    }
-
-    /// <summary>
-    /// Converts bytes to an enum using the underlying type.
-    /// </summary>
-    /// <param name="bytes">The byte array to convert.</param>
-    /// <param name="offset">The offset in the byte array to start reading from.</param>
-    /// <param name="underlyingType">The underlying type of the enum.</param>
-    /// <typeparam name="T">The enum type.</typeparam>
-    /// <returns>The enum value represented by the bytes.</returns>
-    /// <exception cref="ArgumentException">Thrown when the underlying type is not recognized.</exception>
-    public static T EnumFromBytes<T>(byte[] bytes, int offset, Type underlyingType) where T : struct, Enum
-    {
-        return underlyingType switch
-        {
-            { } t when t == typeof(byte) || t == typeof(sbyte) => (T)(object)bytes[offset],
-            { } t when t == typeof(short) => (T)(object)BitConverter.ToInt16(bytes, offset),
-            { } t when t == typeof(ushort) => (T)(object)BitConverter.ToUInt16(bytes, offset),
-            { } t when t == typeof(int) => (T)(object)BitConverter.ToInt32(bytes, offset),
-            { } t when t == typeof(uint) => (T)(object)BitConverter.ToUInt32(bytes, offset),
-            { } t when t == typeof(long) => (T)(object)BitConverter.ToInt64(bytes, offset),
-            { } t when t == typeof(ulong) => (T)(object)BitConverter.ToUInt64(bytes, offset),
-            _ => throw new ArgumentException("Unknown underlying type for " + typeof(T).Name),
-        };
-    }
-
-    /// <inheritdoc cref="EnumFromBytes{T}(byte[], int, Type)"/>
-    public static T EnumFromBytes<T>(byte[] bytes, int offset) where T : struct, Enum => EnumFromBytes<T>(bytes, offset, typeof(T).GetEnumUnderlyingType());
-
-    /// <summary>
-    /// Converts a byte array into a collection of enum values.
-    /// </summary>
-    /// <param name="bytes">The byte array to convert.</param>
-    /// <typeparam name="T">The enum type.</typeparam>
-    /// <returns>An enumerable collection of enum values.</returns>
-    /// <exception cref="ArgumentException">Thrown when the byte array length is not a multiple of the enum's underlying type size.</exception>
-    public static IEnumerable<T> EnumsFromBytes<T>(byte[] bytes) where T : struct, Enum
-    {
-        var underlyingType = typeof(T).GetEnumUnderlyingType();
-        var size = GetManagedSize(underlyingType);
-
-        if (bytes.Length % size != 0)
-        {
-            throw new ArgumentException("Byte array length must be a multiple of " + size + ".");
-        }
-
-        return EnumsFromBytesIterator<T>(bytes, underlyingType, size);
-    }
-
-    private static IEnumerable<T> EnumsFromBytesIterator<T>(byte[] bytes, Type underlyingType, int size) where T : struct, Enum
-    {
-        var count = bytes.Length / size;
-        var underlyingArray = Array.CreateInstance(underlyingType, count);
-        Buffer.BlockCopy(bytes, 0, underlyingArray, 0, bytes.Length);
-
-        foreach (var value in underlyingArray)
-            yield return (T)value;
-    }
-
-    /// <summary>
-    /// Converts a collection of enum values to a byte array.
-    /// </summary>
-    /// <param name="values"> The collection of enum values to convert.</param>
-    /// <typeparam name="T">The enum type.</typeparam>
-    /// <returns>A byte array representing the collection of enum values.</returns>
-    public static byte[] EnumsToBytes<T>(IEnumerable<T> values) where T : struct, Enum
-    {
-        var underlyingType = typeof(T).GetEnumUnderlyingType();
-        var size = GetManagedSize(underlyingType);
-        var valuesArray = values.ToArray();
-        var count = valuesArray.Length;
-
-        var underlyingArray = Array.CreateInstance(underlyingType, count);
-        for (var i = 0; i < count; i++)
-        {
-            underlyingArray.SetValue(ConvertToUnderlyingType(valuesArray[i], underlyingType), i);
-        }
-
-        var bytes = new byte[count * size];
-        Buffer.BlockCopy(underlyingArray, 0, bytes, 0, bytes.Length);
-        return bytes;
-    }
-
-    private static object ConvertToUnderlyingType<T>(T value, Type underlyingType) where T : struct, Enum
-    {
-        return underlyingType switch
-        {
-            not null when underlyingType == typeof(byte) => (byte)(object)value,
-            not null when underlyingType == typeof(sbyte) => (sbyte)(object)value,
-            not null when underlyingType == typeof(short) => (short)(object)value,
-            not null when underlyingType == typeof(ushort) => (ushort)(object)value,
-            not null when underlyingType == typeof(int) => (int)(object)value,
-            not null when underlyingType == typeof(uint) => (uint)(object)value,
-            not null when underlyingType == typeof(long) => (long)(object)value,
-            not null when underlyingType == typeof(ulong) => (ulong)(object)value,
-            _ => throw new InvalidOperationException("Unsupported underlying type."),
-        };
-    }
-
-    private static int GetManagedSize(Type type)
-    {
-        return Type.GetTypeCode(type) switch
-        {
-            TypeCode.Byte or TypeCode.SByte => 1,
-            TypeCode.Int16 or TypeCode.UInt16 => 2,
-            TypeCode.Int32 or TypeCode.UInt32 => 4,
-            TypeCode.Int64 or TypeCode.UInt64 => 8,
-            _ => throw new ArgumentException("Unsupported underlying type: " + type.Name),
-        };
-    }
-}

MiraAPI/Utilities/Helpers.cs

@@ -1,8 +1,8 @@
-using System;
-using System.Collections;
+using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
+using AmongUs.GameOptions;
 using HarmonyLib;
 using Il2CppInterop.Runtime.InteropTypes.Arrays;
 using MiraAPI.Roles;
@@ -13,7 +13,6 @@ using TMPro;
 using UnityEngine;
 using MethodBase = System.Reflection.MethodBase;
 using Object = UnityEngine.Object;
-using Random = UnityEngine.Random;
 
 namespace MiraAPI.Utilities;
 
@@ -524,79 +523,6 @@ public static class Helpers
                 (Il2CppSystem.Object[])[value.ToString(formatString, CultureInfo.InvariantCulture)]),
         };
     }
-    /// <summary>
-    /// Shorthand for <see cref="string.Split(char, StringSplitOptions)"/> that removes empty entries and trims leading and ending spaces.
-    /// </summary>
-    /// <param name="value">The string to split.</param>
-    /// <param name="separator">The separator.</param>
-    /// <returns>An array of substrings.</returns>
-    public static string[] TrueSplit(this string value, char separator) => value.Split(separator, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
-
-    /// <summary>
-    /// Joins a collection of items that are separated by a character.
-    /// </summary>
-    /// <param name="separator">The separator.</param>
-    /// <param name="items">The collection of items to string together.</param>
-    /// <typeparam name="T">The type of the items.</typeparam>
-    /// <returns>A string formed by concatenating the ToString results of each item, each separated by a separator.</returns>
-    public static string Join<T>(char separator, IEnumerable<T> items) => Join(separator.ToString(), items);
-
-    /// <inheritdoc cref="Join{T}(char, IEnumerable{T})"/>
-    public static string Join<T>(string separator, IEnumerable<T> items)
-    {
-        if (!items.Any())
-            return string.Empty;
-
-        var result = string.Empty;
-        items.Do(x => result += $"{separator}{x}");
-        return result[separator.Length..];
-    }
-
-    /// <summary>
-    /// Shorthand helper for overriding the on click listeners for PassiveButton.
-    /// </summary>
-    /// <param name="passive">The PassiveButton being modified.</param>
-    /// <param name="action">The action that's replacing the original listeners.</param>
-    public static void OverrideOnClickListeners(this PassiveButton passive, Action action)
-    {
-        if (!passive)
-            return;
-
-        passive.OnClick?.RemoveAllListeners();
-        passive.OnClick = new();
-        passive.OnClick.AddListener(action);
-        passive.enabled = true;
-    }
-
-    /// <summary>
-    /// Shorthand helper for overriding the on mouse over listeners for PassiveButton.
-    /// </summary>
-    /// <inheritdoc cref="OverrideOnClickListeners"/>
-    public static void OverrideOnMouseOverListeners(this PassiveButton passive, Action action)
-    {
-        if (!passive)
-            return;
-
-        passive.OnMouseOver?.RemoveAllListeners();
-        passive.OnMouseOver = new();
-        passive.OnMouseOver.AddListener(action);
-        passive.enabled = true;
-    }
-
-    /// <summary>
-    /// Shorthand helper for overriding the on mouse out listeners for PassiveButton.
-    /// </summary>
-    /// <inheritdoc cref="OverrideOnClickListeners"/>
-    public static void OverrideOnMouseOutListeners(this PassiveButton passive, Action action)
-    {
-        if (!passive)
-            return;
-
-        passive.OnMouseOut?.RemoveAllListeners();
-        passive.OnMouseOut = new();
-        passive.OnMouseOut.AddListener(action);
-        passive.enabled = true;
-    }
 
     /// <summary>
     /// Returns the string of a role.
@@ -611,4 +537,15 @@ public static class Helpers
         }
         return role.NiceName;
     }
+
+    /// <summary>
+    /// Returns whether the role is blacklisted from appearing and spawning. (Only applicable to vanilla roles)
+    /// </summary>
+    /// <param name="role">The role to check.</param>
+    /// <returns>The role's blacklist status.</returns>
+    public static bool IsRoleBlacklisted(this RoleBehaviour role)
+    {
+        // This should be patchable by mods when a vanilla role is meant to be replaced by a custom role.
+        return false;
+    }
 }

MiraAPI/Utilities/MiraNumberSuffixes.cs

@@ -24,9 +24,4 @@ public enum MiraNumberSuffixes
     /// Percentage suffix (%).
     /// </summary>
     Percent,
-
-    /// <summary>
-    /// Display in units.
-    /// </summary>
-    Distance,
 }

README.md

@@ -5,6 +5,7 @@
 # Mira API
 
 A thorough, but simple, Among Us modding API and utility library that covers:
+
 - Roles
 - Options
 - Modifiers
@@ -13,6 +14,9 @@ A thorough, but simple, Among Us modding API and utility library that covers:
 - Events
 - Voting
 - Assets
+- Keybinds
+- Local Settings
+- Custom Game Over Conditions
 - Compatibility
 - ~~Game Modes~~ (coming soon)
 
@@ -24,9 +28,10 @@ The result is a less intrusive, better modding API that covers general use cases
 # Usage
 
 To start using Mira API, you need to:
+
 1. Add a reference to Mira API either through a [DLL](https://github.com/All-Of-Us-Mods/MiraAPI/releases), project reference, or [NuGet package](https://www.nuget.org/packages/AllOfUs.MiraAPI).
 2. Add a BepInDependency on your plugin class like this: `[BepInDependency(MiraApiPlugin.Id)]`
-3. Implement the IMiraPlugin interface in your plugin class.
+3. Implement the `IMiraPlugin` interface on your plugin class.
 
 Mira API also depends on [Reactor](https://github.com/NuclearPowered/Reactor) to function properly!
 Remember to include it as a reference and `BepInDependency`!
@@ -34,8 +39,10 @@ Remember to include it as a reference and `BepInDependency`!
 For a full example, see [this file](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/ExamplePlugin.cs).
 
 ## Recommended Project Structure
+
 It is highly recommended to follow this project structure when using Mira API to keep your code clean and organized.
 You can also view the Example Mod in this repository for some guidance.
+
 ```
 MyMiraMod/
 ├── Buttons/
@@ -60,220 +67,21 @@ MyMiraMod/
 └── MyModAssets.cs
 ```
 
-## Roles
-Roles are straightforward in Mira API. There are two things you need to do to create a custom role:
-1. Create a class that inherits from a base game role (like `CrewmateRole`, `ImpostorRole`, etc.) 
-2. Implement the `ICustomRole` interface from Mira API.
+# Documentation
 
-**Disclaimer: Make sure your plugin class has the following attribute `[ReactorModFlags(ModFlags.RequireOnAllClients)]` or else your roles will not register correctly.**
+Full documentation for every Mira API feature is available on the **[wiki](https://github.com/All-Of-Us-Mods/MiraAPI/wiki)**:
 
-Note: For step 1, if you are making neutral roles,
-you can choose either `CrewmateRole` or `ImpostorRole`,
-or even `RoleBehaviour` if you are okay with starting from scratch.
-
-Mira API handles everything else, from adding the proper options to the settings menu,
-to managing the role assignment at the start of the game.
-There are no extra steps on the developer's part.
-
-See [this file](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Roles/CustomRole.cs) for a code example.
-
-## Modifiers
-Mira API uses a different definition of 'modifiers' than other Among Us mods.
-For example, in Town Of Us, a modifier is an extra "ability" that is applied on top of the base role.
-However, in Mira API, modifiers are very flexible.
-A modifier is anything that "modifiers" a player's abilities or interactions.
-
-Mira provides three classes for working with modifiers:
-- `BaseModifier`: The base for every modifier. You MUST add and remove this modifier from a player manually!
-- `TimedModifier`: A modifier that has a time limit. This modifier has to be added manually, but will automatically remove itself after the time limit.
-- `GameModifier`: This works like the typical TOU modifier, where it is automatically applied at the beginning of the game, then removed at the end.
-
-Modifiers provide various overridable functions and properties for custom behavior.
-They can also be used for "tagging" a player.
-You can check if a player has a modifier through the extension method `HasModifier` on a `PlayerControl` object.
-
-To start using a modifier, pick one of the base classes above and create a class that inherits from it. Implement the properties and methods you would like, then add the `[RegisterModifier]` attribute to the class.
-
-An example Game modifier can be found [here](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Modifiers/GameModifierExample.cs).
-An example Timer modifier can be found [here](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Modifiers/ModifierTimerExample.cs).
-
-## Options
-Options are also simple in Mira API.
-Mira API handles all the hard work behind the scenes,
-so developers only have to follow a few steps to create their custom options.
-The Options API is split up into Groups and Options.
-Every Option needs to be in a Group.
-
-To create a group, you need to create a class that inherits from the `AbstractOptionGroup` abstract class.
-Groups contain some properties for developers to control,
-including `GroupName`, `GroupColor`, `GroupVisible`, and `OptionableType`.
-The full list of properties can be found in the `AbstractOptionGroup` class.
-Only the `GroupName` is required.
-
-Here is an example of a group class:
-```csharp
-public class MyOptionsGroup : AbstractOptionGroup
-{
-    public override string GroupName => "My Options"; // this is required
-    
-    [ModdedNumberOption("My Number Option", min: 0, max: 10)]
-    public float MyNumberOption { get; set; } = 5f;
-}
-```
-
-You can access any group class using the `OptionGroupSingleton` class like this:
-```csharp
-// MyOptionsGroup is a class that inherits from AbstractOptionGroup
-var myGroup = OptionGroupSingleton<MyOptionsGroup>.Instance; // gets the instance of the group
-Logger<MyPlugin>.Info(myGroup.MyNumberOption); // prints the value of the option to the console
-```
-
-Once you have an options group, there are two ways to make the actual options:
-- Use an Option Attribute with a property.  
-- Create a ModdedOption property.
-
-### Option Attributes
-
-This is an example of using an Option Attribute on a property:
-```csharp
-// The first parameter is always the name of the option. The rest are dependent on the type of option.
-[ModdedNumberOption("Sussy level", min: 0, max: 10)]
-public float SussyLevel { get; set; } = 4f; // You can set a default value here.
-```
-
-Here are the available Option Attributes and their signatures:
-```csharp
-ModdedEnumOption(string name, Type enumType, string[]? values = null, Type? roleType = null)
-    
-ModdedNumberOption(
-    string name,
-    float min,
-    float max,
-    float increment=1
-    NumberSuffixes suffixType = NumberSuffixes.None,
-    bool zeroInfinity = false,
-    Type? roleType = null)
-
-ModdedToggleOption(string name, Type? roleType = null)
-```
-
-### ModdedOption Properties
-
-And this is an example of a ModdedOption property:
-```csharp
-public ModdedToggleOption YeezusAbility { get; } = new ModdedToggleOption("Yeezus Ability", false);
-```
-
-There are currently three types of ModdedOptions you can create:
-- `ModdedEnumOption`
-- `ModdedNumberOption`
-- `ModdedToggleOption`
-
-To see a full example of an option class,
-see [this file](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Options/ExampleOptions.cs).
-
-### Role Options
-
-You can also specify a role type for an option or option group.
-
-To set the role type for an entire group, set the `OptionableType` property on that group like this: 
-```csharp
-public class MyOptionsGroup : AbstractOptionGroup
-{
-    public override string GroupName => "My Options";
-    public override Type? OptionableType => typeof(MyRole); // this is the role that will have these options
-    
-    [ModdedNumberOption("Ability Uses", min: 0, max: 10)]
-    public float AbilityUses { get; set; } = 5f;
-}
-```
-
-You can also use a modifier type for the `OptionableType` property.
-This will associate that option group with the specified modifier type
-and display it in the modifier options menu.
-
-An example can be found [here](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Options/Roles/CustomRoleSettings.cs).
-
-## Custom Murders
-Mira API provides its own implementation for murders.
-Our implementation allows for more customization on kills, and helps bypass server checks.
-You can use `PlayerControl.RpcCustomMurder` to perform a networked custom murder, or `PlayerControl.CustomMurder` to normally perform a custom murder.
-For example: 
-```cs
-PlayerControl.LocalPlayer.RpcCustomMurder(Target, createDeadBody: false, teleportMurderer: false, playKillSound: false, resetKillTimer: false, showKillAnim: false);
-```
-This will kill a player without creating a dead body and without teleporting the murderer.
-
-## Buttons
-
-Mira API provides a simple interface for adding ability buttons to the game.
-
-The only thing you need to do is create a class
-that inherits from the `CustomActionButton` class and implement the properties and methods.
-
-Mira API handles all other tasks and logic required to add the button to the game.
-
-In case you need to access your `CustomActionButton` instance from another class,
-you can use the `CustomButtonSingleton` class like this:
-```csharp
-var myButton = CustomButtonSingleton<MyCoolButton>.Instance;
-```
-
-The button API is straightforward, but provides a lot of flexibility.
-There are various methods you can override to customize the behavior of your button.
-See [this file](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI/Hud/CustomActionButton.cs) 
-for a full list of methods you can override.
-
-An example button can be found [here](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Buttons/ExampleButton.cs).
-
-## Custom Colors
-
-Mira provides a simple Custom Color API that allows you to add custom player colors to the game.
-
-Creating custom colors isn't difficult, but there are some requirements for Mira to register your colors.
-
-1. Create a ***STATIC*** class to house all your `CustomColor` objects.
-2. Inside this class, create a `CustomColor` property for each color you intend to add.
-3. Add the `[RegisterCustomColors]` attribute to the class.
-
-Here is an example of a custom color class:
-```csharp
-[RegisterCustomColors]
-public static class MyCustomColors
-{
-    public static CustomColor Cerulean { get; } = new CustomColor("Cerulean", new Color(0.0f, 0.48f, 0.65f)); 
-
-    public static CustomColor Rose { get; } = new CustomColor("Rose", new Color(0.98f, 0.26f, 0.62f));
-    
-    public static CustomColor Gold { get; } = new CustomColor("Gold", new Color(1.0f, 0.84f, 0.0f));
-}
-```
-
-## Assets
-
-Mira API provides a simple, but expandable asset system.
-The core of the system is the `LoadableAsset<T>` class.
-This is a generic abstract class that provides a pattern for loading assets. 
-
-Mira API comes with a few asset loaders:
-1. `LoadableBundleAsset<T>`: This is used for loading assets from AssetBundles.
-2. `LoadableAddressableAsset<T>`: This is used for loading assets from Addressables.
-3. `LoadableResourceAsset`: This is used for loading **only sprites** from the Embedded Resources within a mod.
-4. `LoadableAudioResourceAsset`: This is used for loading **only audio clips** from the Embedded Resources within a mod.
-
-The code below shows how to use an asset loaders:
-```csharp
-// Load a sprite from an AssetBundle
-AssetBundle bundle = AssetBundleManager.Load("MyBundle"); // AssetBundleManager is a utility provided by Reactor
-LoadableAsset<Sprite> mySpriteAsset = new LoadableBundleAsset<Sprite>("MySprite", bundle);
-Sprite sprite = mySpriteAsset.LoadAsset();
-
-// Load a sprite from an Embedded Resource
-// Make sure to set the Build Action of your image to Embedded Resource!
-LoadableAsset<Sprite> buttonAsset = new LoadableResourceAsset("ExampleMod.Resources.MyButton.png");
-Sprite button = buttonSpriteAsset.LoadAsset();
-```
-
-You can view an example file [here](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/ExampleAssets.cs).
-
-You can create your own asset loaders by inheriting from `LoadableAsset<T>` and implementing the `LoadAsset` method.
+- [Get Started / IMiraPlugin](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Home)
+- [Custom Roles](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Custom-Roles)
+- [Options](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Options)
+- [Modifiers](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Modifiers)
+- [Custom Buttons](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Custom-Buttons)
+- [Custom Colors](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Colors)
+- [Events](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Events)
+- [Meetings and Voting](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Meetings-and-Voting)
+- [Assets](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Assets)
+- [Keybinds](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Keybinds)
+- [Local Settings](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Local-Settings)
+- [Game Modes](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Game-Modes)
+- [Custom Game Over](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Game-Over)
+- [Utilities](https://github.com/All-Of-Us-Mods/MiraAPI/wiki/Utilities)