resolve warnings that i am responsible for

This is necessary to prevent some pretty common option desync that tends to happen. If anyone else can optimize it further or move it somewhere else, go for it.

.editorconfig

@@ -104,3 +104,6 @@ dotnet_diagnostic.S1244.severity = none
 
 # S2325: Methods and properties that don't access instance data should be static
 dotnet_diagnostic.S2325.severity = none
+
+# IDE0005: Using directive is unnecessary.
+dotnet_diagnostic.IDE0005.severity = warning

Directory.Build.props

@@ -8,7 +8,7 @@
 
         <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
 
-        <VersionPrefix>0.5.0</VersionPrefix>
+        <VersionPrefix>0.6.0</VersionPrefix>
         <VersionSuffix>dev</VersionSuffix>
 
         <Authors>All Of Us, XtraCube, Angxl</Authors>

MiraAPI.Example/ExampleAssets.cs

@@ -1,14 +1,17 @@
-using MiraAPI.Utilities.Assets;
+using System.Reflection;
+using MiraAPI.Utilities.Assets;
 
 namespace MiraAPI.Example;
 
 public static class ExampleAssets
 {
-    public static LoadableResourceAsset ExampleButton { get; } = new("MiraAPI.Example.Resources.ExampleButton.png");
-    public static LoadableResourceAsset CallMeetingButton { get; } = new("MiraAPI.Example.Resources.CallMeeting.png");
+    private static readonly Assembly _assembly = typeof(MiraAssets).Assembly;
+
+    public static LoadableResourceAsset ExampleButton { get; } = new("MiraAPI.Example.Resources.ExampleButton.png", _assembly);
+    public static LoadableResourceAsset CallMeetingButton { get; } = new("MiraAPI.Example.Resources.CallMeeting.png", _assembly);
 
     // Credit to EpicHorrors for the teleport button asset.
-    public static LoadableResourceAsset TeleportButton { get; } = new("MiraAPI.Example.Resources.TeleportButton.png");
-    public static LoadableResourceAsset SharpshootButton { get; } = new("MiraAPI.Example.Resources.SharpshootButton.png");
-    public static LoadableResourceAsset Banner { get; } = new("MiraAPI.Example.Resources.FortniteBanner.jpeg");
+    public static LoadableResourceAsset TeleportButton { get; } = new("MiraAPI.Example.Resources.TeleportButton.png", _assembly);
+    public static LoadableResourceAsset SharpshootButton { get; } = new("MiraAPI.Example.Resources.SharpshootButton.png", _assembly);
+    public static LoadableResourceAsset Banner { get; } = new("MiraAPI.Example.Resources.FortniteBanner.jpeg", _assembly);
 }

MiraAPI.Example/ExampleEventHandlers.cs

@@ -31,7 +31,7 @@ public static class ExampleEventHandlers
 
         MiraEventManager.RegisterEventHandler<CompleteTaskEvent>(@event =>
         {
-            Logger<ExamplePlugin>.Info($"{@event.Player.Data.PlayerName} completed {@event.Task.TaskType.ToString()}");
+            Logger<ExamplePlugin>.Info($"{@event.Player.Data.PlayerName} completed {@event.Task.TaskType}");
         });
 
         // You can also unregister event handlers using the handle returned from RegisterEventHandler.
@@ -89,7 +89,7 @@ public static class ExampleEventHandlers
     [RegisterEvent]
     public static void UpdateSystemEventHandler(UpdateSystemEvent @event)
     {
-        Logger<ExamplePlugin>.Error(@event.SystemType.ToString());
+        Logger<ExamplePlugin>.Error(@event.SystemType);
     }
 
     // Example event handler

MiraAPI/Events/MiraEventManager.cs

@@ -35,7 +35,7 @@ public static class MiraEventManager
             }
             catch (Exception ex)
             {
-                Error($"Error invoking event handler for {typeof(T).Name}: {ex.ToString()}");
+                Error($"Error invoking event handler for {typeof(T).Name}: {ex}");
             }
         }
 
@@ -65,7 +65,7 @@ public static class MiraEventManager
             }
             catch (Exception ex)
             {
-                Error($"Error invoking event handler for {type.Name}: {ex.ToString()}");
+                Error($"Error invoking event handler for {type.Name}: {ex}");
             }
         }
 

MiraAPI/GameOptions/IModdedOption.cs

@@ -77,6 +77,11 @@ public interface IModdedOption
     /// </summary>
     bool IncludeInPreset { get; set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether the option should show a notification, toggled on by an overall option synchronization.
+    /// </summary>
+    public bool ShowNotification { get; set; }
+
     /// <summary>
     /// Gets or sets the <see cref="BepInEx.Configuration.ConfigDefinition"/> for the option, used for BepInEx configuration.
     /// </summary>

MiraAPI/GameOptions/ModdedOptionsManager.cs

@@ -365,11 +365,11 @@ public static class ModdedOptionsManager
 
         while (chunks.Count > 0)
         {
-            Rpc<SyncOptionsRpc>.Instance.SendTo(PlayerControl.LocalPlayer, targetId, chunks.Dequeue());
+            Rpc<SyncOptionsRpc>.Instance.SendTo(PlayerControl.LocalPlayer, targetId, new MiraOptionNetData(false, chunks.Dequeue()));
         }
     }
 
-    internal static void HandleSyncOptions(NetData[] data)
+    internal static void HandleSyncOptions(bool showNotifs, NetData[] data)
     {
         // necessary to disable then re-enable this setting
         // we don't know how other plugins handle their configs
@@ -388,6 +388,7 @@ public static class ModdedOptionsManager
                 continue;
             }
 
+            option.ShowNotification = showNotifs;
             option.HandleNetData(netData.Data);
         }
 
@@ -397,7 +398,7 @@ public static class ModdedOptionsManager
             plugin.PluginConfig.SaveOnConfigSet = oldConfigSetting[plugin];
         }
 
-        if (LobbyInfoPane.Instance)
+        if (LobbyInfoPane.InstanceExists)
         {
             LobbyInfoPane.Instance.RefreshPane();
         }

MiraAPI/GameOptions/OptionTypes/ModdedEnumOption.cs

@@ -93,13 +93,17 @@ public class ModdedEnumOption : ModdedOption<int>
     /// <inheritdoc />
     protected override void OnValueChanged(int newValue)
     {
-        ModdedOptionsManager.AddSettingsChangeMessage(
-            HudManager.Instance.Notifier,
-            StringName,
-            Data.GetValueString(newValue),
-            Configuration.PopUpTextColor,
-            Configuration.PopUpIconTmp,
-            false);
+        if (ShowNotification)
+        {
+            ModdedOptionsManager.AddSettingsChangeMessage(
+                HudManager.Instance.Notifier,
+                StringName,
+                Data.GetValueString(newValue),
+                Configuration.PopUpTextColor,
+                Configuration.PopUpIconTmp,
+                false);
+        }
+
         if (!OptionBehaviour)
         {
             return;
@@ -196,13 +200,17 @@ public class ModdedEnumOption<T> : ModdedOption<T>
     /// <inheritdoc />
     protected override void OnValueChanged(T newValue)
     {
-        ModdedOptionsManager.AddSettingsChangeMessage(
-            HudManager.Instance.Notifier,
-            StringName,
-            Data.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)),
-            Configuration.PopUpTextColor,
-            Configuration.PopUpIconTmp,
-            false);
+        if (ShowNotification)
+        {
+            ModdedOptionsManager.AddSettingsChangeMessage(
+                HudManager.Instance.Notifier,
+                StringName,
+                Data.GetValueString(Convert.ToInt32(newValue, NumberFormatInfo.InvariantInfo)),
+                Configuration.PopUpTextColor,
+                Configuration.PopUpIconTmp,
+                false);
+        }
+
         if (!OptionBehaviour)
         {
             return;

MiraAPI/GameOptions/OptionTypes/ModdedNumberOption.cs

@@ -199,13 +199,16 @@ public class ModdedNumberOption : ModdedOption<float>
     protected override void OnValueChanged(float newValue)
     {
         Value = Mathf.Clamp(newValue, Min, Max);
-        ModdedOptionsManager.AddSettingsChangeMessage(
-            HudManager.Instance.Notifier,
-            StringName,
-            Data.GetValueString(newValue),
-            Configuration.PopUpTextColor,
-            Configuration.PopUpIconTmp,
-            false);
+        if (ShowNotification)
+        {
+            ModdedOptionsManager.AddSettingsChangeMessage(
+                HudManager.Instance.Notifier,
+                StringName,
+                Data.GetValueString(newValue),
+                Configuration.PopUpTextColor,
+                Configuration.PopUpIconTmp,
+                false);
+        }
 
         if (OptionBehaviour is NumberOption opt)
         {

MiraAPI/GameOptions/OptionTypes/ModdedOption.cs

@@ -79,6 +79,9 @@ public abstract class ModdedOption<T> : IModdedOption
     /// <inheritdoc />
     public bool IncludeInPreset { get; set; }
 
+    /// <inheritdoc />
+    public bool ShowNotification { get; set; } = true;
+
     /// <inheritdoc />
     public OptionBehaviour? OptionBehaviour { get; protected set; }
 
@@ -156,10 +159,11 @@ public abstract class ModdedOption<T> : IModdedOption
                 entry.Value = _value;
             }
 
-            Rpc<SyncOptionsRpc>.Instance.Send(PlayerControl.LocalPlayer, [GetNetData()], true);
+            Rpc<SyncOptionsRpc>.Instance.Send(PlayerControl.LocalPlayer, new MiraOptionNetData(true, [GetNetData()]), true);
         }
 
         OnValueChanged(_value);
+        ShowNotification = true;
     }
 
     /// <inheritdoc />

MiraAPI/GameOptions/OptionTypes/ModdedToggleOption.cs

@@ -99,13 +99,17 @@ public class ModdedToggleOption : ModdedOption<bool>
     /// <inheritdoc />
     protected override void OnValueChanged(bool newValue)
     {
-        ModdedOptionsManager.AddSettingsChangeMessage(
-            HudManager.Instance.Notifier,
-            StringName,
-            (newValue ? OnValue : OffValue).Translate(),
-            Configuration.PopUpTextColor,
-            Configuration.PopUpIconTmp,
-            false);
+        if (ShowNotification)
+        {
+            ModdedOptionsManager.AddSettingsChangeMessage(
+                HudManager.Instance.Notifier,
+                StringName,
+                (newValue ? OnValue : OffValue).Translate(),
+                Configuration.PopUpTextColor,
+                Configuration.PopUpIconTmp,
+                false);
+        }
+
         if (!OptionBehaviour)
         {
             return;

MiraAPI/MiraApiPlugin.cs

@@ -102,7 +102,7 @@ public partial class MiraApiPlugin : BasePlugin, IMiraPlugin
         PluginManager = new MiraPluginManager();
         PluginManager.Initialize(this, this);
 
-        MiraLocaleManager.Register("mira.api");
+        MiraLocaleManager.Register("mira.api", typeof(MiraApiPlugin).Assembly);
         LocalizationManager.Register(new MiraLocalizationProvider());
 
         IL2CPPChainloader.Instance.Finished +=

MiraAPI/Modifiers/BaseModifier.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using Il2CppInterop.Runtime.Attributes;
 using MiraAPI.GameOptions;
 using MiraAPI.PluginLoading;
@@ -96,6 +97,48 @@ public abstract class BaseModifier : IOptionable
     /// </summary>
     public virtual string ModifierCategoryTitle => MiraLocaleManager.Get("Modifier");
 
+    /// <summary>
+    /// Gets a value indicating whether to exclude the "amount" from the displayed amount text within the role guide.
+    /// </summary>
+    public virtual bool ShowModifierAsUnique => false;
+
+    /// <summary>
+    /// Gets the displayed amount and chance of the modifier. Used in the role guide.
+    /// By default, 0 amount or chance results in a complete 0 amount and chance, so override if necessary.
+    /// </summary>
+    /// <param name="amount">The amount of the modifier.</param>
+    /// <param name="chance">The chance of the modifier.</param>
+    /// <param name="source">The mod source of the modifier.</param>
+    /// <returns>The <see cref="string"/> result.</returns>
+    public virtual string GetAmountText(int amount, int chance, string source)
+    {
+        if (amount == 0)
+        {
+            chance = 0;
+        }
+
+        if (ShowModifierAsUnique)
+        {
+            return string.Format(
+                CultureInfo.InvariantCulture,
+                "{0}% ({1})",
+                chance.ToString(CultureInfo.InvariantCulture),
+                source);
+        }
+
+        if (chance == 0)
+        {
+            amount = 0;
+        }
+
+        return string.Format(
+            CultureInfo.InvariantCulture,
+            "{0} at {1}% ({2})",
+            amount.ToString(CultureInfo.InvariantCulture),
+            chance.ToString(CultureInfo.InvariantCulture),
+            source);
+    }
+
     /// <summary>
     /// Gets whether the modifier is forcibly shown or disabled in the wiki screen.
     /// </summary>

MiraAPI/Modifiers/ModifierComponent.cs

@@ -77,7 +77,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr)
             }
             catch (Exception e)
             {
-                Error($"Error while deactivating modifier {modifier.ModifierName}: {e.ToString()}");
+                Error($"Error while deactivating modifier {modifier.ModifierName}: {e}");
             }
 
             Modifiers.Remove(modifier);
@@ -95,7 +95,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr)
             }
             catch (Exception e)
             {
-                Error($"Error while activating modifier {modifier.ModifierName}: {e.ToString()}");
+                Error($"Error while activating modifier {modifier.ModifierName}: {e}");
             }
 
             if (modifier is TimedModifier { AutoStart: true } timer)
@@ -122,7 +122,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr)
             }
             catch (Exception e)
             {
-                Error($"Error while (fixed) updating modifier {modifier.ModifierName}: {e.ToString()}");
+                Error($"Error while (fixed) updating modifier {modifier.ModifierName}: {e}");
             }
         }
 
@@ -153,7 +153,7 @@ public class ModifierComponent(IntPtr cppPtr) : MonoBehaviour(cppPtr)
             }
             catch (Exception e)
             {
-                Error($"Error while updating modifier {modifier.ModifierName}: {e.ToString()}");
+                Error($"Error while updating modifier {modifier.ModifierName}: {e}");
             }
         }
     }

MiraAPI/Networking/CustomMurderRpc.cs

@@ -571,7 +571,7 @@ public static class CustomMurderRpc
                 }
                 catch (Exception e)
                 {
-                    Error($"Error with kill animation: {e.ToString()}");
+                    Error($"Error with kill animation: {e}");
                 }
             }
 
@@ -705,7 +705,7 @@ public static class CustomMurderRpc
                 }
                 catch (Exception e)
                 {
-                    Error($"Error with kill animation: {e.ToString()}");
+                    Error($"Error with kill animation: {e}");
                 }
             }
 

MiraAPI/Networking/SyncOptionsRpc.cs

@@ -9,29 +9,32 @@ namespace MiraAPI.Networking;
 [RegisterCustomRpc((uint)MiraRpc.SyncGameOptions)]
 #pragma warning disable SA1515 // Single-line comment should be preceded by blank line (Justification: ReSharper suppression.)
 // ReSharper disable once ClassNeverInstantiated.Global (Justification: Instantiated by Reactor.)
-internal sealed class SyncOptionsRpc(MiraApiPlugin plugin, uint id) : PlayerCustomRpc<MiraApiPlugin, NetData[]>(plugin, id)
+internal sealed class SyncOptionsRpc(MiraApiPlugin plugin, uint id) : PlayerCustomRpc<MiraApiPlugin, MiraOptionNetData>(plugin, id)
 #pragma warning restore SA1515 // Single-line comment should be preceded by blank line
 {
     public override RpcLocalHandling LocalHandling => RpcLocalHandling.None;
 
-    public override void Write(MessageWriter writer, NetData[]? data)
+    public override void Write(MessageWriter writer, MiraOptionNetData data)
     {
-        if (data == null)
+        /*if (data == null)
         {
             writer.WritePacked(0U);
             return;
-        }
+        }*/
 
-        writer.WritePacked((uint)data.Length);
-        foreach (var netData in data)
+        var info = data.Data;
+        writer.Write(data.ShouldShowNotifications);
+        writer.WritePacked((uint)info.Length);
+        foreach (var netData in info)
         {
             writer.WritePacked(netData.Id);
             writer.WriteBytesAndSize(netData.Data);
         }
     }
 
-    public override NetData[] Read(MessageReader reader)
+    public override MiraOptionNetData Read(MessageReader reader)
     {
+        var shouldShowNotif = reader.ReadBoolean();
         var length = reader.ReadPackedUInt32();
         var data = new NetData[length];
         for (var i = 0; i < length; i++)
@@ -41,16 +44,16 @@ internal sealed class SyncOptionsRpc(MiraApiPlugin plugin, uint id) : PlayerCust
             data[i] = new NetData(dataId, bytes);
         }
 
-        return data;
+        return new MiraOptionNetData(shouldShowNotif, data);
     }
 
-    public override void Handle(PlayerControl playerControl, NetData[]? data)
+    public override void Handle(PlayerControl playerControl, MiraOptionNetData data)
     {
         if (AmongUsClient.Instance.HostId != playerControl.OwnerId)
         {
             return;
         }
 
-        ModdedOptionsManager.HandleSyncOptions(data ?? []);
+        ModdedOptionsManager.HandleSyncOptions(data.ShouldShowNotifications, data.Data ?? []);
     }
 }

MiraAPI/Networking/SyncRoleOptionsRpc.cs

@@ -5,32 +5,41 @@ using Reactor.Networking.Rpc;
 
 namespace MiraAPI.Networking;
 
+internal readonly struct MiraOptionNetData(bool showNotif, NetData[] data)
+{
+    public bool ShouldShowNotifications { get; } = showNotif;
+    public NetData[] Data { get; } = data;
+}
+
 [RegisterCustomRpc((uint)MiraRpc.SyncRoleOptions)]
 #pragma warning disable SA1515 // Single-line comment should be preceded by blank line (Justification: ReSharper suppression.)
 // ReSharper disable once ClassNeverInstantiated.Global (Justification: Instantiated by Reactor.)
-internal sealed class SyncRoleOptionsRpc(MiraApiPlugin plugin, uint id) : PlayerCustomRpc<MiraApiPlugin, NetData[]>(plugin, id)
+internal sealed class SyncRoleOptionsRpc(MiraApiPlugin plugin, uint id) : PlayerCustomRpc<MiraApiPlugin, MiraOptionNetData>(plugin, id)
 #pragma warning restore SA1515 // Single-line comment should be preceded by blank line
 {
     public override RpcLocalHandling LocalHandling => RpcLocalHandling.None;
 
-    public override void Write(MessageWriter writer, NetData[]? data)
+    public override void Write(MessageWriter writer, MiraOptionNetData data)
     {
-        if (data == null)
+        /*if (data == null)
         {
             writer.WritePacked(0U);
             return;
-        }
+        }*/
 
-        writer.WritePacked((uint)data.Length);
-        foreach (var netData in data)
+        var info = data.Data;
+        writer.Write(data.ShouldShowNotifications);
+        writer.WritePacked((uint)info.Length);
+        foreach (var netData in info)
         {
             writer.WritePacked(netData.Id);
             writer.WriteBytesAndSize(netData.Data);
         }
     }
 
-    public override NetData[] Read(MessageReader reader)
+    public override MiraOptionNetData Read(MessageReader reader)
     {
+        var shouldShowNotif = reader.ReadBoolean();
         var length = reader.ReadPackedUInt32();
         var data = new NetData[length];
         for (var i = 0; i < length; i++)
@@ -40,16 +49,16 @@ internal sealed class SyncRoleOptionsRpc(MiraApiPlugin plugin, uint id) : Player
             data[i] = new NetData(dataId, bytes);
         }
 
-        return data;
+        return new MiraOptionNetData(shouldShowNotif, data);
     }
 
-    public override void Handle(PlayerControl playerControl, NetData[]? data)
+    public override void Handle(PlayerControl playerControl, MiraOptionNetData data)
     {
         if (AmongUsClient.Instance.HostId != playerControl.OwnerId)
         {
             return;
         }
 
-        CustomRoleManager.HandleSyncRoleOptions(data ?? []);
+        CustomRoleManager.HandleSyncRoleOptions(data.ShouldShowNotifications, data.Data ?? []);
     }
 }

MiraAPI/Patches/Freeplay/TaskAdderPatches.cs

@@ -186,9 +186,11 @@ public static class TaskAdderPatches
                 systemTypes = SystemTypes.UpperEngine;
             }
 
-            if (!folders.TryGetValue(systemTypes.ToString(), out var taskFolder3))
+            var systemType = systemTypes.ToString();
+
+            if (!folders.TryGetValue(systemType, out var taskFolder3))
             {
-                taskFolder3 = folders[systemTypes.ToString()] = Object.Instantiate(__instance.RootFolderPrefab, __instance.transform);
+                taskFolder3 = folders[systemType] = Object.Instantiate(__instance.RootFolderPrefab, __instance.transform);
                 taskFolder3.SetFolderColor(TaskFolder.FolderColor.Tan);
                 taskFolder3.gameObject.SetActive(false);
                 taskFolder3.FolderName = systemTypes == SystemTypes.UpperEngine

MiraAPI/Patches/GameModes/GameManagerPatches.cs

@@ -1,5 +1,7 @@
 using HarmonyLib;
 using MiraAPI.GameModes;
+using MiraAPI.GameOptions;
+using MiraAPI.Roles;
 
 namespace MiraAPI.Patches.GameModes;
 
@@ -55,4 +57,17 @@ internal static class GameStartManagerPatches
             __instance.MinPlayers = 1;
         }
     }
+
+    [HarmonyPrefix, HarmonyPatch(nameof(GameStartManager.BeginGame))]
+    public static void Prefix(GameStartManager __instance)
+    {
+        if (!AmongUsClient.Instance.AmHost)
+        {
+            return;
+        }
+
+        ModdedOptionsManager.SyncAllOptions();
+        CustomRoleManager.SyncAllRoleSettings();
+        GameModeOption.RpcSyncGamemode(PlayerControl.LocalPlayer, GameModeOption.Value);
+    }
 }

MiraAPI/Patches/HudManagerPatches.cs

@@ -29,7 +29,7 @@ public static class HudManagerPatches
 
     public static IEnumerator CoResizeUI()
     {
-        while (!HudManager.Instance) yield return null;
+        while (!HudManager.InstanceExists) yield return null;
 
         yield return new WaitForSeconds(0.01f);
         ResizeUI(LocalSettingsTabSingleton<MiraApiSettings>.Instance.ButtonUIFactorSlider.Value);

MiraAPI/Patches/Options/RoleSettingMenuPatches.cs

@@ -495,7 +495,7 @@ public static class RoleSettingMenuPatches
 
         if (AmongUsClient.Instance.AmHost)
         {
-            Rpc<SyncRoleOptionsRpc>.Instance.Send(PlayerControl.LocalPlayer, [role.GetNetData()], true);
+            Rpc<SyncRoleOptionsRpc>.Instance.Send(PlayerControl.LocalPlayer, new MiraOptionNetData(true, [role.GetNetData()]), true);
         }
 
         GameOptionsManager.Instance.GameHostOptions = GameOptionsManager.Instance.CurrentGameOptions;

MiraAPI/Patches/RoleGuidePatches.cs

@@ -754,7 +754,8 @@ public static class RoleGuidePatches
                     modifier.ModifierCategoryTitle,
                     modifier.ParentMod.MiraPlugin.GetAbbreviatedModName(),
                     null,
-                    modifier));
+                    modifier,
+                    modifier.TypeId));
             }
         }
 
@@ -790,7 +791,8 @@ public static class RoleGuidePatches
                 roleBehaviour.GetCategoryTitle(),
                 modId,
                 roleBehaviour,
-                null));
+                null,
+                (uint)roleBehaviour.Role));
         }
 
         _roleEntriesMode = activeModeType;
@@ -928,7 +930,7 @@ public static class RoleGuidePatches
         }
     }
 
-    private sealed class DetailedPanel(string title, string category, string modId, RoleBehaviour? role, GameModifier? modifier)
+    private sealed class DetailedPanel(string title, string category, string modId, RoleBehaviour? role, GameModifier? modifier, uint typeId)
     {
         public MatchInfoRolePanel? Panel { get; set; }
         public string Title { get; } = title;
@@ -936,6 +938,7 @@ public static class RoleGuidePatches
         public string ModId { get; } = modId;
         public RoleBehaviour? Role { get; } = role;
         public GameModifier? Modifier { get; } = modifier;
+        public uint TypeId { get; } = typeId;
         public int Amount { get; set; }
         public int Chance { get; set; }
         public float Likelihood { get; set; }
@@ -1157,7 +1160,9 @@ public static class RoleGuidePatches
             entry.Visible = entry.CanShow && MatchesSearch(entry, searchText);
             if (entry.Panel)
             {
-                SetPanelCount(entry.Panel!, entry.Amount, entry.Chance, entry.ModId);
+                dynamic entryType = entry.Modifier != null ? entry.Modifier : entry.Role!;
+                var text = GetPanelCountText(entryType, entry.Amount, entry.Chance, entry.ModId);
+                SetPanelCount(entry.Panel!, text);
                 if (!entry.Visible && entry.Panel!.gameObject.activeSelf)
                 {
                     entry.Panel.gameObject.SetActive(false);
@@ -1182,16 +1187,58 @@ public static class RoleGuidePatches
         return shown;
     }
 
+    public static IEnumerable<GameModifier> GetActiveModifiers()
+    {
+        return PlayerControl.LocalPlayer.GetModifiers<GameModifier>();
+    }
+
+    public static IEnumerable<RoleBehaviour> GetActiveRoles()
+    {
+        IEnumerable<RoleBehaviour> comparisons = [];
+
+        var curRole = PlayerControl.LocalPlayer.Data.Role;
+
+        comparisons = comparisons.AddItem(curRole);
+
+        if (PlayerControl.LocalPlayer && PlayerControl.LocalPlayer.Data && PlayerControl.LocalPlayer.Data.IsDead &&
+            !comparisons.Any(x => x.Role == PlayerControl.LocalPlayer.Data.RoleWhenAlive.Value))
+        {
+            comparisons = comparisons.AddItem(RoleManager.Instance.GetRole(PlayerControl.LocalPlayer.Data.RoleWhenAlive.Value));
+        }
+
+        return comparisons;
+    }
+
+    public static List<uint> GetActiveIds()
+    {
+        var activeModifiers = GetActiveModifiers();
+        List<uint> comparisons = activeModifiers.Select(x => x.TypeId).ToList();
+        comparisons.AddRange(GetActiveRoles().Select(x => (uint)x.Role));
+
+        return comparisons;
+    }
+
     private static List<DetailedPanel> SortEntries(List<DetailedPanel> entries, string searchText)
     {
+        var activeModifiers = PlayerControl.LocalPlayer.GetModifiers<GameModifier>().Select(x => x.TypeId);
+        var roles = GetActiveRoles().Select(x => (uint)x.Role).ToList();
+        List<uint> comparisons = activeModifiers.ToList();
+        comparisons.AddRange(roles);
+
+        var comparer = new BasicGuideComparer(comparisons);
+
         var sorted = entries.Where(p => p.Visible)
             .OrderByDescending(p => p.Title.Equals(searchText, StringComparison.OrdinalIgnoreCase))
             .ThenByDescending(p =>
                 p.Title.Contains(searchText, StringComparison.OrdinalIgnoreCase) ||
-                p.Category.Contains(searchText, StringComparison.OrdinalIgnoreCase));
-        return [.. _sortMethod is SortingMethod.Alphabetical
+                p.Category.Contains(searchText, StringComparison.OrdinalIgnoreCase))
+            .ThenBy(x => x.Modifier != null ? x.Modifier.TypeId : (uint)x.Role!.Role, comparer);
+        return
+        [
+            .. _sortMethod is SortingMethod.Alphabetical
                 ? sorted.ThenBy(p => p.GetSortKey(_sortGrouping))
-                : sorted.ThenByDescending(p => p.GetSortKey(_sortGrouping))];
+                : sorted.ThenByDescending(p => p.GetSortKey(_sortGrouping))
+        ];
     }
 
     private static bool MatchesSearch(DetailedPanel entry, string searchText)
@@ -1651,10 +1698,15 @@ public static class RoleGuidePatches
 
     public static Sprite GetRandomRoleIcon()
     {
-        var aliveRole = PlayerControl.LocalPlayer.Data?.Role;
-        if (aliveRole != null && aliveRole.RoleIconSolid != null)
+        var roles = GetActiveRoles().Shuffle().ToList();
+        foreach (var role in roles)
         {
-            return aliveRole.RoleIconSolid;
+            if (role.RoleIconSolid == null)
+            {
+                continue;
+            }
+
+            return role.RoleIconSolid;
         }
 
         return GetRandomFactionIcon();
@@ -1793,21 +1845,22 @@ public static class RoleGuidePatches
             return false;
         }
 
-        __instance.roleCount.text = string.Format(
-            CultureInfo.InvariantCulture,
-            "{0} at {1}%",
-            numPerGame.ToString(CultureInfo.InvariantCulture),
-            chancePerGame);
         if (role is ICustomRole customRole)
         {
             __instance.roleName.text = customRole.RoleName;
             __instance.roleDescription.text =
                 $"<size=60%>{role.GetCategoryTitle()}</size>\n" + customRole.RoleMedDescription;
             __instance.roleIcon.sprite = customRole.Configuration.Icon?.LoadAsset();
-            __instance.roleCount.text += $" ({customRole.ParentMod.MiraPlugin.GetAbbreviatedModName()})";
+            var text = GetCustomRolePanelCountText(customRole, numPerGame, chancePerGame, customRole.ParentMod.MiraPlugin.GetAbbreviatedModName());
+            SetPanelCount(__instance, text);
         }
         else
         {
+            __instance.roleCount.text = string.Format(
+                CultureInfo.InvariantCulture,
+                "{0} at {1}%",
+                numPerGame.ToString(CultureInfo.InvariantCulture),
+                chancePerGame);
             __instance.roleName.text = role.NiceName;
             __instance.roleDescription.text = $"<size=60%>{role.GetCategoryTitle()}</size>\n" + role.BlurbMed;
             __instance.roleIcon.sprite = role.RoleIconColor;
@@ -1823,9 +1876,20 @@ public static class RoleGuidePatches
         return false;
     }
 
-    private static void SetPanelCount(MatchInfoRolePanel panel, int amount, int chance, string modId)
+    // NOTE: This is specifically meant to be a different method name as to not have the game check this method and the GetPanelCountText method made for roles overall.
+    private static string GetCustomRolePanelCountText(ICustomRole custom, int amount, int chance, string modId)
     {
-        panel.roleCount.text = string.Format(
+        return custom.GetAmountText(amount, chance, modId);
+    }
+
+    private static string GetPanelCountText(RoleBehaviour role, int amount, int chance, string modId)
+    {
+        if (role is ICustomRole custom)
+        {
+            return custom.GetAmountText(amount, chance, modId);
+        }
+
+        return string.Format(
             CultureInfo.InvariantCulture,
             "{0} at {1}% ({2})",
             amount.ToString(CultureInfo.InvariantCulture),
@@ -1833,6 +1897,18 @@ public static class RoleGuidePatches
             modId);
     }
 
+    private static string GetPanelCountText(BaseModifier modifier, int amount, int chance, string modId)
+    {
+        return modifier.GetAmountText(amount, chance, modId);
+    }
+
+    private static void SetPanelCount(MatchInfoRolePanel panel, string amountChanceText)
+    {
+        panel.roleCount.text = string.Format(
+            CultureInfo.InvariantCulture,
+            amountChanceText);
+    }
+
     public static void SetRolePanel(
         this MatchInfoRolePanel instance,
         RoleBehaviour role,
@@ -1845,14 +1921,16 @@ public static class RoleGuidePatches
             instance.roleDescription.text =
                 $"<size=60%>{role.GetCategoryTitle()}</size>\n" + customRole.RoleMedDescription;
             instance.roleIcon.sprite = customRole.Configuration.Icon?.LoadAsset();
-            SetPanelCount(instance, numPerGame, chancePerGame, customRole.ParentMod.MiraPlugin.GetAbbreviatedModName());
+            var text = GetCustomRolePanelCountText(customRole, numPerGame, chancePerGame, customRole.ParentMod.MiraPlugin.GetAbbreviatedModName());
+            SetPanelCount(instance, text);
         }
         else
         {
             instance.roleName.text = role.NiceName;
             instance.roleDescription.text = $"<size=60%>{role.GetCategoryTitle()}</size>\n" + role.BlurbMed;
             instance.roleIcon.sprite = role.RoleIconColor;
-            SetPanelCount(instance, numPerGame, chancePerGame, "AU");
+            var text = GetPanelCountText(role, numPerGame, chancePerGame, "AU");
+            SetPanelCount(instance, text);
         }
 
         instance.roleIcon.SetSizeLimit(0.13f);
@@ -1873,7 +1951,8 @@ public static class RoleGuidePatches
         instance.roleDescription.text =
             $"<size=60%>{modifier.ModifierCategoryTitle}</size>\n" + modifier.ModifierMedDescription;
         instance.roleIcon.sprite = modifier.ModifierIcon?.LoadAsset();
-        SetPanelCount(instance, numPerGame, chancePerGame, modifier.ParentMod.MiraPlugin.GetAbbreviatedModName());
+        var text = GetPanelCountText(modifier, numPerGame, chancePerGame, modifier.ParentMod.MiraPlugin.GetAbbreviatedModName());
+        SetPanelCount(instance, text);
 
         instance.roleIcon.SetSizeLimit(0.13f);
         instance.roleIcon.material.SetInt(PlayerMaterial.MaskLayer, 50);

MiraAPI/PluginLoading/MiraPluginInfo.cs

@@ -25,6 +25,26 @@ public class MiraPluginInfo
         PluginId = info.Metadata.GUID;
     }
 
+    /// <summary>
+    /// Gets the plugin's ID, as defined in the plugin's BepInEx metadata.
+    /// </summary>
+    public string PluginId { get; }
+
+    /// <summary>
+    /// Gets the plugin's instance as an <see cref="IMiraPlugin"/>.
+    /// </summary>
+    public IMiraPlugin MiraPlugin { get; }
+
+    /// <summary>
+    /// Gets the plugin's BepInEx metadata.
+    /// </summary>
+    public PluginInfo PluginInfo { get; }
+
+    /// <summary>
+    /// Gets the plugin's <see cref="ConfigFile"/>.
+    /// </summary>
+    public ConfigFile PluginConfig { get; }
+
     /// <summary>
     /// Gets a <see cref="IReadOnlyCollection{T}"/> of this <see cref="IMiraPlugin"/>'s <see cref="BaseModifier"/>s. This is not safe for <see cref="BaseModifier"/>s with constructors.
     /// </summary>
@@ -45,15 +65,6 @@ public class MiraPluginInfo
     /// </summary>
     public ReadOnlyDictionary<ushort, RoleBehaviour> Roles { get; private set; } = null!;
 
-    /// <summary>
-    /// Gets a read only dictionary of Game Mode IDs and the AbstractGameMode object they are associated with.
-    /// </summary>
-    /// <returns>Read only dictionary of IDs and Game Modes.</returns>
-    public ReadOnlyDictionary<uint, AbstractGameMode> GetModes()
-    {
-        return new ReadOnlyDictionary<uint, AbstractGameMode>(GameModes);
-    }
-
     /// <summary>
     /// Gets a <see cref="IReadOnlyCollection{T}"/> of this <see cref="IMiraPlugin"/>'s <see cref="CustomActionButton"/>.
     /// </summary>
@@ -74,6 +85,15 @@ public class MiraPluginInfo
     /// </summary>
     public IReadOnlyCollection<OptionPreset> Presets { get; internal set; } = null!;
 
+    /// <summary>
+    /// Gets a read only dictionary of Game Mode IDs and the AbstractGameMode object they are associated with.
+    /// </summary>
+    /// <returns>Read only dictionary of IDs and Game Modes.</returns>
+    public ReadOnlyDictionary<uint, AbstractGameMode> GetModes()
+    {
+        return new ReadOnlyDictionary<uint, AbstractGameMode>(GameModes);
+    }
+
     internal void SavePublicCollections()
     {
         Presets = [.. InternalPresets];
@@ -87,39 +107,13 @@ public class MiraPluginInfo
     }
 
     internal List<OptionPreset> InternalPresets { get; } = [];
-
-    internal List<AbstractOptionGroup> InternalOptionGroups { get; } = [];
-
     internal List<IModdedOption> InternalOptions { get; } = [];
-
     internal List<BaseModifier> InternalModifiers { get; } = [];
+    internal List<CustomActionButton> InternalButtons { get; } = [];
+    internal List<AbstractOptionGroup> InternalOptionGroups { get; } = [];
+    internal List<MeetingActionButton> InternalMeetingButtons { get; } = [];
+    internal List<TargetedMeetingButton> InternalTargetedMeetingButtons { get; } = [];
 
     internal Dictionary<uint, AbstractGameMode> GameModes { get; } = [];
     internal Dictionary<ushort, RoleBehaviour> InternalRoles { get; } = [];
-
-    internal List<CustomActionButton> InternalButtons { get; } = [];
-
-    internal List<TargetedMeetingButton> InternalTargetedMeetingButtons { get; } = [];
-
-    internal List<MeetingActionButton> InternalMeetingButtons { get; } = [];
-
-    /// <summary>
-    /// Gets the plugin's ID, as defined in the plugin's BepInEx metadata.
-    /// </summary>
-    public string PluginId { get; }
-
-    /// <summary>
-    /// Gets the plugin's instance as an <see cref="IMiraPlugin"/>.
-    /// </summary>
-    public IMiraPlugin MiraPlugin { get; }
-
-    /// <summary>
-    /// Gets the plugin's BepInEx metadata.
-    /// </summary>
-    public PluginInfo PluginInfo { get; }
-
-    /// <summary>
-    /// Gets the plugin's <see cref="ConfigFile"/>.
-    /// </summary>
-    public ConfigFile PluginConfig { get; }
 }

MiraAPI/PluginLoading/MiraPluginManager.cs

@@ -4,6 +4,7 @@ using System.Collections.ObjectModel;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Reflection;
+using BepInEx;
 using BepInEx.Configuration;
 using BepInEx.Unity.IL2CPP;
 using HarmonyLib;
@@ -24,7 +25,6 @@ using MiraAPI.Roles;
 using MiraAPI.Translation;
 using MiraAPI.Utilities;
 using Reactor.Networking;
-using Reactor.Utilities;
 
 namespace MiraAPI.PluginLoading;
 
@@ -49,100 +49,14 @@ public sealed class MiraPluginManager
         Instance = this;
         CustomGameModeManager.RegisterDefaultMode();
         CustomGameModeManager.GetAndSetGameMode();
+
         if (IL2CPPChainloader.Instance.Plugins.TryGetValue(MiraApiPlugin.Id, out var newPlugin))
         {
-            var assembly = Assembly.GetCallingAssembly();
-            var info = new MiraPluginInfo(apiPlugin, newPlugin);
-            var roles = new List<Type>();
+            var info = RegisterPlugin(typeof(MiraPluginManager).Assembly, apiPlugin, newPlugin, miraApiPlugin, true);
 
-            var oldConfigSetting = info.PluginConfig.SaveOnConfigSet;
-            info.PluginConfig.SaveOnConfigSet = false;
-
-            foreach (var type in assembly.GetTypes())
-            {
-                if (type.IsAbstract || type.GetCustomAttribute<MiraIgnoreAttribute>() != null)
-                {
-                    continue;
-                }
-
-                foreach (var method in AccessTools.GetDeclaredMethods(type))
-                {
-                    var eventAttribute = method.GetCustomAttribute<RegisterEventAttribute>();
-                    if (eventAttribute == null)
-                    {
-                        continue;
-                    }
-
-                    if (!method.IsStatic)
-                    {
-                        Error($"Event method {method.Name} in {type.Name} must be static.");
-                        continue;
-                    }
-
-                    var parameters = method.GetParameters();
-                    if (parameters.Length != 1 || !parameters[0].ParameterType.IsSubclassOf(typeof(MiraEvent)))
-                    {
-                        Error($"Invalid event registration method {method.Name} in {type.Name}");
-                        continue;
-                    }
-
-                    var paramType = parameters[0].ParameterType;
-                    MiraEventManager.RegisterEventHandler(paramType, method, eventAttribute.Priority);
-                }
-
-                if (RegisterModifier(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterOptions(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterLocalTabs(type, miraApiPlugin))
-                {
-                    continue;
-                }
-
-                if (RegisterRole(type, info, out var role))
-                {
-                    roles.Add(role);
-                    continue;
-                }
-
-                if (RegisterButton(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterGameOver(type))
-                {
-                    continue;
-                }
-
-                if (RegisterGameModeAttribute(type, info))
-                {
-                    continue;
-                }
-
-                RegisterColorClasses(type);
-                RegisterKeybinds(type, miraApiPlugin);
-            }
-
-            info.PluginConfig.Save();
-            info.PluginConfig.SaveOnConfigSet = oldConfigSetting;
             MiraApiConfig = info.PluginConfig;
-
-            info.InternalOptionGroups.Sort((x, y) => x.GroupPriority.CompareTo(y.GroupPriority));
-            QueuedRoleRegistrations.Add(info, roles);
-
-            _registeredPlugins.Add(assembly, info);
             MiraApiPluginInfo = info;
 
-            info.SavePublicCollections();
-            PresetManager.CreateDefaultPreset(info);
-            PresetManager.LoadPresets(info);
             Info($"Registering Mira API as mod.");
         }
 
@@ -153,110 +67,14 @@ public sealed class MiraPluginManager
                 return;
             }
 
-            var info = new MiraPluginInfo(miraPlugin, pluginInfo);
-            var roles = new List<Type>();
-
-            var oldConfigSetting = info.PluginConfig.SaveOnConfigSet;
-            info.PluginConfig.SaveOnConfigSet = false;
-
-            foreach (var type in assembly.GetTypes())
-            {
-                if (type.GetCustomAttribute<MiraIgnoreAttribute>() != null)
-                {
-                    continue;
-                }
-
-                foreach (var method in AccessTools.GetDeclaredMethods(type))
-                {
-                    var eventAttribute = method.GetCustomAttribute<RegisterEventAttribute>();
-                    if (eventAttribute == null)
-                    {
-                        continue;
-                    }
-
-                    if (!method.IsStatic)
-                    {
-                        Error($"Event method {method.Name} in {type.Name} must be static.");
-                        continue;
-                    }
-
-                    var parameters = method.GetParameters();
-                    if (parameters.Length != 1 || !parameters[0].ParameterType.IsSubclassOf(typeof(MiraEvent)))
-                    {
-                        Error($"Invalid event registration method {method.Name} in {type.Name}");
-                        continue;
-                    }
-
-                    var paramType = parameters[0].ParameterType;
-                    MiraEventManager.RegisterEventHandler(paramType, method, eventAttribute.Priority);
-                }
-
-                if (RegisterModifier(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterOptions(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterLocalTabs(type, plugin))
-                {
-                    continue;
-                }
-
-                if (RegisterRole(type, info, out var role))
-                {
-                    roles.Add(role);
-                    continue;
-                }
-
-                if (RegisterButton(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterGameOver(type))
-                {
-                    continue;
-                }
-
-                if (RegisterMeetingAbility(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterTargetedMeetingAbility(type, info))
-                {
-                    continue;
-                }
-
-                if (RegisterGameModeAttribute(type, info))
-                {
-                    continue;
-                }
-
-                RegisterColorClasses(type);
-                RegisterKeybinds(type, plugin);
-            }
-
-            info.PluginConfig.Save();
-            info.PluginConfig.SaveOnConfigSet = oldConfigSetting;
-
-            info.InternalOptionGroups.Sort((x, y) => x.GroupPriority.CompareTo(y.GroupPriority));
-            QueuedRoleRegistrations.Add(info, roles);
-
-            _registeredPlugins.Add(assembly, info);
-
-            info.SavePublicCollections();
-            PresetManager.CreateDefaultPreset(info);
-            PresetManager.LoadPresets(info);
+            RegisterPlugin(assembly, miraPlugin, pluginInfo, plugin, false);
             Info($"Registering mod {pluginInfo.Metadata.GUID} with Mira API.");
         };
-        IL2CPPChainloader.Instance.Finished += PaletteManager.RegisterAllColors;
+
         IL2CPPChainloader.Instance.Finished += () =>
         {
+            PaletteManager.RegisterAllColors();
+
             // Save all buttons into a read-only collection for easy access
             CustomButtonManager.Buttons = new ReadOnlyCollection<CustomActionButton>(CustomButtonManager.CustomButtons);
             CustomButtonManager.EventTypes = new ReadOnlyDictionary<Type, Type>(CustomButtonManager.ButtonEventTypes);
@@ -269,9 +87,101 @@ public sealed class MiraPluginManager
 
             ModifierManager.Modifiers = new ReadOnlyCollection<BaseModifier>(ModifierManager.InternalModifiers);
         };
+    }
 
-        RegisterKeybinds(typeof(MiraGlobalKeybinds), PluginSingleton<MiraApiPlugin>.Instance);
-        RegisterLocalTabs(typeof(MiraApiSettings), PluginSingleton<MiraApiPlugin>.Instance);
+    private MiraPluginInfo RegisterPlugin(Assembly assembly, IMiraPlugin plugin, PluginInfo pluginInfo, BasePlugin basePlugin, bool isMira)
+    {
+        var info = new MiraPluginInfo(plugin, pluginInfo);
+        var roles = new List<Type>();
+
+        var oldConfigSetting = info.PluginConfig.SaveOnConfigSet;
+        info.PluginConfig.SaveOnConfigSet = false;
+
+        ProcessAssemblyTypes(assembly, info, basePlugin, roles, isMira);
+
+        info.PluginConfig.Save();
+        info.PluginConfig.SaveOnConfigSet = oldConfigSetting;
+
+        info.InternalOptionGroups.Sort((x, y) => x.GroupPriority.CompareTo(y.GroupPriority));
+        QueuedRoleRegistrations.Add(info, roles);
+        _registeredPlugins.Add(assembly, info);
+
+        info.SavePublicCollections();
+        PresetManager.CreateDefaultPreset(info);
+        PresetManager.LoadPresets(info);
+
+        return info;
+    }
+
+    private static void ProcessAssemblyTypes(Assembly assembly, MiraPluginInfo info, BasePlugin basePlugin, List<Type> roles, bool isMira)
+    {
+        foreach (var type in assembly.GetTypes())
+        {
+            if ((isMira && type.IsAbstract) || type.GetCustomAttribute<MiraIgnoreAttribute>() != null)
+                continue;
+
+            RegisterEvents(type);
+
+            if (RegisterModifier(type, info))
+                continue;
+
+            if (RegisterOptions(type, info))
+                continue;
+
+            if (RegisterLocalTabs(type, basePlugin))
+                continue;
+
+            if (RegisterRole(type, info, out var role))
+            {
+                roles.Add(role);
+                continue;
+            }
+
+            if (RegisterButton(type, info))
+                continue;
+
+            if (RegisterGameOver(type))
+                continue;
+
+            if (RegisterMeetingAbility(type, info))
+                continue;
+
+            if (RegisterTargetedMeetingAbility(type, info))
+                continue;
+
+            if (RegisterGameModeAttribute(type, info))
+                continue;
+
+            RegisterColorClasses(type);
+            RegisterKeybinds(type, basePlugin);
+        }
+    }
+
+    private static void RegisterEvents(Type type)
+    {
+        foreach (var method in AccessTools.GetDeclaredMethods(type))
+        {
+            var eventAttribute = method.GetCustomAttribute<RegisterEventAttribute>();
+
+            if (eventAttribute == null)
+                continue;
+
+            if (!method.IsStatic)
+            {
+                Error($"Event method {method.Name} in {type.Name} must be static.");
+                continue;
+            }
+
+            var parameters = method.GetParameters();
+            if (parameters.Length != 1 || !parameters[0].ParameterType.IsSubclassOf(typeof(MiraEvent)))
+            {
+                Error($"Invalid event registration method {method.Name} in {type.Name}");
+                continue;
+            }
+
+            var paramType = parameters[0].ParameterType;
+            MiraEventManager.RegisterEventHandler(paramType, method, eventAttribute.Priority);
+        }
     }
 
     /// <summary>
@@ -358,7 +268,7 @@ public sealed class MiraPluginManager
         }
         catch (Exception e)
         {
-            Error($"Failed to register options for {type.Name}: {e.ToString()}");
+            Error($"Failed to register options for {type.Name}: {e}");
         }
 
         return false;
@@ -543,7 +453,7 @@ public sealed class MiraPluginManager
         }
         catch (Exception e)
         {
-            Error($"Failed to register options for {type.Name}: {e.ToString()}");
+            Error($"Failed to register options for {type.Name}: {e}");
         }
 
         return false;

MiraAPI/Roles/CustomRoleManager.cs

@@ -280,11 +280,11 @@ public static class CustomRoleManager
 
         while (data.Count > 0)
         {
-            Rpc<SyncRoleOptionsRpc>.Instance.SendTo(PlayerControl.LocalPlayer, targetId, data.Dequeue());
+            Rpc<SyncRoleOptionsRpc>.Instance.SendTo(PlayerControl.LocalPlayer, targetId, new MiraOptionNetData(false, data.Dequeue()));
         }
     }
 
-    internal static void HandleSyncRoleOptions(NetData[] data)
+    internal static void HandleSyncRoleOptions(bool showNotifs, NetData[] data)
     {
         // necessary to disable then re-enable this setting
         // we don't know how other plugins handle their configs
@@ -312,7 +312,10 @@ public static class CustomRoleManager
             var num = BitConverter.ToInt32(netData.Data, 0);
             var chance = BitConverter.ToInt32(netData.Data, 4);
 
-            HudManager.Instance.Notifier.AddRoleSettingsChangeMessage(role.StringName, num, chance, role.TeamType, false);
+            if (showNotifs)
+            {
+                HudManager.Instance.Notifier.AddRoleSettingsChangeMessage(role.StringName, num, chance, role.TeamType, false);
+            }
 
             try
             {

MiraAPI/Roles/ICustomRole.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Text;
 using BepInEx.Configuration;
 using Il2CppInterop.Runtime.Attributes;
@@ -92,6 +93,48 @@ public interface ICustomRole : IOptionable
         _ => MiraLocaleManager.Get("MiraApi.RoleTeam.Other"),
     };
 
+    /// <summary>
+    /// Gets a value indicating whether to exclude the "amount" from the displayed amount text within the role guide.
+    /// </summary>
+    public virtual bool ShowRoleAsUnique => Configuration.MaxRoleCount == 1;
+
+    /// <summary>
+    /// Gets the displayed amount and chance of the role. Used in the role guide.
+    /// By default, 0 amount or chance results in a complete 0 amount and chance, so override if necessary.
+    /// </summary>
+    /// <param name="amount">The amount of the role.</param>
+    /// <param name="chance">The chance of the role.</param>
+    /// <param name="source">The mod source of the role.</param>
+    /// <returns>The <see cref="string"/> result.</returns>
+    public virtual string GetAmountText(int amount, int chance, string source)
+    {
+        if (amount == 0)
+        {
+            chance = 0;
+        }
+
+        if (ShowRoleAsUnique)
+        {
+            return string.Format(
+                CultureInfo.InvariantCulture,
+                "{0}% ({1})",
+                chance.ToString(CultureInfo.InvariantCulture),
+                source);
+        }
+
+        if (chance == 0)
+        {
+            amount = 0;
+        }
+
+        return string.Format(
+            CultureInfo.InvariantCulture,
+            "{0} at {1}% ({2})",
+            amount.ToString(CultureInfo.InvariantCulture),
+            chance.ToString(CultureInfo.InvariantCulture),
+            source);
+    }
+
     /// <summary>
     /// Gets the <see cref="Color"/> of the role.
     /// </summary>

MiraAPI/Translation/MiraLocaleManager.cs

@@ -72,6 +72,7 @@ public static class MiraLocaleManager
     /// </summary>
     public static Dictionary<MiraLanguage, string> LangCultureList { get; } = new()
     {
+        // Vanilla
         { MiraLanguage.English, "en-US" },
         { MiraLanguage.Latam, "es-419" },
         { MiraLanguage.Brazilian, "pt-BR" },
@@ -88,15 +89,17 @@ public static class MiraLocaleManager
         { MiraLanguage.SChinese, "zh-CN" },
         { MiraLanguage.TChinese, "zh-TW" },
         { MiraLanguage.Irish, "ga-IE" },
-        { MiraLanguage.Polish, "pl-PL" }, // Custom
-        { MiraLanguage.Turkish, "tr-TR" }, // Custom
-        { MiraLanguage.Swedish, "sv-SE" }, // Custom
-        { MiraLanguage.Lithuanian, "lt-LT" }, // Custom
-        { MiraLanguage.Czech, "cs-CZ" }, // Custom
-        { MiraLanguage.LChinese, "lzh-CN" }, // Custom
-        { MiraLanguage.Greek, "el-GR" }, // Custom
-        { MiraLanguage.Arabic, "arb" }, // Custom
-        { MiraLanguage.Hebrew, "heb" }, // Custom
+
+        // Custom
+        { MiraLanguage.Polish, "pl-PL" },
+        { MiraLanguage.Turkish, "tr-TR" },
+        { MiraLanguage.Swedish, "sv-SE" },
+        { MiraLanguage.Lithuanian, "lt-LT" },
+        { MiraLanguage.Czech, "cs-CZ" },
+        { MiraLanguage.LChinese, "lzh-CN" },
+        { MiraLanguage.Greek, "el-GR" },
+        { MiraLanguage.Arabic, "arb" },
+        { MiraLanguage.Hebrew, "heb" },
     };
 
     /// <summary>
@@ -123,26 +126,49 @@ public static class MiraLocaleManager
     /// Call once per mod during plugin Load().
     /// </summary>
     /// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
+    [Obsolete("Pass typeof(YourPlugin).Assembly directly to Register for better performance.")]
     public static void Register(string modGuid)
     {
         var callingAssembly = Assembly.GetCallingAssembly();
-
         LoadInternalStrings(callingAssembly, callingAssembly.GetName().Name!, modGuid);
     }
 
+    /// <summary>
+    /// Registers translations for a mod.
+    /// Call once per mod during plugin Load().
+    /// </summary>
+    /// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
+    /// <param name="assembly">The <see cref="Assembly"/> to load the strings from.</param>
+    public static void Register(string modGuid, Assembly assembly)
+    {
+        LoadInternalStrings(assembly, assembly.GetName().Name!, modGuid);
+    }
+
     /// <summary>
     /// Registers translations for a mod.
     /// Call once per mod during plugin Load().
     /// </summary>
     /// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
     /// <param name="internalName">The mod's root namespace (e.g., "mira.api").</param>
+    [Obsolete("Pass typeof(YourPlugin).Assembly directly to Register for better performance.")]
     public static void Register(string modGuid, string internalName)
     {
         var callingAssembly = Assembly.GetCallingAssembly();
-
         LoadInternalStrings(callingAssembly, internalName, modGuid);
     }
 
+    /// <summary>
+    /// Registers translations for a mod.
+    /// Call once per mod during plugin Load().
+    /// </summary>
+    /// <param name="modGuid">The mod GUID (e.g., "mira.example").</param>
+    /// <param name="internalName">The mod's root namespace (e.g., "mira.api").</param>
+    /// <param name="assembly">The <see cref="Assembly"/> to load the strings from.</param>
+    public static void Register(string modGuid, string internalName, Assembly assembly)
+    {
+        LoadInternalStrings(assembly, internalName, modGuid);
+    }
+
     /// <summary>
     /// Translates a key into the current language.
     /// </summary>

MiraAPI/Utilities/Assets/LoadableAudioResourceAsset.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Reflection;
 using UnityEngine;
 
@@ -6,17 +7,39 @@ namespace MiraAPI.Utilities.Assets;
 /// <summary>
 /// A utility class for loading .WAV audio assets from the DLL's embedded resources.
 /// </summary>
-/// <param name="path">The path of the wave file.</param>
-public class LoadableAudioResourceAsset(string path) : LoadableAsset<AudioClip>
+public class LoadableAudioResourceAsset : LoadableAsset<AudioClip>
 {
-    private readonly Assembly _assembly = Assembly.GetCallingAssembly();
+    private readonly string _path;
+    private readonly Assembly _assembly;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="LoadableAudioResourceAsset"/> class with the provided resource path and the assembly containing the asset.
+    /// </summary>
+    /// <param name="path">The path of the wave file.</param>
+    /// <param name="assembly">The <see cref="Assembly"/> containing the asset.</param>
+    public LoadableAudioResourceAsset(string path, Assembly assembly)
+    {
+        _path = path;
+        _assembly = assembly;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="LoadableAudioResourceAsset"/> class with the provided resource path.
+    /// </summary>
+    /// <param name="path">The path of the wave file.</param>
+    [Obsolete("Pass typeof(YourPlugin).Assembly directly to the constructor for better performance.")]
+    public LoadableAudioResourceAsset(string path)
+    {
+        _path = path;
+        _assembly = Assembly.GetCallingAssembly();
+    }
 
     /// <inheritdoc />
     public override AudioClip LoadAsset()
     {
         if (!LoadedAsset)
         {
-            LoadedAsset = AudioTools.LoadAudioFromResources(path, _assembly);
+            LoadedAsset = AudioTools.LoadAudioFromResources(_path, _assembly);
         }
 
         return LoadedAsset!;

MiraAPI/Utilities/Assets/LoadableResourceAsset.cs

@@ -1,4 +1,5 @@
-using System.Reflection;
+using System;
+using System.Reflection;
 using UnityEngine;
 
 namespace MiraAPI.Utilities.Assets;
@@ -6,18 +7,44 @@ namespace MiraAPI.Utilities.Assets;
 /// <summary>
 /// A utility class for loading assets from embedded resources.
 /// </summary>
-/// <param name="path">The path to the embedded resource.</param>
-/// <param name="pixelsPerUnit">The pixels per unit for the loaded sprite.</param>
-public class LoadableResourceAsset(string path, float pixelsPerUnit = 100f) : LoadableAsset<Sprite>
+public class LoadableResourceAsset : LoadableAsset<Sprite>
 {
-    private readonly Assembly _assembly = Assembly.GetCallingAssembly();
+    private readonly string _path;
+    private readonly float _pixelsPerUnit;
+    private readonly Assembly _assembly;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="LoadableResourceAsset"/> class with the provided resource path and the assembly containing the asset.
+    /// </summary>
+    /// <param name="path">The path to the embedded resource.</param>
+    /// <param name="assembly">The <see cref="Assembly"/> containing the asset.</param>
+    /// <param name="pixelsPerUnit">The pixels per unit for the loaded sprite.</param>
+    public LoadableResourceAsset(string path, Assembly assembly, float pixelsPerUnit = 100f)
+    {
+        _path = path;
+        _assembly = assembly;
+        _pixelsPerUnit = pixelsPerUnit;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="LoadableResourceAsset"/> class with the provided resource path and the assembly containing the asset.
+    /// </summary>
+    /// <param name="path">The path to the embedded resource.</param>
+    /// <param name="pixelsPerUnit">The pixels per unit for the loaded sprite.</param>
+    [Obsolete("Pass typeof(YourPlugin).Assembly directly to the constructor for better performance.")]
+    public LoadableResourceAsset(string path, float pixelsPerUnit = 100f)
+    {
+        _path = path;
+        _pixelsPerUnit = pixelsPerUnit;
+        _assembly = Assembly.GetCallingAssembly();
+    }
 
     /// <inheritdoc />
     public override Sprite LoadAsset()
     {
         if (!LoadedAsset)
         {
-            LoadedAsset = SpriteTools.LoadSpriteFromPath(path, _assembly, pixelsPerUnit);
+            LoadedAsset = SpriteTools.LoadSpriteFromPath(_path, _assembly, _pixelsPerUnit);
         }
 
         return LoadedAsset!;

MiraAPI/Utilities/Assets/MiraAssets.cs

@@ -1,4 +1,5 @@
-using Reactor.Utilities;
+using System.Reflection;
+using Reactor.Utilities;
 using UnityEngine;
 
 namespace MiraAPI.Utilities.Assets;
@@ -8,11 +9,13 @@ namespace MiraAPI.Utilities.Assets;
 /// </summary>
 public static class MiraAssets
 {
+    private static readonly Assembly _assembly = typeof(MiraAssets).Assembly;
+
     static MiraAssets()
     {
         var boxTex = SpriteTools.LoadTextureFromResourcePath(
             "MiraAPI.Resources.RoundedBox.png",
-            System.Reflection.Assembly.GetExecutingAssembly());
+            _assembly);
         var boxSprite = Sprite.Create(
             boxTex,
             new Rect(0, 0, boxTex.width, boxTex.height),
@@ -58,7 +61,7 @@ public static class MiraAssets
     /// <summary>
     /// Gets the empty <see cref="Sprite"/> asset.
     /// </summary>
-    public static LoadableResourceAsset Empty { get; } = new("MiraAPI.Resources.Empty.png");
+    public static LoadableResourceAsset Empty { get; } = new("MiraAPI.Resources.Empty.png", _assembly);
 
     /// <summary>
     /// Gets the RoundedBox <see cref="Sprite"/>, which is a rounded rectangle used for UI elements.
@@ -68,312 +71,312 @@ public static class MiraAssets
     /// <summary>
     /// Gets the Next Button sprite.
     /// </summary>
-    public static LoadableResourceAsset NextButton { get; } = new("MiraAPI.Resources.NextButton.png");
+    public static LoadableResourceAsset NextButton { get; } = new("MiraAPI.Resources.NextButton.png", _assembly);
 
     /// <summary>
     /// Gets the Mira settings icon.
     /// </summary>
-    public static LoadableResourceAsset SettingsIcon { get; } = new("MiraAPI.Resources.Settings.png");
+    public static LoadableResourceAsset SettingsIcon { get; } = new("MiraAPI.Resources.Settings.png", _assembly);
 
     /// <summary>
     /// Gets the highlighted Next Button sprite.
     /// </summary>
-    public static LoadableResourceAsset NextButtonActive { get; } = new("MiraAPI.Resources.NextButtonActive.png");
+    public static LoadableResourceAsset NextButtonActive { get; } = new("MiraAPI.Resources.NextButtonActive.png", _assembly);
 
     /// <summary>
     /// Gets the Cog icon used in Role Settings Menu.
     /// </summary>
-    public static LoadableResourceAsset Cog { get; } = new("MiraAPI.Resources.Cog.png");
+    public static LoadableResourceAsset Cog { get; } = new("MiraAPI.Resources.Cog.png", _assembly);
 
     /// <summary>
     /// Gets the Checkmark Box used in the Settings Menu.
     /// </summary>
-    public static LoadableResourceAsset CheckmarkBox { get; } = new("MiraAPI.Resources.CheckMarkBox.png");
+    public static LoadableResourceAsset CheckmarkBox { get; } = new("MiraAPI.Resources.CheckMarkBox.png", _assembly);
 
     /// <summary>
     /// Gets the Reset Box used in the Settings Menu.
     /// </summary>
-    public static LoadableResourceAsset ResetButton { get; } = new("MiraAPI.Resources.ResetButton.png");
+    public static LoadableResourceAsset ResetButton { get; } = new("MiraAPI.Resources.ResetButton.png", _assembly);
 
     /// <summary>
     /// Gets the Checkmark used in the Settings Menu.
     /// </summary>
-    public static LoadableResourceAsset Checkmark { get; } = new("MiraAPI.Resources.Checkmark.png");
+    public static LoadableResourceAsset Checkmark { get; } = new("MiraAPI.Resources.Checkmark.png", _assembly);
 
     /// <summary>
     /// Gets the white CategoryHeader used in the Settings Menu.
     /// </summary>
-    public static LoadableResourceAsset CategoryHeader { get; } = new("MiraAPI.Resources.CategoryHeader.png");
+    public static LoadableResourceAsset CategoryHeader { get; } = new("MiraAPI.Resources.CategoryHeader.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the Keybind icons.
     /// </summary>
-    public static LoadableResourceAsset KeybindButton { get; } = new("MiraAPI.Resources.KeybindButton.png");
+    public static LoadableResourceAsset KeybindButton { get; } = new("MiraAPI.Resources.KeybindButton.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for crewmate role files in TaskAdderGame.
     /// </summary>
-    public static LoadableResourceAsset CrewmateFile { get; } = new("MiraAPI.Resources.CrewmateFile.png");
+    public static LoadableResourceAsset CrewmateFile { get; } = new("MiraAPI.Resources.CrewmateFile.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for impostor role files in TaskAdderGame.
     /// </summary>
-    public static LoadableResourceAsset ImpostorFile { get; } = new("MiraAPI.Resources.ImpostorFile.png");
+    public static LoadableResourceAsset ImpostorFile { get; } = new("MiraAPI.Resources.ImpostorFile.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for custom team role files in TaskAdderGame.
     /// </summary>
-    public static LoadableResourceAsset CustomTeamFile { get; } = new("MiraAPI.Resources.CustomFile.png");
+    public static LoadableResourceAsset CustomTeamFile { get; } = new("MiraAPI.Resources.CustomFile.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for modifier file in TaskAdderGame.
     /// </summary>
-    public static LoadableResourceAsset ModifierFile { get; } = new("MiraAPI.Resources.ModifierFile.png");
+    public static LoadableResourceAsset ModifierFile { get; } = new("MiraAPI.Resources.ModifierFile.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the Classic gamemode.
     /// </summary>
-    public static LoadableResourceAsset ClassicGamemodeIcon { get; } = new("MiraAPI.Resources.ClassicGamemodeIcon.png");
+    public static LoadableResourceAsset ClassicGamemodeIcon { get; } = new("MiraAPI.Resources.ClassicGamemodeIcon.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the Hide n Seek gamemode.
     /// </summary>
-    public static LoadableResourceAsset HnSGamemodeIcon { get; } = new("MiraAPI.Resources.HnSGamemodeIcon.png");
+    public static LoadableResourceAsset HnSGamemodeIcon { get; } = new("MiraAPI.Resources.HnSGamemodeIcon.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for timed modifier file in TaskAdderGame.
     /// </summary>
-    public static LoadableResourceAsset TimedModifierFile { get; } = new("MiraAPI.Resources.TimedModifierFile.png");
+    public static LoadableResourceAsset TimedModifierFile { get; } = new("MiraAPI.Resources.TimedModifierFile.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the new chat button while hovering.
     /// </summary>
-    public static LoadableResourceAsset ChatHoverSprite { get; } = new("MiraAPI.Resources.NormalChatHover.png");
+    public static LoadableResourceAsset ChatHoverSprite { get; } = new("MiraAPI.Resources.NormalChatHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the new chat button while hovering.
     /// </summary>
-    public static LoadableResourceAsset ChatIdleSprite { get; } = new("MiraAPI.Resources.NormalChatIdle.png");
+    public static LoadableResourceAsset ChatIdleSprite { get; } = new("MiraAPI.Resources.NormalChatIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the new chat button while hovering.
     /// </summary>
-    public static LoadableResourceAsset ChatOpenSprite { get; } = new("MiraAPI.Resources.NormalChatOpen.png");
+    public static LoadableResourceAsset ChatOpenSprite { get; } = new("MiraAPI.Resources.NormalChatOpen.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for players button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiPlayersButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarPlayersButtonHover.png");
+    public static LoadableResourceAsset WikiPlayersButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarPlayersButtonHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the players button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiPlayersButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarPlayersButtonIdle.png");
+    public static LoadableResourceAsset WikiPlayersButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarPlayersButtonIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the players button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiPlayersButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarPlayersButtonOpen.png");
+    public static LoadableResourceAsset WikiPlayersButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarPlayersButtonOpen.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the settings button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiSettingsButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarSettingsButtonHover.png");
+    public static LoadableResourceAsset WikiSettingsButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarSettingsButtonHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the settings button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiSettingsButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarSettingsButtonIdle.png");
+    public static LoadableResourceAsset WikiSettingsButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarSettingsButtonIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the settings button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiSettingsButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarSettingsButtonOpen.png");
+    public static LoadableResourceAsset WikiSettingsButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarSettingsButtonOpen.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiRolesButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarRolesButtonHover.png");
+    public static LoadableResourceAsset WikiRolesButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarRolesButtonHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiRolesButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarRolesButtonIdle.png");
+    public static LoadableResourceAsset WikiRolesButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarRolesButtonIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiRolesButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarRolesButtonOpen.png");
+    public static LoadableResourceAsset WikiRolesButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarRolesButtonOpen.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the modifiers button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiModifiersButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarModifiersButtonHover.png");
+    public static LoadableResourceAsset WikiModifiersButtonHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarModifiersButtonHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the modifiers button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiModifiersButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarModifiersButtonIdle.png");
+    public static LoadableResourceAsset WikiModifiersButtonIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarModifiersButtonIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the modifiers button while hovering.
     /// </summary>
-    public static LoadableResourceAsset WikiModifiersButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarModifiersButtonOpen.png");
+    public static LoadableResourceAsset WikiModifiersButtonOpenSprite { get; } = new("MiraAPI.Resources.Wiki.SidebarModifiersButtonOpen.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset GroupCountHoverSprite { get; } = new("MiraAPI.Resources.Wiki.GroupCountHover.png");
+    public static LoadableResourceAsset GroupCountHoverSprite { get; } = new("MiraAPI.Resources.Wiki.GroupCountHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset GroupCountIdleSprite { get; } = new("MiraAPI.Resources.Wiki.GroupCountIdle.png");
+    public static LoadableResourceAsset GroupCountIdleSprite { get; } = new("MiraAPI.Resources.Wiki.GroupCountIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset GroupFactionHoverSprite { get; } = new("MiraAPI.Resources.Wiki.GroupFactionHover.png");
+    public static LoadableResourceAsset GroupFactionHoverSprite { get; } = new("MiraAPI.Resources.Wiki.GroupFactionHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset GroupFactionIdleSprite { get; } = new("MiraAPI.Resources.Wiki.GroupFactionIdle.png");
+    public static LoadableResourceAsset GroupFactionIdleSprite { get; } = new("MiraAPI.Resources.Wiki.GroupFactionIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset GroupNoneHoverSprite { get; } = new("MiraAPI.Resources.Wiki.GroupNoneHover.png");
+    public static LoadableResourceAsset GroupNoneHoverSprite { get; } = new("MiraAPI.Resources.Wiki.GroupNoneHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset GroupNoneIdleSprite { get; } = new("MiraAPI.Resources.Wiki.GroupNoneIdle.png");
+    public static LoadableResourceAsset GroupNoneIdleSprite { get; } = new("MiraAPI.Resources.Wiki.GroupNoneIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SearchClearHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SearchClearHover.png");
+    public static LoadableResourceAsset SearchClearHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SearchClearHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SearchClearIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SearchClearIdle.png");
+    public static LoadableResourceAsset SearchClearIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SearchClearIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SearchIconHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SearchIconHover.png");
+    public static LoadableResourceAsset SearchIconHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SearchIconHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SearchIconIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SearchIconIdle.png");
+    public static LoadableResourceAsset SearchIconIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SearchIconIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SortingAzHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SortingAzHover.png");
+    public static LoadableResourceAsset SortingAzHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SortingAzHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SortingAzIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SortingAzIdle.png");
+    public static LoadableResourceAsset SortingAzIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SortingAzIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SortingZaHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SortingZaHover.png");
+    public static LoadableResourceAsset SortingZaHoverSprite { get; } = new("MiraAPI.Resources.Wiki.SortingZaHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset SortingZaIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SortingZaIdle.png");
+    public static LoadableResourceAsset SortingZaIdleSprite { get; } = new("MiraAPI.Resources.Wiki.SortingZaIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset VisibleAllHoverSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleAllHover.png");
+    public static LoadableResourceAsset VisibleAllHoverSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleAllHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset VisibleAllIdleSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleAllIdle.png");
+    public static LoadableResourceAsset VisibleAllIdleSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleAllIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset VisibleOffHoverSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOffHover.png");
+    public static LoadableResourceAsset VisibleOffHoverSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOffHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset VisibleOffIdleSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOffIdle.png");
+    public static LoadableResourceAsset VisibleOffIdleSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOffIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset VisibleOnHoverSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOnHover.png");
+    public static LoadableResourceAsset VisibleOnHoverSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOnHover.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the roles button while hovering.
     /// </summary>
-    public static LoadableResourceAsset VisibleOnIdleSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOnIdle.png");
+    public static LoadableResourceAsset VisibleOnIdleSprite { get; } = new("MiraAPI.Resources.Wiki.VisibleOnIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for crewmates.
     /// </summary>
-    public static LoadableResourceAsset IconCrewmate { get; } = new("MiraAPI.Resources.Wiki.IconCrewmate.png");
+    public static LoadableResourceAsset IconCrewmate { get; } = new("MiraAPI.Resources.Wiki.IconCrewmate.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for impostors.
     /// </summary>
-    public static LoadableResourceAsset IconImpostor { get; } = new("MiraAPI.Resources.Wiki.IconImpostor.png");
+    public static LoadableResourceAsset IconImpostor { get; } = new("MiraAPI.Resources.Wiki.IconImpostor.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for neutrals.
     /// </summary>
-    public static LoadableResourceAsset IconNeutral { get; } = new("MiraAPI.Resources.Wiki.IconNeutral.png");
+    public static LoadableResourceAsset IconNeutral { get; } = new("MiraAPI.Resources.Wiki.IconNeutral.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for the player list.
     /// </summary>
-    public static LoadableResourceAsset IconPlayerList { get; } = new("MiraAPI.Resources.Wiki.IconPlayerList.png");
+    public static LoadableResourceAsset IconPlayerList { get; } = new("MiraAPI.Resources.Wiki.IconPlayerList.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for settings.
     /// </summary>
-    public static LoadableResourceAsset IconSettings { get; } = new("MiraAPI.Resources.Wiki.IconSettings.png");
+    public static LoadableResourceAsset IconSettings { get; } = new("MiraAPI.Resources.Wiki.IconSettings.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used for terminology.
     /// </summary>
-    public static LoadableResourceAsset IconTerminology { get; } = new("MiraAPI.Resources.Wiki.IconTerminology.png");
+    public static LoadableResourceAsset IconTerminology { get; } = new("MiraAPI.Resources.Wiki.IconTerminology.png", _assembly);
 
     /// <summary>
     /// Gets the Page switching sprite.
     /// </summary>
-    public static LoadableResourceAsset PageLeftHover { get; } = new("MiraAPI.Resources.Wiki.PageLeftHover.png");
+    public static LoadableResourceAsset PageLeftHover { get; } = new("MiraAPI.Resources.Wiki.PageLeftHover.png", _assembly);
 
     /// <summary>
     /// Gets the Page switching sprite.
     /// </summary>
-    public static LoadableResourceAsset PageLeftIdle { get; } = new("MiraAPI.Resources.Wiki.PageLeftIdle.png");
+    public static LoadableResourceAsset PageLeftIdle { get; } = new("MiraAPI.Resources.Wiki.PageLeftIdle.png", _assembly);
 
     /// <summary>
     /// Gets the Page switching sprite.
     /// </summary>
-    public static LoadableResourceAsset PageRightHover { get; } = new("MiraAPI.Resources.Wiki.PageRightHover.png");
+    public static LoadableResourceAsset PageRightHover { get; } = new("MiraAPI.Resources.Wiki.PageRightHover.png", _assembly);
 
     /// <summary>
     /// Gets the Page switching sprite.
     /// </summary>
-    public static LoadableResourceAsset PageRightIdle { get; } = new("MiraAPI.Resources.Wiki.PageRightIdle.png");
+    public static LoadableResourceAsset PageRightIdle { get; } = new("MiraAPI.Resources.Wiki.PageRightIdle.png", _assembly);
 
     /// <summary>
     /// Gets the sprite used below the tab icons in the wiki.
     /// </summary>
-    public static LoadableResourceAsset TabButtonContainer { get; } = new("MiraAPI.Resources.Wiki.TabButtonContainer.png");
+    public static LoadableResourceAsset TabButtonContainer { get; } = new("MiraAPI.Resources.Wiki.TabButtonContainer.png", _assembly);
 
-    internal static LoadableResourceAsset BlankSprite { get; } = new("MiraAPI.Resources.BlankSprite.png");
+    internal static LoadableResourceAsset BlankSprite { get; } = new("MiraAPI.Resources.BlankSprite.png", _assembly);
 }

MiraAPI/Utilities/BasicGuideComparer.cs

@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace MiraAPI.Utilities;
+
+/// <summary>
+/// A comparer used to sort role/modifier IDs based on which ones are currently active.
+/// </summary>
+/// <param name="activeIds">The collection of currently active IDs.</param>
+public class BasicGuideComparer(IEnumerable<uint> activeIds) : IComparer<uint>
+{
+    /// <inheritdoc/>
+    public int Compare(uint x, uint y)
+    {
+        var xActive = activeIds.Contains(x);
+        var yActive = activeIds.Contains(y);
+
+        if (xActive && !yActive)
+        {
+            return -1;
+        }
+
+        if (!xActive && yActive)
+        {
+            return 1;
+        }
+
+        return 0;
+    }
+}

MiraAPI/Utilities/Extensions.cs

@@ -492,16 +492,29 @@ public static class Extensions
     }
 
     /// <summary>
-    /// Gets a proper string for an <see cref="Enum"/>. (with spaces).
+    /// Gets a proper string for an <see cref="Enum"/> (with spaces).
     /// </summary>
     /// <param name="enum">The <see cref="Enum"/> you would like to change.</param>
-    /// <returns>A proper string for the <see cref="Enum"/>.</returns>
+    /// <returns>A proper string for the provided <see cref="Enum"/>.</returns>
     public static string ToDisplayString(this Enum @enum)
     {
         var regex = new Regex(@"([^\^])([A-Z][a-z$])", default, Regex.InfiniteMatchTimeout);
         return regex.Replace(@enum.ToString(), m => $"{m.Groups[1].Value} {m.Groups[2].Value}");
     }
 
+    /// <summary>
+    /// Gets a proper string for a(n) <typeparamref name="T"/> value (with spaces).
+    /// </summary>
+    /// <typeparam name="T">The type of the enum value.</typeparam>
+    /// <param name="enum">The <typeparamref name="T"/> enum value you would like to change.</param>
+    /// <returns>A proper string for the provided <typeparamref name="T"/> value.</returns>
+    public static string ToDisplayString<T>(this T @enum)
+        where T : struct, Enum
+    {
+        var regex = new Regex(@"([^\^])([A-Z][a-z$])", default, Regex.InfiniteMatchTimeout);
+        return regex.Replace(@enum.ToString(), m => $"{m.Groups[1].Value} {m.Groups[2].Value}");
+    }
+
     /// <summary>
     /// Gets the constructors of a type that match the specified arguments.
     /// </summary>