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

0.2.0 Update

MiraAPI/Hud/CustomActionButton.cs

@@ -184,7 +184,10 @@ public abstract class CustomActionButton
 
         this.Location = location;
 
-        if (!moveButton) return;
+        if (!moveButton)
+        {
+            return;
+        }
 
         if (HudManagerPatches.BottomLeft == null || HudManagerPatches.BottomRight == null)
         {

MiraAPI/Hud/InputBox.cs

@@ -1,114 +0,0 @@
-using System;
-using MiraAPI.Utilities.Assets;
-using Reactor.Utilities.Attributes;
-using UnityEngine;
-using UnityEngine.Events;
-using UnityEngine.UI;
-
-namespace MiraAPI.Hud;
-
-/// <summary>
-/// Simple input box for user input.
-/// </summary>
-[RegisterInIl2Cpp]
-public class InputBox : MonoBehaviour
-{
-    public InputField inputField = null!;
-
-    public void CreateDialog(string title, string placeholder, string submitText, Action<string> onSubmit)
-    {
-        var canvasObj = new GameObject("DialogCanvas");
-        canvasObj.transform.SetParent(transform);
-        canvasObj.layer = LayerMask.NameToLayer("UI");
-
-        var canvas = canvasObj.AddComponent<Canvas>();
-        canvas.renderMode = RenderMode.ScreenSpaceOverlay;
-        canvas.overrideSorting = true;
-        canvas.sortingOrder = 1000; // Ensure the canvas is on top of other UI elements
-
-        canvasObj.AddComponent<CanvasScaler>().uiScaleMode = CanvasScaler.ScaleMode.ScaleWithScreenSize;
-        canvasObj.AddComponent<GraphicRaycaster>();
-
-        var panelObj = new GameObject("DialogPanel");
-        panelObj.transform.SetParent(canvasObj.transform);
-        var panelRect = panelObj.AddComponent<RectTransform>();
-        var img = panelObj.AddComponent<Image>();
-
-        img.color = new Color(1, 1, 1, 0.9f);
-        img.raycastTarget = true;
-        img.sprite = MiraAssets.RoundedBox.LoadAsset();
-        img.type = Image.Type.Sliced;
-
-        panelRect.sizeDelta = new Vector2(300, 200);
-        panelRect.anchoredPosition = Vector2.zero;
-
-        var titleText = CreateText(panelObj, title);
-        titleText.alignment = TextAnchor.MiddleCenter;
-        titleText.fontSize = 26;
-        titleText.fontStyle = FontStyle.Bold;
-        titleText.color = Color.white;
-
-        var titleRect = titleText.GetComponent<RectTransform>();
-        titleRect.sizeDelta = new Vector2(280, 50);
-        titleRect.anchoredPosition = new Vector2(0, 70);
-
-        var inputObj = new GameObject("InputField");
-        inputObj.transform.SetParent(panelObj.transform);
-        var inputRect = inputObj.AddComponent<RectTransform>();
-        inputRect.sizeDelta = new Vector2(220, 40);
-        inputRect.anchoredPosition = new Vector2(0, 20);
-
-        var inputBg = inputObj.AddComponent<Image>();
-        inputBg.color = new Color(1, 1, 1, 0.8f);
-
-        inputField = inputObj.AddComponent<InputField>();
-        inputField.textComponent = CreateText(inputObj, string.Empty, 18, Color.black);
-        inputField.placeholder = CreateText(inputObj, placeholder, 18, new Color(0.5f, 0.5f, 0.5f));
-
-        var buttonObj = new GameObject("SubmitButton");
-        buttonObj.transform.SetParent(panelObj.transform);
-        var button = buttonObj.AddComponent<Button>();
-        var buttonRect = buttonObj.AddComponent<RectTransform>();
-        buttonRect.sizeDelta = new Vector2(150, 50);
-        buttonRect.anchoredPosition = new Vector2(0, -50);
-
-        var buttonImg = buttonObj.AddComponent<Image>();
-        buttonImg.color = new Color(1f, 1f, 1f, 1f);
-        buttonImg.sprite = MiraAssets.RoundedBox.LoadAsset();
-        buttonImg.type = Image.Type.Sliced;
-
-        var buttonText = CreateText(buttonObj, submitText, 20, Color.white);
-        buttonText.alignment = TextAnchor.MiddleCenter;
-
-        var colors = button.colors;
-        colors.highlightedColor = Color.green;
-        colors.pressedColor = MiraAssets.AcceptedTeal;
-        button.colors = colors;
-
-        button.onClick.AddListener((UnityAction)(() =>
-        {
-            onSubmit(inputField.text);
-            DestroyImmediate(canvasObj);
-        }));
-
-        inputField.ActivateInputField();
-    }
-
-    private static Text CreateText(GameObject parent, string textContent = "", int fontSize = 20, Color? textColor = null, Font? font = null)
-    {
-        var textObj = new GameObject("Text");
-        textObj.transform.SetParent(parent.transform);
-
-        var text = textObj.AddComponent<Text>();
-        text.font = font ?? Resources.GetBuiltinResource<Font>("Arial.ttf");
-        text.text = textContent;
-        text.color = textColor ?? Color.white;
-        text.fontSize = fontSize;
-        text.alignment = TextAnchor.MiddleCenter;
-
-        var rect = textObj.GetComponent<RectTransform>();
-        rect.sizeDelta = new Vector2(200, 40);
-        rect.anchoredPosition = Vector2.zero;
-        return text;
-    }
-}

MiraAPI/Modifiers/ModifierManager.cs

@@ -16,6 +16,11 @@ namespace MiraAPI.Modifiers;
 /// </summary>
 public static class ModifierManager
 {
+    /// <summary>
+    /// Gets or sets a value indicating whether modifiers should be assigned to players.
+    /// </summary>
+    public static bool MiraAssignsModifiers { get; set; } = true;
+
     private static readonly Dictionary<uint, Type> IdToTypeModifierMap = [];
     private static readonly Dictionary<Type, uint> TypeToIdModifierMap = [];
     private static readonly Dictionary<int, List<uint>> PrioritiesToIdsMap = [];
@@ -98,7 +103,11 @@ public static class ModifierManager
         return true;
     }
 
-    internal static void AssignModifiers(List<PlayerControl> plrs)
+    /// <summary>
+    /// Assigns modifiers to players. ONLY CALL THIS METHOD IF YOU KNOW WHAT YOU ARE DOING.
+    /// </summary>
+    /// <param name="plrs">The players to assign modifiers to.</param>
+    public static void AssignModifiers(List<PlayerControl> plrs)
     {
         var rand = new Random();
 

MiraAPI/Patches/Options/GamePresetsTabPatches.cs

@@ -89,7 +89,7 @@ internal static class GamePresetsTabPatches
 
             var prefab = GameSettingMenu.Instance.GameSettingsButton;
 
-            foreach (var preset in MiraPluginManager.Instance.RegisteredPlugins.SelectMany(x => x.Presets))
+            foreach (var preset in MiraPluginManager.Instance.RegisteredPlugins.SelectMany(x => x.InternalPresets))
             {
                 var button = Object.Instantiate(prefab, _presetHolder.transform);
                 button.buttonText.text = preset.Name;
@@ -112,7 +112,7 @@ internal static class GamePresetsTabPatches
 
             foreach (var mod in MiraPluginManager.Instance.RegisteredPlugins)
             {
-                foreach (var button in mod.Presets.Select(x => x.PresetButton))
+                foreach (var button in mod.InternalPresets.Select(x => x.PresetButton))
                 {
                     if (button != null)
                     {
@@ -154,7 +154,7 @@ internal static class GamePresetsTabPatches
 
             foreach (var mod in MiraPluginManager.Instance.RegisteredPlugins)
             {
-                foreach (var button in mod.Presets.Select(x => x.PresetButton))
+                foreach (var button in mod.InternalPresets.Select(x => x.PresetButton))
                 {
                     if (button != null)
                     {

MiraAPI/Patches/Options/GameSettingMenuPatches.cs

@@ -495,7 +495,6 @@ internal static class GameSettingMenuPatches
                 .ForEach(header => header.gameObject.DestroyImmediate());
 
             gameOptMenu.Initialize();
- 
             var positions = modifiers ? ModifiersPositions : OptionsPositions;
             if (positions.TryGetValue(SelectedModIdx, out var pos))
             {

MiraAPI/Patches/Options/LobbyViewPanePatches.cs

@@ -129,8 +129,10 @@ public static class LobbyViewPanePatches
         __instance.rolesTabButton.SelectButton(false);
 
         ModifiersTabButton?.SelectButton(true);
+
         var filteredGroups = SelectedMod.InternalOptionGroups
-            .Where(x => x.GroupVisible() && (x.ShowInModifiersMenu || x.OptionableType?.IsAssignableTo(typeof(BaseModifier))==true));
+            .Where(x => x.GroupVisible() && (x.ShowInModifiersMenu || (x.OptionableType != null && x.OptionableType.IsAssignableTo(typeof(BaseModifier)))));
+
         DrawOptions(__instance, filteredGroups);
     }
 
@@ -149,7 +151,8 @@ public static class LobbyViewPanePatches
         }
 
         var filteredGroups = SelectedMod.InternalOptionGroups
-            .Where(x => x.OptionableType == null && x.GroupVisible.Invoke());
+            .Where(x => x is { ShowInModifiersMenu: false, OptionableType: null } && x.GroupVisible());
+
         DrawOptions(__instance, filteredGroups);
         return false;
     }
@@ -176,12 +179,15 @@ public static class LobbyViewPanePatches
     {
         var num = 1.44f;
 
-        foreach (var group in groups)
+        var groupArray = groups.Where(x => x.GroupVisible() && x.Options.Any(y => y.Visible())).ToArray();
+
+        foreach (var group in groupArray)
         {
             var categoryHeaderMasked = Object.Instantiate(
                 menu.categoryHeaderOrigin,
                 menu.settingsContainer,
                 true);
+
             categoryHeaderMasked.SetHeader(StringNames.Name, 61);
             categoryHeaderMasked.Title.text = group.GroupName;
             categoryHeaderMasked.transform.localScale = Vector3.one;
@@ -193,7 +199,7 @@ public static class LobbyViewPanePatches
 
             foreach (var option in group.Options)
             {
-                if (!option.Visible.Invoke())
+                if (!option.Visible())
                 {
                     continue;
                 }
@@ -202,6 +208,7 @@ public static class LobbyViewPanePatches
                     menu.infoPanelOrigin,
                     menu.settingsContainer,
                     true);
+
                 viewSettingsInfoPanel.transform.localScale = Vector3.one;
                 float num2;
                 if (i % 2 == 0)
@@ -240,7 +247,7 @@ public static class LobbyViewPanePatches
             num -= 0.85f;
         }
 
-        menu.scrollBar.CalculateAndSetYBounds(menu.settingsInfo.Count + 10, 2f, 6f, 0.85f);
+        menu.scrollBar.SetYBoundsMax(-num - 2);
     }
 
     private static void DrawRolesTab(LobbyViewSettingsPane instance)

MiraAPI/Patches/Options/NotificationPopperPatch.cs

@@ -2,7 +2,6 @@
 using HarmonyLib;
 using Il2CppSystem;
 using MiraAPI.Roles;
-using UnityEngine;
 using Object = Il2CppSystem.Object;
 
 namespace MiraAPI.Patches.Options;

MiraAPI/Patches/Options/OptionsPatches.cs

@@ -1,5 +1,6 @@
 using HarmonyLib;
 using Il2CppSystem;
+using MiraAPI.Roles;
 using MiraAPI.Utilities;
 
 namespace MiraAPI.Patches.Options;
@@ -7,6 +8,138 @@ namespace MiraAPI.Patches.Options;
 [HarmonyPatch]
 public static class OptionsPatches
 {
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(RoleOptionSetting), nameof(RoleOptionSetting.IncreaseChance))]
+    public static bool RoleIncreaseChancePrefix(RoleOptionSetting __instance)
+    {
+        if (!__instance.Role.IsCustomRole())
+        {
+            return true;
+        }
+
+        if (__instance.roleChance == 0)
+        {
+            __instance.roleMaxCount = 1;
+        }
+
+        __instance.roleChance += 10;
+        if (__instance.roleChance > 100)
+        {
+            __instance.roleChance = 0;
+        }
+
+        __instance.OnValueChanged.Invoke(__instance);
+        return false;
+    }
+
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(RoleOptionSetting), nameof(RoleOptionSetting.DecreaseChance))]
+    public static bool RoleDecreaseChancePrefix(RoleOptionSetting __instance)
+    {
+        if (!__instance.Role.IsCustomRole())
+        {
+            return true;
+        }
+
+        if (__instance.roleChance == 0)
+        {
+            __instance.roleMaxCount = 1;
+        }
+
+        __instance.roleChance -= 10;
+        if (__instance.roleChance < 0)
+        {
+            __instance.roleChance = 100;
+        }
+
+        __instance.OnValueChanged.Invoke(__instance);
+        return false;
+    }
+
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(RoleOptionSetting), nameof(RoleOptionSetting.IncreaseCount))]
+    public static bool RoleIncreaseCountPrefix(RoleOptionSetting __instance)
+    {
+        if (!__instance.Role.IsCustomRole())
+        {
+            return true;
+        }
+
+        if (__instance.roleMaxCount == 0)
+        {
+            __instance.roleChance = 50;
+        }
+
+        __instance.roleMaxCount += 1;
+        if (__instance.roleMaxCount > __instance.role.MaxCount)
+        {
+            __instance.roleMaxCount = 0;
+        }
+
+        __instance.OnValueChanged.Invoke(__instance);
+        return false;
+    }
+
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(RoleOptionSetting), nameof(RoleOptionSetting.DecreaseCount))]
+    public static bool RoleDecreaseCountPrefix(RoleOptionSetting __instance)
+    {
+        if (!__instance.Role.IsCustomRole())
+        {
+            return true;
+        }
+
+        if (__instance.roleMaxCount == 0)
+        {
+            __instance.roleChance = 50;
+        }
+
+        __instance.roleMaxCount -= 1;
+        if (__instance.roleMaxCount < 0)
+        {
+            __instance.roleMaxCount = __instance.role.MaxCount;
+        }
+
+        __instance.OnValueChanged.Invoke(__instance);
+        return false;
+    }
+
+    [HarmonyPrefix]
+    [HarmonyPatch(typeof(NumberOption), nameof(NumberOption.AdjustButtonsActiveState))]
+    [HarmonyPatch(typeof(StringOption), nameof(StringOption.AdjustButtonsActiveState))]
+    [HarmonyPatch(typeof(RoleOptionSetting), nameof(RoleOptionSetting.AdjustChanceButtonsActiveState))]
+    [HarmonyPatch(typeof(RoleOptionSetting), nameof(RoleOptionSetting.AdjustCountButtonsActiveState))]
+    public static bool AdjustButtonsPrefix(OptionBehaviour __instance)
+    {
+        if (__instance.IsCustom())
+        {
+            if (__instance.TryCast<NumberOption>() is { } numberOption)
+            {
+                numberOption.MinusBtn.SetInteractable(true);
+                numberOption.PlusBtn.SetInteractable(true);
+            }
+            if (__instance.TryCast<StringOption>() is { } stringOption)
+            {
+                stringOption.MinusBtn.SetInteractable(true);
+                stringOption.PlusBtn.SetInteractable(true);
+            }
+
+            return false;
+        }
+
+        if (__instance.TryCast<RoleOptionSetting>() is { } roleOptionSetting && roleOptionSetting.Role.IsCustomRole())
+        {
+            roleOptionSetting.CountMinusBtn.SetInteractable(true);
+            roleOptionSetting.CountPlusBtn.SetInteractable(true);
+            roleOptionSetting.ChanceMinusBtn.SetInteractable(true);
+            roleOptionSetting.ChancePlusBtn.SetInteractable(true);
+
+            return false;
+        }
+
+        return true;
+    }
+
     [HarmonyPrefix]
     [HarmonyPatch(typeof(ToggleOption), nameof(ToggleOption.Initialize))]
     public static bool ToggleInit(ToggleOption __instance)
@@ -16,8 +149,7 @@ public static class OptionsPatches
             return true;
         }
 
-        __instance.TitleText.text =
-            TranslationController.Instance.GetString(__instance.Title, Array.Empty<Object>());
+        __instance.TitleText.text = TranslationController.Instance.GetString(__instance.Title, Array.Empty<Object>());
 
         return false;
     }
@@ -45,14 +177,6 @@ public static class OptionsPatches
         return !__instance.IsCustom();
     }
 
-    [HarmonyPrefix]
-    [HarmonyPatch(typeof(NumberOption), nameof(NumberOption.AdjustButtonsActiveState))]
-    [HarmonyPatch(typeof(StringOption), nameof(StringOption.AdjustButtonsActiveState))]
-    public static bool AdjustButtonsPrefix(OptionBehaviour __instance)
-    {
-        return !__instance.IsCustom();
-    }
-
     [HarmonyPrefix]
     [HarmonyPatch(typeof(NumberOption), nameof(NumberOption.Initialize))]
     public static bool NumberInit(NumberOption __instance)

MiraAPI/Patches/Options/RoleSettingMenuPatches.cs

@@ -211,9 +211,10 @@ public static class RoleSettingMenuPatches
             headerBtn.OnClick.AddListener(
                 (UnityAction)(() =>
                 {
-                    if (RoleGroupHidden.TryGetValue(group, out var value))
+                    RolePositions[GameSettingMenuPatches.SelectedModIdx] = __instance.scrollBar.Inner.localPosition;
+                    if (RoleGroupHidden.TryGetValue(group, out var groupHidden))
                     {
-                        RoleGroupHidden[group] = !value;
+                        RoleGroupHidden[group] = !groupHidden;
                     }
                     foreach (var header in Headers)
                     {
@@ -234,6 +235,7 @@ public static class RoleSettingMenuPatches
                 ScrollerNum -= 0.4f;
             }
         }
+
         __instance.scrollBar.SetScrollBounds(__instance);
         return false;
     }
@@ -246,7 +248,7 @@ public static class RoleSettingMenuPatches
             return;
         }
 
-        scroller.CalculateAndSetYBounds(1.5f * Headers.Count + RoleOptionSettings.Count, 1f, 6f, 0.43f);
+        scroller.SetYBoundsMax(-ScrollerNum - 2);
         if (RolePositions.TryGetValue(GameSettingMenuPatches.SelectedModIdx, out var scroll))
         {
             scroller.Inner.localPosition = scroll;
@@ -333,8 +335,9 @@ public static class RoleSettingMenuPatches
 
         // TODO: create sub groups under the role settings.
         var filteredOptions = GameSettingMenuPatches.SelectedMod?.InternalOptionGroups
-            .Where(x=> x.OptionableType == role.GetType())
-            .SelectMany(x=>x.Options)
+            .Where(x => x.GroupVisible() && x.OptionableType == role.GetType())
+            .SelectMany(x => x.Options)
+            .Where(x => x.Visible())
             .ToList() ?? [];
 
         foreach (var option in filteredOptions)
@@ -367,7 +370,7 @@ public static class RoleSettingMenuPatches
             newOpt.Initialize();
         }
 
-        __instance.scrollBar.CalculateAndSetYBounds(__instance.advancedSettingChildren.Count + 3, 1f, 6f, 0.45f);
+        __instance.scrollBar.SetYBoundsMax(-num - 3);
         __instance.scrollBar.ScrollToTop();
     }
 
@@ -491,6 +494,10 @@ public static class RoleSettingMenuPatches
         roleOptionSetting.labelSprite.color = customRole.OptionsMenuColor;
         roleOptionSetting.OnValueChanged = new Action<OptionBehaviour>(ValueChanged);
         roleOptionSetting.SetClickMask(__instance.ButtonClickMask);
+        roleOptionSetting.ChanceMinusBtn.SetInteractable(true);
+        roleOptionSetting.ChancePlusBtn.SetInteractable(true);
+        roleOptionSetting.CountMinusBtn.SetInteractable(true);
+        roleOptionSetting.CountPlusBtn.SetInteractable(true);
         __instance.roleChances.Add(roleOptionSetting);
 
         roleOptionSetting.titleText.transform.localPosition = new Vector3(-0.5376f, -0.2923f, 0f);

MiraAPI/Patches/Roles/RoleManagerPatches.cs

@@ -65,7 +65,7 @@ public static class RoleManagerPatches
     [HarmonyPatch(nameof(RoleManager.SelectRoles))]
     public static void ModifierSelectionPatches(RoleManager __instance)
     {
-        if (!AmongUsClient.Instance.AmHost)
+        if (!AmongUsClient.Instance.AmHost || !ModifierManager.MiraAssignsModifiers)
         {
             return;
         }

MiraAPI/Patches/ServerDropdownPatch.cs

@@ -0,0 +1,52 @@
+using HarmonyLib;
+using UnityEngine;
+using UnityEngine.Events;
+
+namespace MiraAPI.Patches;
+
+[HarmonyPatch(typeof(ServerDropdown), nameof(ServerDropdown.FillServerOptions))]
+public static class ServerDropdownPatch
+{
+    public static bool Prefix(ServerDropdown __instance)
+    {
+        var num = 0;
+        __instance.background.size = new Vector2(8.4f, 4.8f);
+
+        foreach (var regionInfo in DestroyableSingleton<ServerManager>.Instance.AvailableRegions)
+        {
+            if (DestroyableSingleton<ServerManager>.Instance.CurrentRegion.Equals(regionInfo))
+            {
+                __instance.defaultButtonSelected = __instance.firstOption;
+                __instance.firstOption.ChangeButtonText(
+                    DestroyableSingleton<TranslationController>.Instance.GetStringWithDefault(
+                        regionInfo.TranslateName,
+                        regionInfo.Name));
+            }
+            else
+            {
+                var region = regionInfo;
+                var serverListButton = __instance.ButtonPool.Get<ServerListButton>();
+                var x = num % 2 == 0 ? -2 : 2;
+                var y = -0.55f * (num / 2);
+                serverListButton.transform.localPosition = new Vector3(x, __instance.y_posButton + y, -1f);
+                serverListButton.transform.localScale = Vector3.one;
+                serverListButton.Text.text =
+                    DestroyableSingleton<TranslationController>.Instance.GetStringWithDefault(
+                        regionInfo.TranslateName,
+                        regionInfo.Name);
+                serverListButton.Text.ForceMeshUpdate();
+                serverListButton.Button.OnClick.RemoveAllListeners();
+                serverListButton.Button.OnClick.AddListener((UnityAction)(() => { __instance.ChooseOption(region); }));
+                __instance.controllerSelectable.Add(serverListButton.Button);
+                __instance.background.transform.localPosition = new Vector3(
+                    0f,
+                    __instance.initialYPos + (-0.3f * (num / 2)),
+                    0f);
+                __instance.background.size = new Vector2(__instance.background.size.x, 1.2f + (0.6f * (num / 2)));
+                num++;
+            }
+        }
+
+        return false;
+    }
+}

MiraAPI/Presets/PresetManager.cs

@@ -69,7 +69,8 @@ public static class PresetManager
 
         foreach (var file in Directory.GetFiles(pluginPresetPath, "*.cfg"))
         {
-            Logger<MiraApiPlugin>.Info($"Loading preset file {file}");
+            var fileName = Path.GetFileName(file);
+            Logger<MiraApiPlugin>.Info($"Loading preset file {fileName}");
             var presetName = Path.GetFileNameWithoutExtension(file);
             var presetConfig = new ConfigFile(file, false)
             {
@@ -90,6 +91,6 @@ public static class PresetManager
 
             plugin.InternalPresets.Add(new OptionPreset(presetName, plugin, presetConfig));
         }
-        plugin.Presets = [.. plugin.InternalPresets];
+        plugin.Presets = [..plugin.InternalPresets];
     }
 }

MiraAPI/Presets/SavePresetPopup.cs

@@ -1,6 +1,4 @@
 using System;
-using Il2CppInterop.Runtime.InteropTypes.Fields;
-using MiraAPI.Modifiers.ModifierDisplay;
 using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
 using Reactor.Utilities.Attributes;
@@ -9,16 +7,21 @@ using TMPro;
 using UnityEngine;
 using UnityEngine.Events;
 using UnityEngine.UI;
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 [RegisterInIl2Cpp]
-public class SavePresetPopup(nint ptr) : Minigame(ptr)
+#pragma warning disable S3903
+#pragma warning disable CA1050
+public class SavePresetPopup(nint cppPtr) : Minigame(cppPtr)
+#pragma warning restore CA1050
+#pragma warning restore S3903
 {
-    private PassiveButton saveButton;
-    private PassiveButton closeButton;
+#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
     private TextMeshPro textBoxText;
     private TextBoxTMP textBox;
 
     private Action<string> onSave;
+#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
 
     // Cleanup holder object
     public void OnDestroy()
@@ -28,13 +31,14 @@ public class SavePresetPopup(nint ptr) : Minigame(ptr)
 
     public override void Close()
     {
+        // no-op
     }
 
     private void Awake()
     {
         var textboxHolder = transform.GetChild(1).GetChild(1);
-        saveButton = transform.FindChild("SaveButton").GetComponent<PassiveButton>();
-        closeButton = transform.FindChild("CloseButton").GetComponent<PassiveButton>();
+        var saveButton = transform.FindChild("SaveButton").GetComponent<PassiveButton>();
+        var closeButton = transform.FindChild("CloseButton").GetComponent<PassiveButton>();
         textBox = textboxHolder.GetChild(0).GetComponent<TextBoxTMP>();
         textBoxText = textBox.transform.GetChild(0).GetComponent<TextMeshPro>();
 
@@ -64,7 +68,11 @@ public class SavePresetPopup(nint ptr) : Minigame(ptr)
 
         foreach (var tmp in gameObject.GetComponentsInChildren<TextMeshPro>())
         {
-            if (tmp.gameObject.transform.parent.name == "Textbox") continue;
+            if (tmp.gameObject.transform.parent.name == "Textbox")
+            {
+                continue;
+            }
+
             var text = tmp.text;
             tmp.text = $"<font=\"LiberationSans SDF\" material=\"LiberationSans SDF RadialMenu Material\">{text}</font>";
         }
@@ -78,9 +86,9 @@ public class SavePresetPopup(nint ptr) : Minigame(ptr)
             transform =
             {
                 parent = Camera.main!.transform,
+                localPosition = new Vector3(0, -1f, -500),
             },
         };
-        holder.transform.localPosition = new Vector3(0, -1f, -500);
 
         var gameObject = Instantiate(MiraAssets.PresetSavePopup.LoadAsset(), holder.transform);
         var popup = gameObject.GetComponent<SavePresetPopup>();
@@ -89,3 +97,5 @@ public class SavePresetPopup(nint ptr) : Minigame(ptr)
     }
 }
 
+
+

MiraAPI/Roles/CustomRoleUtils.cs

@@ -4,6 +4,7 @@ using System.Linq;
 using System.Text;
 using AmongUs.GameOptions;
 using MiraAPI.Utilities.Assets;
+using Reactor.Utilities;
 using UnityEngine;
 
 namespace MiraAPI.Roles;
@@ -56,7 +57,21 @@ public static class CustomRoleUtils
     public static LoadableAsset<AudioClip>? GetIntroSound(RoleTypes roleType)
     {
         var role = RoleManager.Instance.AllRoles.FirstOrDefault(role => role.Role == roleType);
-        if (role is ICustomRole customRole) return customRole.Configuration.IntroSound;
+        if (role is ICustomRole customRole)
+        {
+            return customRole.Configuration.IntroSound;
+        }
+
         return new PreloadedAsset<AudioClip>(role!.IntroSound);
     }
+
+    /// <summary>
+    /// Determines if a role is a custom role or not.
+    /// </summary>
+    /// <param name="role">The RoleBehaviour to check.</param>
+    /// <returns>True if the role is a custom role, false otherwise.</returns>
+    public static bool IsCustomRole(this RoleBehaviour role)
+    {
+        return CustomRoleManager.CustomRoles.ContainsKey((ushort)role.Role);
+    }
 }

MiraAPI/Utilities/Extensions.cs

@@ -84,7 +84,7 @@ public static class Extensions
         analytics.MinigameClosed(data, taskType, realtimeSinceStartup, isComplete);
         self.StartCoroutine(self.CoDestroySelf());
     }
-    
+
     /// <summary>
     /// Sets the cooldown of a button with a formatted string.
     /// </summary>

README.md

@@ -1,5 +1,7 @@
 [![](https://dcbadge.limes.pink/api/server/AEfHJGwggC)](https://discord.gg/AEfHJGwggC)
 
+> This mod is not affiliated with Among Us or Innersloth LLC, and the content contained therein is not endorsed or otherwise sponsored by Innersloth LLC. Portions of the materials contained herein are property of Innersloth LLC. © Innersloth LLC.
+
 # Mira API
 
 A thorough, but simple, Among Us modding API and utility library that covers:
@@ -8,27 +10,32 @@ A thorough, but simple, Among Us modding API and utility library that covers:
 - Modifiers
 - Buttons
 - Custom Colors
+- Events
+- Voting
 - Assets
 - Compatibility
 - ~~Game Modes~~ (coming soon)
 
-Mira API strives to be simple and easy to use, while also using as many base game elements as possible. The result is a less intrusive, better modding API that covers general use cases.
+Mira API strives to be comprehensive, yet straightforward, while also using as many base game elements as possible.
+The result is a less intrusive, better modding API that covers general use cases.
 
-**Join the [Discord](https://discord.gg/all-of-us-launchpad-794950428756410429) for support and to stay updated on the latest releases**
+**Join the [Discord](https://discord.gg/FYYqJU2bvp) for support and to stay updated on the latest releases**
 
 # 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 on your plugin class.
+3. Implement the IMiraPlugin interface in your plugin class.
 
-Mira API also depends on [Reactor](https://github.com/NuclearPowered/Reactor) in order to function properly! Do not forget to include it as a reference and `BepInDependency`!
+Mira API also depends on [Reactor](https://github.com/NuclearPowered/Reactor) to function properly!
+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 in order to keep your code clean and organized. You can also view the Example Mod in this repository for some guidance.
+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/
@@ -54,28 +61,36 @@ MyMiraMod/
 ```
 
 ## Roles
-Roles are very simple in Mira API. There are 3 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) 
+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.
-3. Add the `[RegisterCustomRole]` attribute to the class.
 
 **Disclaimer: Make sure your plugin class has the following attribute `[ReactorModFlags(ModFlags.RequireOnAllClients)]` or else your roles will not register correctly.**
 
-Note: For step 1, if you are making neutral roles, choose either `CrewmateRole` or `ImpostorRole` as the base depending on if it can kill or not! 
+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.
+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 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 3 classes for working with modifiers:
+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
+- `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 behaviour. 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.
+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.
 
@@ -83,9 +98,17 @@ An example Game modifier can be found [here](https://github.com/All-Of-Us-Mods/M
 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 very 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.
+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 4 properties, `GroupName`, `GroupColor`, `GroupVisible`, and `AdvancedRole`. Only the `GroupName` is required.
+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
@@ -141,46 +164,39 @@ And this is an example of a ModdedOption property:
 public ModdedToggleOption YeezusAbility { get; } = new ModdedToggleOption("Yeezus Ability", false);
 ```
 
-Here is a full list of ModdedOption classes you can use: 
+There are currently three types of ModdedOptions you can create:
 - `ModdedEnumOption`
 - `ModdedNumberOption`
 - `ModdedToggleOption`
 
-To see a full example of an options class, see [this file](https://github.com/All-Of-Us-Mods/MiraAPI/blob/master/MiraAPI.Example/Options/ExampleOptions.cs).
+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 `AdvancedRole` property on that group like this: 
+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 AdvancedRole => typeof(MyRole); // this is the role that will have these 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;
 }
 ```
 
-To set the role type for individual options, specify the `roleType` parameter in the option like this:
-```csharp
-// this group doesnt specify a role, so it will show up in the global settings
-public class MyOptionsGroup : AbstractOptionGroup
-{
-    public override string GroupName => "My Options";
-    
-    // this option will only show up in the settings for MyRole
-    [ModdedNumberOption("Ability Uses", min: 0, max: 10, roleType: typeof(MyRole))]
-    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 it's own implementation for murders. Our implementation allows for more customization on kills, and helps bypass server checks.
+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
@@ -190,18 +206,23 @@ This will kill a player without creating a dead body and without teleporting the
 
 ## Buttons
 
-Mira API provides a simple interface for adding ability buttons to the game. There is only 2 steps:
-1. Create a class that inherits from the `CustomActionButton` class and implement the properties and methods.
-2. Add the `[RegisterCustomButton]` attribute to the class.
+Mira API provides a simple interface for adding ability buttons to the game.
 
-All other tasks and logic required to add the button to the game are handled by Mira API.
+The only thing you need to do is create a class
+that inherits from the `CustomActionButton` class and implement the properties and methods.
 
-In case you need to access your `CustomActionButton` instance from another class, you can use the `CustomButtonSingleton` class like this:
+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 simple, but provides a lot of flexibility. There are various methods you can override to customize the behaviour 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.
+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).
 
@@ -209,7 +230,7 @@ An example button can be found [here](https://github.com/All-Of-Us-Mods/MiraAPI/
 
 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 your colors to be registered by Mira.
+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.
@@ -230,13 +251,17 @@ public static class MyCustomColors
 
 ## 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 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 two asset loaders:
+Mira API comes with a few asset loaders:
 1. `LoadableBundleAsset<T>`: This is used for loading assets from AssetBundles.
-2. `LoadableResourceAsset`: This is used for loading **only sprites** from the Embedded Resources within a mod.
+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 these asset loaders:
+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
@@ -252,7 +277,3 @@ 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.
-
-# Disclaimer
-
-> This mod is not affiliated with Among Us or Innersloth LLC, and the content contained therein is not endorsed or otherwise sponsored by Innersloth LLC. Portions of the materials contained herein are property of Innersloth LLC. © Innersloth LLC.