wip translation id builder

Clean project

.editorconfig

@@ -1 +1,88 @@
-[*.{cs,vb}]
+[*.{cs,vb}]
+
+# IDE0008: Use explicit type
+dotnet_diagnostic.IDE0008.severity = none
+
+# IDE0160: Convert to block scoped namespace
+dotnet_diagnostic.IDE0160.severity = none
+
+# IDE0011: Add braces
+dotnet_diagnostic.IDE0011.severity = none
+
+# CS8618: Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+dotnet_diagnostic.CS8618.severity = none
+
+# CA1805: Do not initialize unnecessarily
+dotnet_diagnostic.CA1805.severity = none
+
+# S3358: Ternary operators should not be nested
+dotnet_diagnostic.S3358.severity = none
+
+# IDE1006: Naming Styles
+dotnet_diagnostic.IDE1006.severity = none
+
+# S3267: Use LINQ methods to simply foreach loops
+dotnet_diagnostic.S3267.severity = none
+
+# S125: Sections of code should not be commented out
+dotnet_diagnostic.S125.severity = none
+
+# SA1512: Single-line comments should not be followed by blank line
+dotnet_diagnostic.SA1512.severity = none
+
+# S2696: Instance members should not write to "static" fields
+dotnet_diagnostic.S2696.severity = none
+
+# S2245: Pseudorandom number generators (PRNGs) should not be used in security contexts
+dotnet_diagnostic.S2245.severity = none
+
+# IDE0130: Namespace does not match folder structure
+dotnet_diagnostic.IDE0130.severity = none
+
+# SA1633: File should have header
+dotnet_diagnostic.SA1633.severity = none
+
+# SA1101: Prefix local calls with this
+dotnet_diagnostic.SA1101.severity = none
+
+# SA1600: Elements should be documented
+dotnet_diagnostic.SA1600.severity = none
+
+# SA1516: Elements should be separated by blank line
+dotnet_diagnostic.SA1516.severity = none
+
+# SA1503: Braces should not be omitted
+dotnet_diagnostic.SA1503.severity = none
+
+# SA1201: Elements should appear in the correct order
+dotnet_diagnostic.SA1201.severity = none
+
+# SA1402: File may only contain a single type
+dotnet_diagnostic.SA1402.severity = none
+
+# SA1204: Static elements should appear before instance elements
+dotnet_diagnostic.SA1204.severity = none
+
+# SA1202: Elements should be ordered by access
+dotnet_diagnostic.SA1202.severity = none
+
+# SA1649: File name should match first type name
+dotnet_diagnostic.SA1649.severity = none
+
+# SA1313: Parameter names should begin with lower-case letter
+dotnet_diagnostic.SA1313.severity = none
+
+# SA1636: The file header copyright text should match the copyright text from the settings
+dotnet_diagnostic.SA1636.severity = none
+
+# SA1309: Field names should not begin with underscore
+dotnet_diagnostic.SA1309.severity = none
+
+# SA1407: Arithmetic expressions should declare precedence
+dotnet_diagnostic.SA1407.severity = none
+
+# SA1133: Each attribute should be placed in its own set of square brackets
+dotnet_diagnostic.SA1133.severity = none
+
+# IDE0001: Simplify Names
+dotnet_diagnostic.IDE0001.severity = warning

.gitignore

@@ -1,9 +1,9 @@
 .git/
 .idea/
-.vs/
+.vs*/
 obj/
 bin/
 .qodo/
 
 *.user
-*.lock.json
+*.lock.json

AmongUs.props

@@ -1,8 +1,8 @@
 <Project>
     <ItemGroup>
-        <PackageReference Include="Reactor" Version="2.3.1" />
+        <PackageReference Include="Reactor" Version="2.5.0-ci.371" />
         <PackageReference Include="BepInEx.Unity.IL2CPP" Version="6.0.0-be.735" Private="false" ExcludeAssets="runtime;native" />
-        <PackageReference Include="AmongUs.GameLibs.Steam" Version="2025.10.14" PrivateAssets="all" />
+        <PackageReference Include="AmongUs.GameLibs.Steam" Version="2026.8.18" PrivateAssets="all" />
 
         <PackageReference Include="BepInEx.AutoPlugin" Version="1.1.0" PrivateAssets="all" />
         <PackageReference Include="BepInEx.IL2CPP.MSBuild" Version="2.1.0-rc.1" PrivateAssets="all" ExcludeAssets="runtime" />
@@ -11,4 +11,4 @@
     <Target Name="Copy" AfterTargets="Build" Condition="'$(AmongUs)' != ''">
         <Copy SourceFiles="$(TargetPath)" DestinationFolder="$(AmongUs)/BepInEx/plugins/" UseSymboliclinksIfPossible="true" />
     </Target>
-</Project>
+</Project>

Directory.Build.props

@@ -8,7 +8,7 @@
 
         <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
 
-        <VersionPrefix>0.3.8</VersionPrefix>
+        <VersionPrefix>0.5.0</VersionPrefix>
         <VersionSuffix>dev</VersionSuffix>
 
         <Authors>All Of Us, XtraCube, Angxl</Authors>
@@ -28,18 +28,15 @@
         <AnalysisLevel>latest</AnalysisLevel>
         <AnalysisMode>recommended</AnalysisMode>
         <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+		<NoWarn>$(NoWarn);SA0001</NoWarn>
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="Roslynator.Analyzers" Version="5.0.0" PrivateAssets="all" />
+        <PackageReference Include="Roslynator.Formatting.Analyzers" Version="5.0.0" PrivateAssets="all" />
+        <PackageReference Include="Roslynator.CodeAnalysis.Analyzers" Version="5.0.0" PrivateAssets="all" />
+        <PackageReference Include="SonarAnalyzer.CSharp" Version="10.32.0.713" PrivateAssets="all" />
         <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="all" />
-        <AdditionalFiles Include="$(MSBuildThisFileDirectory)\stylecop.json" Link="stylecop.json" Visible="false" />
-
-        <PackageReference Include="SonarAnalyzer.CSharp" Version="10.7.0.110445">
-            <PrivateAssets>all</PrivateAssets>
-            <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
-        </PackageReference>
+        <AdditionalFiles Include="$(MSBuildThisFileDirectory)/stylecop.json" Link="stylecop.json" Visible="false" />
     </ItemGroup>
-    <PropertyGroup>
-        <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)\stylecop.ruleset</CodeAnalysisRuleSet>
-    </PropertyGroup>
 </Project>

ExternalAnnotations/0Harmony.xml

@@ -0,0 +1,29 @@
+<assembly name="0Harmony">
+  <member name="T:HarmonyLib.HarmonyPatch">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor(JetBrains.Annotations.ImplicitUseTargetFlags)">
+      <argument>3</argument>
+    </attribute>
+  </member>
+
+  <member name="T:HarmonyLib.HarmonyPrefix">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+  <member name="T:HarmonyLib.HarmonyPostfix">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+  <member name="T:HarmonyLib.HarmonyTranspiler">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+  <member name="T:HarmonyLib.HarmonyFinalizer">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+  <member name="T:HarmonyLib.HarmonyPrepare">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+  <member name="T:HarmonyLib.HarmonyTargetMethod">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+  <member name="T:HarmonyLib.HarmonyTargetMethods">
+    <attribute ctor="M:JetBrains.Annotations.MeansImplicitUseAttribute.#ctor" />
+  </member>
+</assembly>

MiraAPI.Example/Buttons/Freezer/FreezeButton.cs

@@ -13,7 +13,7 @@ namespace MiraAPI.Example.Buttons.Freezer;
 
 public class FreezeButton : CustomActionButton<PlayerControl>
 {
-    public override string Name => "Freeze";
+    public override string Name => "button.freeze";
 
     public override float Cooldown => OptionGroupSingleton<FreezerRoleSettings>.Instance.FreezeDuration;
     public override bool PauseTimerInVent => true;

MiraAPI.Example/Buttons/MeetingButton.cs

@@ -9,10 +9,8 @@ namespace MiraAPI.Example.Buttons;
 
 public class MeetingButton : CustomActionButton
 {
-    public override string Name => "Call Meeting";
-
+    public override string Name => "button.callMeeting";
     public override float Cooldown => 15;
-
     public override int MaxUses => 3;
 
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
@@ -30,10 +28,10 @@ public class MeetingButton : CustomActionButton
         PlayerControl.LocalPlayer.NetTransform.Halt();
         var minigame = Object.Instantiate(bt.MinigamePrefab, Camera.main!.transform, false);
 
-        var taskAdderGame = minigame as TaskAdderGame;
-        if (taskAdderGame != null)
+        var taskAdderGame = minigame.TryCast<TaskAdderGame>();
+        if (taskAdderGame)
         {
-            taskAdderGame.SafePositionWorld = bt.SafePositionLocal + (Vector2)bt.transform.position;
+            taskAdderGame!.SafePositionWorld = bt.SafePositionLocal + (Vector2)bt.transform.position;
         }
 
         minigame.transform.localPosition = new Vector3(0f, 0f, -50f);

MiraAPI.Example/Buttons/NeutralKillerButton.cs

@@ -10,7 +10,7 @@ namespace MiraAPI.Example.Buttons;
 
 public class NeutralKillerButton : CustomActionButton
 {
-    public override string Name => "Win Game";
+    public override string Name => "button.winGame";
     public override float Cooldown => 0f;
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
     public override MiraKeybind Keybind => ExampleKeybinds.NeutralWinKeybind;

MiraAPI.Example/Buttons/Teleporter/TeleportButton.cs

@@ -12,7 +12,7 @@ namespace MiraAPI.Example.Buttons.Teleporter;
 
 public class TeleportButton : CustomActionButton
 {
-    public override string Name => "Teleport";
+    public override string Name => "button.teleport";
 
     public override float Cooldown => OptionGroupSingleton<TeleporterOptions>.Instance.TeleportCooldown.Value;
 
@@ -61,11 +61,14 @@ public class TeleportButton : CustomActionButton
         {
             Camera.main.orthographicSize = MeetingHud.Instance ? 3f : ft;
             ResolutionManager.ResolutionChanged.Invoke((float)Screen.width / Screen.height, Screen.width, Screen.height, Screen.fullScreen);
-            foreach (var cam in Camera.allCameras) cam.orthographicSize = Camera.main.orthographicSize;
+            foreach (var cam in Camera.allCameras)
+                cam.orthographicSize = Camera.main.orthographicSize;
+
             yield return null;
         }
 
-        foreach (var cam in Camera.allCameras) cam.orthographicSize = zoomDistance;
+        foreach (var cam in Camera.allCameras)
+            cam.orthographicSize = zoomDistance;
         ResolutionManager.ResolutionChanged.Invoke((float)Screen.width / Screen.height, Screen.width, Screen.height, Screen.fullScreen);
     }
 
@@ -75,12 +78,14 @@ public class TeleportButton : CustomActionButton
         {
             Camera.main.orthographicSize = MeetingHud.Instance ? 3f : ft;
             ResolutionManager.ResolutionChanged.Invoke((float)Screen.width / Screen.height, Screen.width, Screen.height, Screen.fullScreen);
-            foreach (var cam in Camera.allCameras) cam.orthographicSize = Camera.main.orthographicSize;
+            foreach (var cam in Camera.allCameras)
+                cam.orthographicSize = Camera.main.orthographicSize;
 
             yield return null;
         }
 
-        foreach (var cam in Camera.allCameras) cam.orthographicSize = 3f;
+        foreach (var cam in Camera.allCameras)
+            cam.orthographicSize = 3f;
         HudManager.Instance.ShadowQuad.gameObject.SetActive(true);
         IsZoom = false;
 

MiraAPI.Example/Buttons/ThinkButton.cs

@@ -1,4 +1,5 @@
 using MiraAPI.Hud;
+using MiraAPI.Translation;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
@@ -6,7 +7,7 @@ namespace MiraAPI.Example.Buttons;
 
 public class ThinkButton : CustomActionButton
 {
-    public override string Name => "Think";
+    public override string Name => "button.think";
     public override float Cooldown => 15f;
     public override float EffectDuration => 10f;
     public override int MaxUses => 1;
@@ -14,13 +15,12 @@ public class ThinkButton : CustomActionButton
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
     protected override void OnClick()
     {
-        // This button does absolutely nothing besides changing its text
-        Button!.OverrideText("Thinking...");
+        Button!.OverrideText("button.think.thinking".Translate());
     }
 
     public override void OnEffectEnd()
     {
-        Button!.OverrideText("Think");
+        Button!.OverrideText("button.think".Translate());
     }
 
     public override bool IsEffectCancellable()

MiraAPI.Example/ExampleAssets.cs

@@ -9,5 +9,6 @@ public static class ExampleAssets
 
     // 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");
 }

MiraAPI.Example/ExampleColors.cs

@@ -6,12 +6,12 @@ namespace MiraAPI.Example;
 [RegisterCustomColors]
 public static class ExampleColors
 {
-    public static CustomColor Cerulean { get; } = new("Cerulean", new Color(0.0f, 0.48f, 0.65f))
+    public static CustomColor Cerulean { get; } = new("color.cerulean", new Color(0.0f, 0.48f, 0.65f))
     {
         ColorBrightness = CustomColorBrightness.Lighter,
     };
 
-    public static CustomColor Rose { get; } = new("Rose", new Color(0.98f, 0.26f, 0.62f));
+    public static CustomColor Rose { get; } = new("color.rose", new Color(0.98f, 0.26f, 0.62f));
 
-    public static CustomColor Gold { get; } = new("Gold", new Color(1.0f, 0.84f, 0.0f));
+    public static CustomColor Gold { get; } = new("color.gold", new Color(1.0f, 0.84f, 0.0f));
 }

MiraAPI.Example/ExampleEventHandlers.cs

@@ -1,4 +1,5 @@
-using System.Globalization;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Linq;
 using MiraAPI.Events;
 using MiraAPI.Events.Mira;

MiraAPI.Example/ExampleLocalSetings.cs

@@ -8,7 +8,7 @@ namespace MiraAPI.Example;
 
 public class ExampleLocalSettings(ConfigFile config) : LocalSettingsTab(config)
 {
-    public override string TabName => "Mira Example";
+    public override string TabName => "settings.miraExample";
     protected override bool ShouldCreateLabels => false;
 
     public override LocalSettingTabAppearance TabAppearance => new()
@@ -18,7 +18,7 @@ public class ExampleLocalSettings(ConfigFile config) : LocalSettingsTab(config)
     };
 
     [LocalSettingsButton]
-    public LocalSettingsButton ExampleButton { get; private set; } = new("Example Button", OnExampleButtonClick);
+    public LocalSettingsButton ExampleButton { get; private set; } = new("settings.miraExample.button.exampleButton", OnExampleButtonClick);
 
     [LocalToggleSetting]
     public ConfigEntry<bool> ExampleToggle { get; private set; } = config.Bind("General", "Example Bool", true);
@@ -33,7 +33,7 @@ public class ExampleLocalSettings(ConfigFile config) : LocalSettingsTab(config)
     public ConfigEntry<float> ExampleNumber { get; private set; } = config.Bind("General", "Example Number", 4f);
 
     [LocalNumberSetting(min: 0.1f, max: 2.5f, increment: 0.1f, formatString: "0.0", suffixType: MiraNumberSuffixes.Multiplier)]
-    public ConfigEntry<float> ExampleFloatNumber { get; private set; } = config.Bind("General", "Example Multplier", 1f);
+    public ConfigEntry<float> ExampleFloatNumber { get; private set; } = config.Bind("General", "Example Multiplier", 1f);
 
     [LocalEnumSetting]
     public ConfigEntry<ExampleEnumSetting> ExampleEnum { get; private set; } = config.Bind("General", "Example Enum", ExampleEnumSetting.Fries);

MiraAPI.Example/ExamplePlugin.cs

@@ -1,9 +1,9 @@
-using System.Linq;
-using BepInEx;
+using BepInEx;
 using BepInEx.Configuration;
 using BepInEx.Unity.IL2CPP;
 using HarmonyLib;
 using MiraAPI.PluginLoading;
+using MiraAPI.Translation;
 using Reactor;
 using Reactor.Networking;
 using Reactor.Networking.Attributes;
@@ -17,9 +17,20 @@ namespace MiraAPI.Example;
 [ReactorModFlags(ModFlags.RequireOnAllClients)]
 public partial class ExamplePlugin : BasePlugin, IMiraPlugin
 {
+    public ExamplePlugin()
+    {
+        MiraLocaleManager.Register("mira.example");
+    }
+
     public Harmony Harmony { get; } = new(Id);
-    public string OptionsTitleText => "Mira API\nExample Mod";
-    public ConfigFile GetConfigFile() => Config;
+    public string OptionsTitleText { get; } = "Mira API\nExample Mod";
+    public string CustomOptionMenuNameTwo { get; } = "Example Options";
+
+    public ConfigFile GetConfigFile()
+    {
+        return Config;
+    }
+
     public override void Load()
     {
         ExampleEventHandlers.Initialize();

MiraAPI.Example/GameModes/ExampleMode.cs

@@ -0,0 +1,13 @@
+using MiraAPI.GameModes;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.GameModes;
+
+public class ExampleMode : AbstractGameMode
+{
+    public override string Name => "Example Mode";
+    public override string Description => "An example gamemode.";
+    public override LoadableAsset<Sprite>? Icon => ExampleAssets.ExampleButton;
+    public override Color Color => Color.red;
+}

MiraAPI.Example/GameOver/NeutralKillerGameOver.cs

@@ -1,5 +1,6 @@
 using MiraAPI.Example.Roles;
 using MiraAPI.GameEnd;
+using MiraAPI.Translation;
 using MiraAPI.Utilities;
 using UnityEngine;
 
@@ -14,7 +15,7 @@ public class NeutralKillerGameOver : CustomGameOver
 
     public override void AfterEndGameSetup(EndGameManager endGameManager)
     {
-        endGameManager.WinText.text = "Outcast Killer Wins!";
+        endGameManager.WinText.text = "gameover.outcastKiller.win".Translate();
         endGameManager.WinText.color = Color.magenta;
         endGameManager.BackgroundBar.material.SetColor(ShaderID.Color, Color.magenta);
     }

MiraAPI.Example/MeetingAbilities/EndMeetingButton.cs

@@ -0,0 +1,29 @@
+using MiraAPI.Example.Roles;
+using MiraAPI.MeetingAbilities;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.MeetingAbilities;
+
+public class EndMeetingButton : MeetingActionButton
+{
+    public override string Name => "End Meeting";
+
+    public override float Cooldown => 15;
+
+    public override float InitialCooldown => 30;
+
+    public override int MaxUses => 3;
+
+    public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
+
+    public override bool Enabled(RoleBehaviour? role)
+    {
+        return PlayerControl.LocalPlayer != null && role is MayorRole;
+    }
+
+    protected override void OnClick()
+    {
+        MeetingHud.Instance.RpcClose();
+    }
+}

MiraAPI.Example/MeetingAbilities/ShootButton.cs

@@ -0,0 +1,37 @@
+using MiraAPI.MeetingAbilities;
+using MiraAPI.Networking;
+using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.MeetingAbilities;
+
+public class ShootButton : TargetedMeetingButton
+{
+    public override string Name => "Shoot";
+
+    public override int MaxUses => 3;
+
+    public override float InitialCooldown => 5;
+
+    public override float Cooldown => 3;
+
+    public override LoadableAsset<Sprite> Sprite => ExampleAssets.SharpshootButton;
+
+    public override Color OutlineColor => Color.red;
+
+    public override bool Enabled(RoleBehaviour r)
+    {
+        return r.IsImpostor;
+    }
+
+    protected override void OnClick(PlayerVoteArea playerVoteArea)
+    {
+        playerVoteArea.SetDisabled();
+        var player = playerVoteArea.GetPlayer();
+        if (player != null)
+        {
+            PlayerControl.LocalPlayer.RpcCustomMurder(player);
+        }
+    }
+}

MiraAPI.Example/MeetingAbilities/ShotgunButton.cs

@@ -0,0 +1,54 @@
+using MiraAPI.MeetingAbilities;
+using MiraAPI.Networking;
+using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.MeetingAbilities;
+
+public class ShotgunButton : MultiTargetMeetingButton
+{
+    public override string Name => "Shotgun";
+
+    public override int MaxUses => 3;
+
+    public override float InitialCooldown => 5;
+
+    public override float Cooldown => 3;
+
+    public override LoadableAsset<Sprite> Sprite => ExampleAssets.SharpshootButton;
+
+    public override Color OutlineColor => Color.red;
+
+    public override bool Enabled(RoleBehaviour r)
+    {
+        return r.IsImpostor;
+    }
+
+    protected override void OnClick(PlayerVoteArea playerVoteArea)
+    {
+        // Emptu because it only triggers the actual kills once all meeting abilities have been used.
+    }
+
+    public override LoadableAsset<Sprite> SpriteActive => ExampleAssets.CallMeetingButton;
+
+    public override int TargetsCount => 4;
+
+    protected override void OnSelect(PlayerVoteArea playerVoteArea, bool toggle)
+    {
+        HudManager.Instance.PlayerCam.ShakeScreen(0.5f, 2);
+    }
+
+    public override void OnFinish()
+    {
+        foreach (var playerVoteArea in Targets.Keys)
+        {
+            playerVoteArea.SetDisabled();
+            var player = playerVoteArea.GetPlayer();
+            if (player != null)
+            {
+                PlayerControl.LocalPlayer.RpcCustomMurder(player);
+            }
+        }
+    }
+}

MiraAPI.Example/MiraAPI.Example.csproj

@@ -1,17 +1,18 @@
- <Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<Version>1.0.0</Version>
 		<Description>Example mod for Mira API</Description>
-		<Authors>Angxl, XtraCube</Authors>
+		<Authors>Author Name</Authors>
+		<NoWarn>$(NoWarn);EnableGenerateDocumentationFile</NoWarn>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<ProjectReference Include="..\MiraAPI\MiraAPI.csproj" />
+		<ProjectReference Include="..\MiraAPI\MiraAPI.csproj" /> <!-- You typically would use the nuget package here: AllOfUs.MiraAPI -->
 	</ItemGroup>
 
-	 <ItemGroup>
-		 <EmbeddedResource Include="Resources\**\*.*" />
-	 </ItemGroup>
+	<ItemGroup>
+		<EmbeddedResource Include="Resources\**\*.*" />
+	</ItemGroup>
 
 	<Import Project="..\AmongUs.props" />
 </Project>

MiraAPI.Example/Modifiers/CaptainModifier.cs

@@ -2,6 +2,7 @@
 using MiraAPI.GameOptions;
 using MiraAPI.Modifiers;
 using MiraAPI.Modifiers.Types;
+using MiraAPI.Translation;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
@@ -9,7 +10,7 @@ namespace MiraAPI.Example.Modifiers;
 
 public class CaptainModifier : GameModifier
 {
-    public override string ModifierName => "Captain";
+    public override string ModifierName => MiraLocaleManager.Get("modifier.captain");
     public override LoadableAsset<Sprite>? ModifierIcon => ExampleAssets.CallMeetingButton;
 
     public override void OnDeath(DeathReason reason)
@@ -19,7 +20,7 @@ public class CaptainModifier : GameModifier
 
     public override string GetDescription()
     {
-        return $"You can call a meeting from anywhere on the map.";
+        return MiraLocaleManager.Get("modifier.captain.TabDescription");
     }
 
     public override int GetAssignmentChance()

MiraAPI.Example/Modifiers/Freezer/FreezeModifier.cs

@@ -1,13 +1,14 @@
 using Il2CppSystem;
 using MiraAPI.Example.Roles;
 using MiraAPI.Modifiers.Types;
+using MiraAPI.Translation;
 using UnityEngine;
 
 namespace MiraAPI.Example.Modifiers.Freezer;
 
 public class FreezeModifier : TimedModifier
 {
-    public override string ModifierName => "Freezed";
+    public override string ModifierName => MiraLocaleManager.Get("modifier.freezed");
     public override bool HideOnUi => false;
     public override float Duration => 15f;
     public override bool AutoStart => true;

MiraAPI.Example/Modifiers/HighPriorityModifier.cs

@@ -1,14 +1,15 @@
 using MiraAPI.Modifiers.Types;
+using MiraAPI.Translation;
 
 namespace MiraAPI.Example.Modifiers;
 
 public class HighPriorityModifier : GameModifier
 {
-    public override string ModifierName => "High Priority";
+    public override string ModifierName => MiraLocaleManager.Get("modifier.highPriority");
 
     public override string GetDescription()
     {
-        return "You are high priority! Idrk what this means either tbh...";
+        return MiraLocaleManager.Get("modifier.highPriority.TabDescription");
     }
 
     public override int GetAssignmentChance()

MiraAPI.Example/Options/ExampleOptions.cs

@@ -1,4 +1,5 @@
-using MiraAPI.GameOptions;
+using System.Collections.Generic;
+using MiraAPI.GameOptions;
 using MiraAPI.GameOptions.Attributes;
 using MiraAPI.Utilities;
 using UnityEngine;
@@ -7,20 +8,28 @@ namespace MiraAPI.Example.Options;
 
 public class ExampleOptions : AbstractOptionGroup
 {
-    public override string GroupName => "Example Options 1";
+    public override string GroupName => "options.exampleOptions1";
     public override Color GroupColor => Color.green;
 
-    [ModdedToggleOption("Toggle Opt 1")]
+    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
     public bool ToggleOpt { get; set; } = false;
 
-    [ModdedToggleOption("Toggle Opt 2")]
+    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
     public bool ToggleOpt2 { get; set; } = true;
 
-    [ModdedNumberOption("Number Opt", min: 0, max: 10, increment: .25f, formatString: "0.00", suffixType: MiraNumberSuffixes.Percent)]
+    [ModdedToggleOption("Toggle Opt 3")]
+    [ModdedOptionVisibility(nameof(ToggleOpt2))] // ToggleOpt3 will be visible only when ToggleOpt2 is true
+    public bool ToggleOpt3 { get; set; } = true;
+
+    [ModdedNumberOption("options.exampleOptions1.numberOpt", min: 0, max: 10, increment: .25f, formatString: "0.00", suffixType: MiraNumberSuffixes.Percent)]
     public float NumberOpt { get; set; } = 4f;
 
-    [ModdedEnumOption("Best API", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
+    [ModdedEnumOption("options.exampleOptions1.bestApi", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
     public BestApi Opt { get; set; } = BestApi.MiraAPI;
+
+    [ModdedEnumOptionList<ValueState>("Value State {0}", ["None", "Primary", "Secondary"])]
+    public List<ValueState> ValueStates { get; } =
+        [ValueState.Primary, ValueState.Secondary, ValueState.None, ValueState.None, ValueState.None];
 }
 
 public enum BestApi
@@ -29,3 +38,10 @@ public enum BestApi
     Mitochondria,
     Reactor,
 }
+
+public enum ValueState
+{
+    None,
+    Primary,
+    Secondary,
+}

MiraAPI.Example/Options/ExampleOptions2.cs

@@ -6,20 +6,25 @@ namespace MiraAPI.Example.Options;
 
 public class ExampleOptions2 : AbstractOptionGroup
 {
-    public override string GroupName => "Example Options 2";
+    public override string GroupName => "options.exampleOptions2";
 
     public override uint GroupPriority => 0; // This group will be displayed first. The default value is uint.MaxValue.
 
-    public ModdedPlayerOption PlayerOption2 { get; } = new("YOU MUST CHOSE A PLAYER", false);
-    public ModdedPlayerOption PlayerOption { get; } = new("Eh whatever");
-    public ModdedToggleOption ToggleOpt1 { get; } = new("Toggle Option 1", false);
+    public override MenuCategory ParentMenu => MenuCategory.CustomTwo;
 
-    public ModdedToggleOption ToggleOpt2 { get; } = new("Toggle Option 2", false)
+    public ModdedPlayerOption PlayerOption2 { get; } = new("options.exampleOptions2.youMustChoseAPlayer", false);
+    public ModdedPlayerOption PlayerOption { get; } = new("options.exampleOptions2.ehWhatever");
+    public ModdedToggleOption ToggleOpt1 { get; } = new("options.exampleOptions2.toggleOption1", false);
+
+    public ModdedOptionList<ModdedNumberOption> PlayerNums { get; } = new(5, i =>
+        new($"PlayerNum{i}", 2, 0, 5, 1, Utilities.MiraNumberSuffixes.None));
+
+    public ModdedToggleOption ToggleOpt2 { get; } = new("options.exampleOptions2.toggleOption2", false)
     {
         Visible = () => OptionGroupSingleton<ExampleOptions2>.Instance.ToggleOpt1, // implicit cast from ModdedToggleOption to bool
     };
 
-    public ModdedEnumOption<TestingData> EnumOpt { get; } = new("Enum Opt", 0)
+    public ModdedEnumOption<TestingData> EnumOpt { get; } = new("options.exampleOptions2.enumOpt", 0)
     {
         ChangedEvent = x => Logger<ExamplePlugin>.Info($"changed Enum Opt to {x}"),
     };

MiraAPI.Example/Options/Modifiers/CaptainModifierSettings.cs

@@ -6,14 +6,14 @@ namespace MiraAPI.Example.Options.Modifiers;
 
 public class CaptainModifierSettings : AbstractOptionGroup<CaptainModifier>
 {
-    public override string GroupName => "Captain Settings";
+    public override string GroupName => "options.captainSettings";
 
-    [ModdedNumberOption("Amount", 0, 5)]
+    [ModdedNumberOption("options.captainSettings.amount", 0, 5)]
     public float Amount { get; set; } = 1;
 
-    [ModdedNumberOption("Chance", 0, 100, 10)]
+    [ModdedNumberOption("options.captainSettings.chance", 0, 100, 10)]
     public float Chance { get; set; } = 50;
 
-    [ModdedNumberOption("Uses", 1, 5)]
+    [ModdedNumberOption("options.captainSettings.uses", 1, 5)]
     public float NumUses { get; set; } = 3;
 }

MiraAPI.Example/Options/Modifiers/FreezeModifierSettings.cs

@@ -6,8 +6,8 @@ namespace MiraAPI.Example.Options.Modifiers;
 
 public class FreezeModifierSettings : AbstractOptionGroup<FreezeModifier>
 {
-    public override string GroupName => "Freeze";
+    public override string GroupName => "options.freezeModifierSettings";
 
-    [ModdedToggleOption("Use Color")]
+    [ModdedToggleOption("options.freezeModifierSettings.useColor")]
     public bool UseColor { get; set; } = true;
 }

MiraAPI.Example/Options/Modifiers/GeneralModifierOptions.cs

@@ -5,15 +5,13 @@ namespace MiraAPI.Example.Options.Modifiers;
 
 public class GeneralModifierOptions : AbstractOptionGroup
 {
-    public override string GroupName => "General";
-
+    public override string GroupName => "options.generalModifier";
     public override uint GroupPriority => 0;
+    public override MenuCategory ParentMenu => MenuCategory.Modifiers;
 
-    public override bool ShowInModifiersMenu => true;
-
-    [ModdedToggleOption("Some Boolean Option")]
+    [ModdedToggleOption("options.generalModifier.someBooleanOption")]
     public bool SomeBooleanOption { get; set; } = true;
 
-    [ModdedNumberOption("Number Option", 0, 10, 1)]
+    [ModdedNumberOption("options.generalModifier.numberOption", 0, 10)]
     public float NumberOption { get; set; } = 5;
 }

MiraAPI.Example/Options/Roles/FreezerRoleSettings.cs

@@ -2,16 +2,22 @@
 using MiraAPI.GameOptions;
 using MiraAPI.GameOptions.Attributes;
 using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
 
 namespace MiraAPI.Example.Options.Roles;
 
 public class FreezerRoleSettings : AbstractOptionGroup<FreezerRole>
 {
-    public override string GroupName => "Custom Role";
+    public override OptionNotifConfiguration Configuration => new(
+        Palette.Blue,
+        TmpSpriteUtils.CreateSpriteAsset(
+            MiraAssets.ImpostorFile.LoadAsset(),
+            "ApiExample.Role.Impostor.FreezerRole"));
+    public override string GroupName => "ApiExample.Role.Freezer";
 
-    [ModdedNumberOption("Freeze Duration", 1, 15, 1, MiraNumberSuffixes.Seconds)]
+    [ModdedNumberOption("ApiExample.Role.Freezer.Settings.FreezeDuration", 1, 15, 1, MiraNumberSuffixes.Seconds)]
     public float FreezeDuration { get; set; } = 5;
 
-    [ModdedNumberOption("Freeze Uses", 1, 5)]
+    [ModdedNumberOption("ApiExample.Role.Freezer.Settings.FreezeUses", 1, 5)]
     public float FreezeUses { get; set; } = 1;
 }

MiraAPI.Example/Options/Roles/TeleporterOptions.cs

@@ -6,15 +6,15 @@ using MiraAPI.Utilities;
 
 namespace MiraAPI.Example.Options.Roles;
 
-public class TeleporterOptions : AbstractOptionGroup<TeleporterRole>
+public class TeleporterOptions : AbstractRoleOptionGroup<TeleporterRole>
 {
-    public override string GroupName => "Teleporter";
+    public override string GroupName => "ApiExample.Role.Teleporter";
 
-    public ModdedNumberOption TeleportCooldown { get; set; } = new("Teleport Cooldown", 10, 5, 60, 2.5f, MiraNumberSuffixes.Seconds);
+    public ModdedNumberOption TeleportCooldown { get; set; } = new("ApiExample.Role.Teleporter.Settings.TeleportCooldown", 10, 5, 60, 2.5f, MiraNumberSuffixes.Seconds);
 
-    [ModdedNumberOption("Teleport Duration", 5, 25, 1, MiraNumberSuffixes.Seconds)]
+    [ModdedNumberOption("ApiExample.Role.Teleporter.Settings.TeleportDuration", 5, 25, 1, MiraNumberSuffixes.Seconds)]
     public float TeleportDuration { get; set; } = 10;
 
-    [ModdedNumberOption("Zoom Distance", 4, 15)]
+    [ModdedNumberOption("ApiExample.Role.Teleporter.Settings.ZoomDistance", 4, 15)]
     public float ZoomDistance { get; set; } = 6;
 }

MiraAPI.Example/Resources/Locale/en_US.xml

@@ -0,0 +1,83 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<resources>
+    <string name="ApiExample.Role.Crewmate.Teleporter">Teleporter</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.IntroBlurb">Zoom out and teleport across the map!</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.MedDescription">Zoom out and teleport across the map!</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.TabDescription">Zoom out and teleport across the map!</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.WikiDescription">The Teleporter is a Crewmate role that can move around the map using their dope-ass ability.</string>
+    <string name="ApiExample.Role.Impostor.Freezer">Freezer</string>
+    <string name="ApiExample.Role.Impostor.Freezer.IntroBlurb">Get iced, nerd.</string>
+    <string name="ApiExample.Role.Impostor.Freezer.MedDescription">Freeze others for a duration of time.</string>
+    <string name="ApiExample.Role.Impostor.Freezer.TabDescription">Freeze another player for a duration of time.</string>
+    <string name="ApiExample.Role.Impostor.Freezer.WikiDescription">The Freezer is an Impostor role that can freeze players. Or something along those lines.</string>
+    <string name="ApiExample.Role.Crewmate.Mayor">Mayor</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.IntroBlurb">Democracy is the best policy.</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.MedDescription">Vote out the Impostors with more votes.
+Your votes have double the power.</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.TabDescription">You get one extra vote in the meeting!</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.WikiDescription">The Mayor is a Crewmate role that gets two votes in the meeting, instead of the singular vote other Crewmates get.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon">Chamelon</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.IntroBlurb">Become one with the environment.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.MedDescription">Fade out of everyone's vision by not moving.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.TabDescription">Stay invisible while not moving.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.WikiDescription">The Chamelon is a Crewmate role that slowly becomes invisible while standing still.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller">Outcast Killer</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.IntroBlurb">Kill everyone else.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.MedDescription">Be the last outcast standing.
+Eliminate every other faction.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.TabDescription">Outcast who can kill.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.WikiDescription">The Outcast Killer is an Outcast role that can kill, like some sort of neutral killer...</string>
+    <string name="outcast">Outcast</string>
+    <string name="outcast.group">Outcast Roles</string>
+    <string name="outcast.roleTitle">OUTCAST</string>
+    <string name="outcast.teamIntroDescription">You are an Outcast. You do not have a team.</string>
+    <string name="button.think">Think</string>
+    <string name="button.think.thinking">Thinking...</string>
+    <string name="button.freeze">Freeze</string>
+    <string name="button.teleport">Teleport</string>
+    <string name="button.callMeeting">Call Meeting</string>
+    <string name="button.winGame">Win Game</string>
+    <string name="modifier.captain">Captain</string>
+    <string name="modifier.captain.TabDescription">You can call a meeting from anywhere on the map.</string>
+    <string name="modifier.freezed">Freezed</string>
+    <string name="modifier.highPriority">High Priority</string>
+    <string name="modifier.highPriority.TabDescription">You are high priority! Idrk what this means either tbh...</string>
+    <string name="options.exampleOptions1">Example Options 1</string>
+    <string name="options.exampleOptions1.toggleOpt1">Toggle Opt 1</string>
+    <string name="options.exampleOptions1.toggleOpt2">Toggle Opt 2</string>
+    <string name="options.exampleOptions1.numberOpt">Number Opt</string>
+    <string name="options.exampleOptions1.bestApi">Best API</string>
+    <string name="options.exampleOptions2">Example Options 2</string>
+    <string name="options.exampleOptions2.youMustChoseAPlayer">YOU MUST CHOSE A PLAYER</string>
+    <string name="options.exampleOptions2.ehWhatever">Eh whatever</string>
+    <string name="options.exampleOptions2.toggleOption1">Toggle Option 1</string>
+    <string name="options.exampleOptions2.toggleOption2">Toggle Option 2</string>
+    <string name="options.exampleOptions2.enumOpt">Enum Opt</string>
+    <string name="options.captainSettings">Captain Settings</string>
+    <string name="options.captainSettings.amount">Amount</string>
+    <string name="options.captainSettings.chance">Chance</string>
+    <string name="options.captainSettings.uses">Uses</string>
+    <string name="options.freezeModifierSettings">Freeze</string>
+    <string name="options.freezeModifierSettings.useColor">Use Color</string>
+    <string name="options.generalModifier">General</string>
+    <string name="options.generalModifier.someBooleanOption">Some Boolean Option</string>
+    <string name="options.generalModifier.numberOption">Number Option</string>
+    <string name="options.freezerRoleSettings">Custom Role</string>
+    <string name="ApiExample.Role.Freezer.Settings.FreezeDuration">Freeze Duration</string>
+    <string name="ApiExample.Role.Freezer.Settings.FreezeUses">Freeze Uses</string>
+    <string name="ApiExample.Role.Teleporter.Settings.TeleportCooldown">Teleport Cooldown</string>
+    <string name="ApiExample.Role.Teleporter.Settings.TeleportDuration">Teleport Duration</string>
+    <string name="ApiExample.Role.Teleporter.Settings.ZoomDistance">Zoom Distance</string>
+    <string name="settings.miraExample">Mira Example</string>
+    <string name="settings.miraExample.exampleBool">Example Bool</string>
+    <string name="settings.miraExample.exampleBool2">Example Bool 2</string>
+    <string name="settings.miraExample.slider">Slider</string>
+    <string name="settings.miraExample.exampleNumber">Example Number</string>
+    <string name="settings.miraExample.exampleMultiplier">Example Multplier</string>
+    <string name="settings.miraExample.exampleEnum">Example Enum</string>
+    <string name="settings.miraExample.button.exampleButton">Example Button</string>
+    <string name="gameover.outcastKiller.win">Outcast Killer Wins!</string>
+    <string name="color.cerulean">Cerulean</string>
+    <string name="color.rose">Rose</string>
+    <string name="color.gold">Gold</string>
+</resources>

MiraAPI.Example/Resources/Locale/zh_CN.xml

@@ -0,0 +1,66 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<resources>
+  <string name="ApiExample.Role.Teleporter">传送者</string>
+  <string name="ApiExample.Role.Teleporter.IntroBlurb">缩小视野并在地图上传送！</string>
+    <string name="ApiExample.Role.Teleporter.MedDescription">缩小视野并在地图上传送！</string>
+    <string name="ApiExample.Role.Teleporter.TabDescription">缩小视野并在地图上传送！</string>
+  <string name="ApiExample.Role.Freezer">冰冻者</string>
+  <string name="ApiExample.Role.Freezer.TabDescription">将其他玩家冰冻一段时间。</string>
+  <string name="ApiExample.Role.Crewmate.Mayor">市长</string>
+  <string name="ApiExample.Role.Crewmate.Mayor.TabDescription">你拥有额外投票权！</string>
+  <string name="ApiExample.Role.Crewmate.Chamelon">变色龙</string>
+  <string name="ApiExample.Role.Crewmate.Chamelon.TabDescription">静止不动时保持隐身。</string>
+  <string name="ApiExample.Role.Outcast.OutcastKiller">流放杀手</string>
+  <string name="ApiExample.Role.Outcast.OutcastKiller.TabDescription">可以击杀的流放者。</string>
+  <string name="outcast">流放者</string>
+  <string name="outcast.roleTitle">流放者</string>
+  <string name="outcast.teamIntroDescription">你是流放者，你没有队伍。</string>
+  <string name="button.think">思考</string>
+  <string name="button.think.thinking">思考中...</string>
+  <string name="button.freeze">冰冻</string>
+  <string name="button.teleport">传送</string>
+  <string name="button.callMeeting">召集会议</string>
+  <string name="button.winGame">赢得游戏</string>
+  <string name="modifier.captain">队长</string>
+  <string name="modifier.captain.TabDescription">你可以在地图上任意位置召集会议。</string>
+  <string name="modifier.freezed">已被冰冻</string>
+  <string name="modifier.highPriority">高优先级</string>
+  <string name="modifier.highPriority.TabDescription">你是高优先级！老实说我也不太清楚这是什么意思……</string>
+  <string name="options.exampleOptions1">示例选项组 1</string>
+  <string name="options.exampleOptions1.toggleOpt1">开关选项 1</string>
+  <string name="options.exampleOptions1.toggleOpt2">开关选项 2</string>
+  <string name="options.exampleOptions1.numberOpt">数字选项</string>
+  <string name="options.exampleOptions1.bestApi">谁是最好的API</string>
+  <string name="options.exampleOptions2">示例选项组 2</string>
+  <string name="options.exampleOptions2.youMustChoseAPlayer">你必须选择一个玩家</string>
+  <string name="options.exampleOptions2.ehWhatever">咕咕嘎嘎</string>
+  <string name="options.exampleOptions2.toggleOption1">开关选项 1</string>
+  <string name="options.exampleOptions2.toggleOption2">开关选项 2</string>
+  <string name="options.exampleOptions2.enumOpt">枚举选项</string>
+  <string name="options.captainSettings">队长设置</string>
+  <string name="options.captainSettings.amount">数量</string>
+  <string name="options.captainSettings.chance">概率</string>
+  <string name="options.captainSettings.uses">使用次数</string>
+  <string name="options.freezeModifierSettings">冰冻</string>
+  <string name="options.freezeModifierSettings.useColor">使用颜色</string>
+  <string name="options.generalModifier">通用</string>
+  <string name="options.generalModifier.someBooleanOption">某个布尔选项</string>
+  <string name="options.generalModifier.numberOption">数字选项</string>
+  <string name="ApiExample.Role.Freezer.Settings.FreezeDuration">冰冻时长</string>
+  <string name="ApiExample.Role.Freezer.Settings.FreezeUses">冰冻次数</string>
+  <string name="ApiExample.Role.Teleporter.Settings.TeleportCooldown">传送冷却</string>
+  <string name="ApiExample.Role.Teleporter.Settings.TeleportDuration">传送持续时间</string>
+  <string name="ApiExample.Role.Teleporter.Settings.ZoomDistance">缩放距离</string>
+  <string name="settings.miraExample">Mira 示例插件</string>
+  <string name="settings.miraExample.exampleBool">示例布尔</string>
+  <string name="settings.miraExample.exampleBool2">示例布尔 2</string>
+  <string name="settings.miraExample.slider">滑块</string>
+  <string name="settings.miraExample.exampleNumber">示例数字</string>
+  <string name="settings.miraExample.exampleMultiplier">示例倍数</string>
+  <string name="settings.miraExample.exampleEnum">示例枚举</string>
+  <string name="settings.miraExample.button.exampleButton">示例按钮</string>
+  <string name="gameover.outcastKiller.win">流放杀手获胜！</string>
+  <string name="color.cerulean">天蓝</string>
+  <string name="color.rose">玫瑰红</string>
+  <string name="color.gold">金色</string>
+</resources>

MiraAPI.Example/Roles/ChameleonRole.cs

@@ -1,38 +1,41 @@
 using AmongUs.GameOptions;
 using MiraAPI.Patches.Stubs;
 using MiraAPI.Roles;
+using MiraAPI.Utilities.Assets;
 using Reactor.Utilities;
-using TMPro;
 using UnityEngine;
 
 namespace MiraAPI.Example.Roles;
 
-public class ChameloenRole : CrewmateRole, ICustomRole
+public class ChameleonRole : CrewmateRole, ICustomRole
 {
-    public string RoleName => "Chamelon";
-    public string RoleLongDescription => "Stay invisible while not moving.";
-    public string RoleDescription => RoleLongDescription;
+    private bool shouldHide;
+
+    public string IdPart => "Chameleon";
+    public string IdPrefix => "ApiExample.Role.Crewmate";
     public Color RoleColor => Palette.AcceptedGreen;
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
 
-    private bool _shouldHide;
-
     public CustomRoleConfiguration Configuration => new(this)
     {
         OptionsScreenshot = ExampleAssets.Banner,
+        Icon = MiraAssets.CrewmateFile,
+        IconTmp = TmpSpriteUtils.CreateSpriteAsset(
+            MiraAssets.CrewmateFile.LoadAsset(),
+            "ApiExample.Role.Impostor.ChameleonRole"),
         IntroSound = CustomRoleUtils.GetIntroSound(RoleTypes.Shapeshifter),
     };
 
     public override void Initialize(PlayerControl player)
     {
-        Logger<ExamplePlugin>.Info("Initializing ChamelonRole for player: " + player.PlayerId);
+        Logger<ExamplePlugin>.Info("Initializing ChameleonRole for player: " + player.PlayerId);
         RoleBehaviourStubs.Initialize(this, player);
-        _shouldHide = true;
+        shouldHide = true;
     }
 
     public void FixedUpdate()
     {
-        if (!Player || !_shouldHide)
+        if (!Player || !shouldHide)
         {
             return;
         }
@@ -51,27 +54,34 @@ public class ChameloenRole : CrewmateRole, ICustomRole
         }
         else
         {
-            SpriteRenderer rend = Player.cosmetics.currentBodySprite.BodySprite;
-            TextMeshPro tmp = Player.cosmetics.nameText;
-            tmp.color = Color.Lerp(tmp.color, new Color(tmp.color.r, tmp.color.g, tmp.color.b, Player.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
+            var rend = Player.cosmetics.currentBodySprite.BodySprite;
+            var tmp = Player.cosmetics.nameText;
+            tmp.color = Color.Lerp(
+                tmp.color,
+                new Color(tmp.color.r, tmp.color.g, tmp.color.b, Player.AmOwner ? 0.3f : 0),
+                Time.deltaTime * 4f);
             rend.color = Color.Lerp(rend.color, new Color(1, 1, 1, Player.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
 
             foreach (var cosmetic in Player.cosmetics.transform.GetComponentsInChildren<SpriteRenderer>())
             {
-                cosmetic.color = Color.Lerp(cosmetic.color, new Color(1, 1, 1, Player.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
+                cosmetic.color = Color.Lerp(
+                    cosmetic.color,
+                    new Color(1, 1, 1, Player.AmOwner ? 0.3f : 0),
+                    Time.deltaTime * 4f);
             }
         }
     }
 
     public override void Deinitialize(PlayerControl targetPlayer)
     {
-        Logger<ExamplePlugin>.Info("Deinitializing ChamelonRole for player: " + targetPlayer.PlayerId);
+        Logger<ExamplePlugin>.Info("Deinitializing ChameleonRole for player: " + targetPlayer.PlayerId);
         RoleBehaviourStubs.Deinitialize(this, targetPlayer);
-        _shouldHide = false;
+        shouldHide = false;
         foreach (var cosmetic in Player.cosmetics.transform.GetComponentsInChildren<SpriteRenderer>(true))
         {
             cosmetic.color = Color.white;
         }
+
         Player.cosmetics.currentBodySprite.BodySprite.color = Color.white;
         Player.cosmetics.nameText.color = Color.white;
     }

MiraAPI.Example/Roles/FreezerRole.cs

@@ -1,18 +1,20 @@
 using MiraAPI.Roles;
+using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
 namespace MiraAPI.Example.Roles;
 
 public class FreezerRole : ImpostorRole, ICustomRole
 {
-    public string RoleName => "Freezer";
-    public string RoleLongDescription => "Freeze another player for a duration of time.";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Freezer";
+    public string IdPrefix => "ApiExample.Role.Impostor";
     public Color RoleColor => Palette.Blue;
     public ModdedRoleTeams Team => ModdedRoleTeams.Impostor;
 
-    public CustomRoleConfiguration Configuration => new CustomRoleConfiguration(this)
+    public CustomRoleConfiguration Configuration => new(this)
     {
+        Icon = MiraAssets.ImpostorFile,
+        IconTmp = TmpSpriteUtils.CreateSpriteAsset(MiraAssets.ImpostorFile.LoadAsset(), "ApiExample.Role.Impostor.Freezer"),
         OptionsScreenshot = ExampleAssets.Banner,
         MaxRoleCount = 2,
     };

MiraAPI.Example/Roles/MayorRole.cs

@@ -5,9 +5,8 @@ namespace MiraAPI.Example.Roles;
 
 public class MayorRole : CrewmateRole, ICustomRole
 {
-    public string RoleName => "Mayor";
-    public string RoleLongDescription => "You get extra votes!";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Mayor";
+    public string IdPrefix => "ApiExample.Role.Crewmate";
     public Color RoleColor => new Color32(221, 176, 152, 255);
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
     public CustomRoleConfiguration Configuration => new(this);

MiraAPI.Example/Roles/NeutralKillerRole.cs

@@ -8,9 +8,8 @@ namespace MiraAPI.Example.Roles;
 
 public class NeutralKillerRole : ImpostorRole, ICustomRole
 {
-    public string RoleName => "Outcast Killer";
-    public string RoleDescription => "Outcast who can kill.";
-    public string RoleLongDescription => RoleDescription;
+    public string IdPart => "OutcastKiller";
+    public string IdPrefix => "ApiExample.Role.Outcast";
     public Color RoleColor => Color.magenta;
     public ModdedRoleTeams Team => ModdedRoleTeams.Custom;
 
@@ -21,13 +20,13 @@ public class NeutralKillerRole : ImpostorRole, ICustomRole
         CanUseVent = true,
     };
 
-    public RoleOptionsGroup RoleOptionsGroup { get; } = new("Outcast", Color.gray);
+    public RoleOptionsGroup RoleOptionsGroup { get; } = new("outcast.group", Color.gray);
 
     [HideFromIl2Cpp]
     public TeamIntroConfiguration? IntroConfiguration { get; } = new(
         Color.gray,
-        "OUTCAST",
-        "You are an Outcast. You do not have a team.");
+        "outcast.roleTitle",
+        "outcast.teamIntroDescription");
 
     public override void SpawnTaskHeader(PlayerControl playerControl)
     {

MiraAPI.Example/Roles/TeleporterRole.cs

@@ -5,13 +5,12 @@ namespace MiraAPI.Example.Roles;
 
 public class TeleporterRole : CrewmateRole, ICustomRole
 {
-    public string RoleName => "Teleporter";
-    public string RoleLongDescription => "Zoom out and teleport across the map!";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Teleporter";
+    public string IdPrefix => "ApiExample.Role.Crewmate";
     public Color RoleColor => new Color32(221, 176, 152, 255);
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
 
-    public CustomRoleConfiguration Configuration => new CustomRoleConfiguration(this)
+    public CustomRoleConfiguration Configuration => new(this)
     {
         OptionsScreenshot = ExampleAssets.Banner,
         CanModifyChance = false,

MiraAPI/Colors/CustomColor.cs

@@ -1,5 +1,5 @@
-using MiraAPI.Utilities;
-using Reactor.Localization.Utilities;
+using MiraAPI.Translation;
+using MiraAPI.Utilities;
 using UnityEngine;
 
 namespace MiraAPI.Colors;
@@ -32,18 +32,21 @@ public sealed class CustomColor(StringNames name, Color32 mainColor, Color32 sha
     /// </summary>
     public CustomColorBrightness ColorBrightness { get; set; } = CustomColorBrightness.Darker;
 
-    /// <inheritdoc />
-    public CustomColor(StringNames name, Color32 mainColor) : this(name, mainColor, mainColor.GetShadowColor(60))
+    /// <inheritdoc cref="CustomColor"/>
+    public CustomColor(StringNames name, Color32 mainColor)
+        : this(name, mainColor, mainColor.GetShadowColor(60))
     {
     }
 
-    /// <inheritdoc />
-    public CustomColor(string name, Color32 mainColor) : this(name, mainColor, mainColor.GetShadowColor(60))
+    /// <inheritdoc cref="CustomColor"/>
+    public CustomColor(string name, Color32 mainColor)
+        : this(name, mainColor, mainColor.GetShadowColor(60))
     {
     }
 
-    /// <inheritdoc />
-    public CustomColor(string name, Color32 mainColor, Color32 shadowColor) : this(CustomStringName.CreateAndRegister(name), mainColor, shadowColor)
+    /// <inheritdoc cref="CustomColor"/>
+    public CustomColor(string name, Color32 mainColor, Color32 shadowColor)
+        : this(MiraLocaleManager.GetOrCreateLocaleString(name), mainColor, shadowColor)
     {
     }
 }

MiraAPI/Colors/PaletteManager.cs

@@ -5,12 +5,12 @@ using HarmonyLib;
 namespace MiraAPI.Colors;
 
 /// <summary>
-/// Used to register and track custom colors.
+/// Used to register and track <see cref="CustomColor"/>s.
 /// </summary>
 public static class PaletteManager
 {
     /// <summary>
-    /// Gets all registered custom colors.
+    /// Gets all registered <see cref="CustomColor"/>s.
     /// </summary>
     public static CustomColor[] RegisteredColors => [.. CustomColors];
 

MiraAPI/Colors/RegisterCustomColorsAttribute.cs

@@ -3,7 +3,7 @@
 namespace MiraAPI.Colors;
 
 /// <summary>
-/// Used to mark a class for custom colors registration.
+/// Used to mark a class for <see cref="CustomColor"/> registration.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class)]
 public class RegisterCustomColorsAttribute : Attribute;

MiraAPI/Events/Mira/MiraButtonCancelledEvent.cs

@@ -3,42 +3,27 @@
 namespace MiraAPI.Events.Mira;
 
 /// <summary>
-/// Invoked when a Mira Button click is cancelled. Do not use for vanilla buttons.
+/// Invoked when a <see cref="CustomActionButton"/> click is cancelled. Do not use for vanilla <see cref="AbilityButton"/>s.
 /// </summary>
-/// <typeparam name="T">The Mira Button type.</typeparam>
-public sealed class MiraButtonCancelledEvent<T> : MiraEvent where T : CustomActionButton
+/// <typeparam name="T">The <see cref="CustomActionButton"/> type.</typeparam>
+/// <param name="button">The <see cref="CustomActionButton"/> whose click was cancelled.</param>
+public sealed class MiraButtonCancelledEvent<T>(T button) : MiraEvent
+    where T : CustomActionButton
 {
     /// <summary>
-    /// Gets Mira Button whose click was cancelled.
+    /// Gets the <see cref="CustomActionButton"/> whose click was cancelled.
     /// </summary>
-    public T Button { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="MiraButtonCancelledEvent{T}"/> class.
-    /// </summary>
-    /// <param name="button">The Mira Button whose click was cancelled.</param>
-    public MiraButtonCancelledEvent(T button)
-    {
-        Button = button;
-    }
+    public T Button { get; } = button;
 }
 
 /// <summary>
-/// Invoked when a Mira Button click is cancelled. Do not use for vanilla buttons.
+/// Invoked when a <see cref="CustomActionButton"/> click is cancelled. Do not use for vanilla <see cref="AbilityButton"/>s.
 /// </summary>
-public sealed class MiraButtonCancelledEvent : MiraEvent
+/// <param name="button">The <see cref="CustomActionButton"/> whose click was cancelled.</param>
+public sealed class MiraButtonCancelledEvent(CustomActionButton button) : MiraEvent
 {
     /// <summary>
-    /// Gets Mira Button whose click was cancelled.
+    /// Gets the <see cref="CustomActionButton"/> whose click was cancelled.
     /// </summary>
-    public CustomActionButton Button { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="MiraButtonCancelledEvent"/> class.
-    /// </summary>
-    /// <param name="button">The Mira Button whose click was cancelled.</param>
-    public MiraButtonCancelledEvent(CustomActionButton button)
-    {
-        Button = button;
-    }
+    public CustomActionButton Button { get; } = button;
 }

MiraAPI/Events/Mira/MiraButtonClickEvent.cs

@@ -3,49 +3,33 @@
 namespace MiraAPI.Events.Mira;
 
 /// <summary>
-/// Button click event for Mira Buttons only. Do not use for vanilla buttons.
+/// Button click event for <see cref="CustomActionButton"/>s only. Do not use for vanilla <see cref="AbilityButton"/>s.
 /// </summary>
-/// <typeparam name="T">The Mira Button type.</typeparam>
-public sealed class MiraButtonClickEvent<T> : MiraCancelableEvent where T : CustomActionButton
+/// <typeparam name="T">The <see cref="CustomActionButton"/> type.</typeparam>
+/// <param name="button">The <see cref="CustomActionButton"/> that was clicked.</param>
+/// <param name="genericClickEvent">The generic <see cref="MiraButtonClickEvent"/> invoked before button-specific events.</param>
+public class MiraButtonClickEvent<T>(T button, MiraButtonClickEvent genericClickEvent) : MiraCancelableEvent
+    where T : CustomActionButton
 {
     /// <summary>
-    /// Gets Mira Button that was clicked.
+    /// Gets the <see cref="CustomActionButton"/> that was clicked.
     /// </summary>
-    public T Button { get; }
+    public T Button { get; } = button;
 
     /// <summary>
-    /// Gets the generic click event that is invoked before this button-specific event.
+    /// Gets the generic <see cref="MiraButtonClickEvent"/> that is invoked before this button-specific event.
     /// </summary>
-    public MiraButtonClickEvent GenericClickEvent { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="MiraButtonClickEvent{T}"/> class.
-    /// </summary>
-    /// <param name="button">The Mira Button that was clicked.</param>
-    /// <param name="genericClickEvent">The generic click event invoked before button-specific events.</param>
-    public MiraButtonClickEvent(T button, MiraButtonClickEvent genericClickEvent)
-    {
-        GenericClickEvent = genericClickEvent;
-        Button = button;
-    }
+    public MiraButtonClickEvent GenericClickEvent { get; } = genericClickEvent;
 }
 
 /// <summary>
-/// Button click event for Mira Buttons only. Do not use for vanilla buttons.
+/// Button click event for <see cref="CustomActionButton"/>s only. Do not use for vanilla <see cref="AbilityButton"/>s.
 /// </summary>
-public sealed class MiraButtonClickEvent : MiraCancelableEvent
+/// <param name="button">The <see cref="CustomActionButton"/> that was clicked.</param>
+public class MiraButtonClickEvent(CustomActionButton button) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets Mira Button that was clicked.
+    /// Gets the <see cref="CustomActionButton"/> that was clicked.
     /// </summary>
-    public CustomActionButton Button { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="MiraButtonClickEvent"/> class.
-    /// </summary>
-    /// <param name="button">The Mira Button that was clicked.</param>
-    public MiraButtonClickEvent(CustomActionButton button)
-    {
-        Button = button;
-    }
+    public CustomActionButton Button { get; } = button;
 }

MiraAPI/Events/Mira/UiButtonPostResetEvent.cs

@@ -0,0 +1,21 @@
+using UnityEngine;
+
+namespace MiraAPI.Events.Mira;
+
+/// <summary>
+/// Event fired by Mira API to adjust the UI buttons at the top right of the screen.
+/// </summary>
+/// <param name="topUiRow">The <see cref="GameObject"/> for the top UI row.</param>
+/// <param name="secondUiRow">The <see cref="GameObject"/> for the second UI row.</param>
+public class UiButtonPostResetEvent(GameObject topUiRow, GameObject secondUiRow) : MiraEvent
+{
+    /// <summary>
+    /// Gets the <see cref="GameObject"/> parent for the very top UI row.
+    /// </summary>
+    public GameObject MainTopUiRow { get; } = topUiRow;
+
+    /// <summary>
+    /// Gets the <see cref="GameObject"/> parent for the second top UI row.
+    /// </summary>
+    public GameObject SecondTopUiRow { get; } = secondUiRow;
+}

MiraAPI/Events/Mira/UiButtonResetEvent.cs

@@ -0,0 +1,15 @@
+namespace MiraAPI.Events.Mira;
+
+/// <summary>
+/// Event fired by Mira API prior to adjusting the UI buttons at the top right of the screen.
+/// </summary>
+public class UiButtonResetEvent : MiraEvent
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UiButtonResetEvent"/> class.
+    /// </summary>
+    public UiButtonResetEvent()
+    {
+        // nothing!
+    }
+}

MiraAPI/Events/MiraCancelableEvent.cs

@@ -1,8 +1,11 @@
-namespace MiraAPI.Events;
+using MiraAPI.PluginLoading;
+
+namespace MiraAPI.Events;
 
 /// <summary>
 /// Abstract class for Mira Events that can be cancelled.
 /// </summary>
+[MiraIgnore]
 public abstract class MiraCancelableEvent : MiraEvent
 {
     /// <summary>

MiraAPI/Events/MiraEvent.cs

@@ -1,6 +1,9 @@
-namespace MiraAPI.Events;
+using MiraAPI.PluginLoading;
+
+namespace MiraAPI.Events;
 
 /// <summary>
 /// Abstract class for Mira Events.
 /// </summary>
+[MiraIgnore]
 public abstract class MiraEvent;

MiraAPI/Events/MiraEventHandle.cs

@@ -3,7 +3,7 @@
 namespace MiraAPI.Events;
 
 /// <summary>
-/// Event handle to use when unregistering an event.
+/// Event handle to use when unregistering a <see cref="MiraEvent"/>.
 /// </summary>
 public class MiraEventHandle
 {

MiraAPI/Events/MiraEventManager.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Reflection;
-using Reactor.Utilities;
 
 namespace MiraAPI.Events;
 
@@ -13,14 +12,16 @@ public static class MiraEventManager
     private static readonly Dictionary<Type, List<MiraEventWrapper>> EventWrappers = [];
 
     /// <summary>
-    /// Invoke an event.
+    /// Invoke a <see cref="MiraEvent"/>.
     /// </summary>
-    /// <param name="eventInstance">The event instance.</param>
+    /// <param name="eventInstance">The <typeparamref name="T"/> instance.</param>
     /// <typeparam name="T">Type of Event.</typeparam>
-    /// <returns>If there was an event handler invoked for this event, return true. Otherwise, return false.</returns>
-    public static bool InvokeEvent<T>(T eventInstance) where T : MiraEvent
+    /// <returns>If there was an event handler invoked for this event, return <see langword="true"/>. Otherwise, return <see langword="false"/>.</returns>
+    public static bool InvokeEvent<T>(this T eventInstance)
+        where T : MiraEvent
     {
         EventWrappers.TryGetValue(typeof(T), out var handlers);
+
         if (handlers == null || handlers.Count == 0)
         {
             return false;
@@ -42,14 +43,15 @@ public static class MiraEventManager
     }
 
     /// <summary>
-    /// Invoke an event and use a specific type to find the handlers.
+    /// Invoke a <see cref="MiraEvent"/> and use a specific type to find the handlers.
     /// </summary>
-    /// <param name="eventInstance">The event instance.</param>
+    /// <param name="eventInstance">The <see cref="MiraEvent"/> instance.</param>
     /// <param name="type">The type to use for handler lookup.</param>
-    /// <returns>If there was an event handler invoked for this event, return true. Otherwise, return false.</returns>
-    public static bool InvokeEvent(MiraEvent eventInstance, Type type)
+    /// <returns>If there was an event handler invoked for this event, return <see langword="true"/>. Otherwise, return <see langword="false"/>.</returns>
+    public static bool InvokeEvent(this MiraEvent eventInstance, Type type)
     {
         EventWrappers.TryGetValue(type, out var handlers);
+
         if (handlers == null || handlers.Count == 0)
         {
             return false;
@@ -71,12 +73,12 @@ public static class MiraEventManager
     }
 
     /// <summary>
-    /// Register an event.
+    /// Register a <see cref="MiraEvent"/> handler.
     /// </summary>
-    /// <param name="type">The type of event.</param>
-    /// <param name="methodInfo">The MethodInfo of the event handler.</param>
+    /// <param name="type">The type of <see cref="MiraEvent"/> event.</param>
+    /// <param name="methodInfo">The <see cref="MethodInfo"/> of the event handler.</param>
     /// <param name="priority">The priority of the event handler. Lower values are called first.</param>
-    /// <returns>An event handle to use when unregistering the event.</returns>
+    /// <returns>A <see cref="MiraEventHandle"/> to use when unregistering the event.</returns>
     public static MiraEventHandle RegisterEventHandler(Type type, MethodInfo methodInfo, int priority = 0)
     {
         if (!type.IsSubclassOf(typeof(MiraEvent)))
@@ -102,13 +104,14 @@ public static class MiraEventManager
     }
 
     /// <summary>
-    /// Register an event.
+    /// Register a <typeparamref name="T"/> handler.
     /// </summary>
     /// <param name="handler">The callback method/handler for the event.</param>
     /// <param name="priority">The priority of the event handler. Lower values are called first.</param>
-    /// <typeparam name="T">Type of event.</typeparam>
-    /// <returns>An event handle to use when unregistering the event.</returns>
-    public static MiraEventHandle RegisterEventHandler<T>(Action<T> handler, int priority = 0) where T : MiraEvent
+    /// <typeparam name="T">Type of <see cref="MiraEvent"/> event.</typeparam>
+    /// <returns>A <see cref="MiraEventHandle"/> to use when unregistering the event.</returns>
+    public static MiraEventHandle RegisterEventHandler<T>(Action<T> handler, int priority = 0)
+        where T : MiraEvent
     {
         EventWrappers.TryAdd(typeof(T), []);
 
@@ -127,10 +130,10 @@ public static class MiraEventManager
     }
 
     /// <summary>
-    /// Unregister an event using the event handle.
+    /// Unregister a <see cref="MiraEvent"/> handler using the <see cref="MiraEventHandle"/>.
     /// </summary>
     /// <param name="eventHandle">A handle to the event.</param>
-    /// <returns>True if the event was unregistered successfully, false otherwise.</returns>
+    /// <returns><see langword="true"/> if the event was unregistered successfully, <see langword="false"/> otherwise.</returns>
     public static bool UnregisterEventHandler(MiraEventHandle eventHandle)
     {
         if (!EventWrappers.TryGetValue(eventHandle.EventType, out var handlers))
@@ -147,6 +150,7 @@ public static class MiraEventManager
         {
             EventWrappers.Remove(eventHandle.EventType);
         }
+
         return true;
     }
 }

MiraAPI/Events/MiraEventWrapper.cs

@@ -3,28 +3,19 @@
 namespace MiraAPI.Events;
 
 /// <summary>
-/// Wrapper for event handlers.
+/// Wrapper for <see cref="MiraEvent"/> handlers.
 /// </summary>
-public class MiraEventWrapper
+/// <param name="eventHandler">The action for the event handler.</param>
+/// <param name="priority">The priority of the handler.</param>
+public class MiraEventWrapper(Delegate eventHandler, int priority)
 {
     /// <summary>
     /// Gets the event handler delegate.
     /// </summary>
-    public Delegate EventHandler { get; }
+    public Delegate EventHandler { get; } = eventHandler;
 
     /// <summary>
     /// Gets the priority of the handler. Lower values are called first.
     /// </summary>
-    public int Priority { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="MiraEventWrapper"/> class.
-    /// </summary>
-    /// <param name="eventHandler">The action for the event handler.</param>
-    /// <param name="priority">The priority of the handler.</param>
-    public MiraEventWrapper(Delegate eventHandler, int priority)
-    {
-        EventHandler = eventHandler;
-        Priority = priority;
-    }
+    public int Priority { get; } = priority;
 }

MiraAPI/Events/RegisterEventAttribute.cs

@@ -3,22 +3,14 @@
 namespace MiraAPI.Events;
 
 /// <summary>
-/// Register an event.
+/// Register a <see cref="MiraEvent"/> handler.
 /// </summary>
+/// <param name="priority">The priority of the event. Lower values are called first.</param>
 [AttributeUsage(AttributeTargets.Method)]
-public class RegisterEventAttribute : Attribute
+public class RegisterEventAttribute(int priority = 0) : Attribute
 {
     /// <summary>
     /// Gets the priority of the event. Lower values are called first.
     /// </summary>
-    public int Priority { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="RegisterEventAttribute"/> class.
-    /// </summary>
-    /// <param name="priority">The priority of the event. Lower values are called first.</param>
-    public RegisterEventAttribute(int priority = 0)
-    {
-        Priority = priority;
-    }
+    public int Priority { get; } = priority;
 }

MiraAPI/Events/Vanilla/Gameplay/AfterMurderEvent.cs

@@ -3,33 +3,66 @@
 /// <summary>
 /// Event that is invoked after a player is murdered. Only called after a successful murder. This event is not cancelable.
 /// </summary>
-public class AfterMurderEvent : MiraEvent
+/// <param name="source">The <see cref="PlayerControl"/> that killed the <paramref name="target"/>.</param>
+/// <param name="target">The <see cref="PlayerControl"/> that was killed.</param>
+/// <param name="framed">The <see cref="PlayerControl"/> that was framed.</param>
+/// <param name="deadBody">The <paramref name="target"/>'s <see cref="global::DeadBody"/>, if it exists.</param>
+/// <param name="isIndirect">Whether the murder was caused indirectly.</param>
+/// <param name="ignoreDefense">Whether the murder ignored protection.</param>
+public class AfterMurderEvent(PlayerControl source, PlayerControl target, PlayerControl? framed, DeadBody? deadBody, bool isIndirect = true, bool ignoreDefense = false) : MiraEvent
 {
     /// <summary>
-    /// Gets the player that killed the target.
+    /// Gets the <see cref="PlayerControl"/> that killed the <see cref="Target"/>.
     /// </summary>
-    public PlayerControl Source { get; }
+    public PlayerControl Source { get; } = source;
 
     /// <summary>
-    /// Gets the player that was killed.
+    /// Gets the <see cref="PlayerControl"/> that was killed.
     /// </summary>
-    public PlayerControl Target { get; }
+    public PlayerControl Target { get; } = target;
 
     /// <summary>
-    /// Gets the player's body, if it exists.
+    /// Gets the <see cref="PlayerControl"/> that was framed, if any.
     /// </summary>
-    public DeadBody? DeadBody { get; }
+    public PlayerControl? Framed { get; } = framed;
+
+    /// <summary>
+    /// Gets a value indicating whether the murder was done indirectly.
+    /// This is commonly used to prevent the <see cref="Source"/> <see cref="PlayerControl"/> from being killed.
+    /// </summary>
+    public bool IsIndirectAttack { get; } = isIndirect;
+
+    /// <summary>
+    /// Gets a value indicating whether the murder was able to bypass protective roles or general defense, such as <see cref="GuardianAngelRole"/>.
+    /// </summary>
+    public bool IgnoreDefense { get; } = ignoreDefense;
+
+    /// <summary>
+    /// Gets the <see cref="Target"/>'s <see cref="DeadBody"/>, if it exists.
+    /// </summary>
+    public DeadBody? DeadBody { get; } = deadBody;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="AfterMurderEvent"/> class.
     /// </summary>
-    /// <param name="source">The killer.</param>
-    /// <param name="target">The killed player.</param>
-    /// <param name="deadBody">The player's vody, if it exists.</param>
+    /// <param name="source">The <see cref="PlayerControl"/> that killed the <paramref name="target"/>.</param>
+    /// <param name="target">The <see cref="PlayerControl"/> that was killed.</param>
+    /// <param name="deadBody">The <paramref name="target"/>'s <see cref="DeadBody"/>, if it exists.</param>
+    /// <param name="isIndirect">Whether the murder was caused indirectly.</param>
+    /// <param name="ignoreDefense">Whether the murder ignored protection.</param>
+    public AfterMurderEvent(PlayerControl source, PlayerControl target, DeadBody? deadBody, bool isIndirect, bool ignoreDefense = false)
+        : this(source, target, null, deadBody, isIndirect, ignoreDefense)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AfterMurderEvent"/> class.
+    /// </summary>
+    /// <param name="source">The <see cref="PlayerControl"/> that killed the <paramref name="target"/>.</param>
+    /// <param name="target">The <see cref="PlayerControl"/> that was killed.</param>
+    /// <param name="deadBody">The <paramref name="target"/>'s <see cref="DeadBody"/>, if it exists.</param>
     public AfterMurderEvent(PlayerControl source, PlayerControl target, DeadBody? deadBody)
+        : this(source, target, null, deadBody)
     {
-        Source = source;
-        Target = target;
-        DeadBody = deadBody;
     }
 }

MiraAPI/Events/Vanilla/Gameplay/BeforeGameEndEvent.cs

@@ -1,21 +1,13 @@
 namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
-/// Invoked before RpcEndGame is called, allowing cancellation of the game end entirely.
+/// Invoked before <see cref="GameManager.RpcEndGame"/> is called, allowing cancellation of the game end entirely.
 /// </summary>
-public class BeforeGameEndEvent : MiraCancelableEvent
+/// <param name="reason">The reason for the game end.</param>
+public class BeforeGameEndEvent(GameOverReason reason) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets the reason for the game end.
     /// </summary>
-    public GameOverReason Reason { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="BeforeGameEndEvent"/> class.
-    /// </summary>
-    /// <param name="reason">The reason for the game end.</param>
-    public BeforeGameEndEvent(GameOverReason reason)
-    {
-        Reason = reason;
-    }
+    public GameOverReason Reason { get; } = reason;
 }

MiraAPI/Events/Vanilla/Gameplay/BeforeMurderEvent.cs

@@ -5,45 +5,67 @@ namespace MiraAPI.Events.Vanilla.Gameplay;
 /// <summary>
 /// Event that is invoked before a player is murdered. This event is cancelable.
 /// </summary>
-public sealed class BeforeMurderEvent : MiraCancelableEvent
+/// <param name="source">The <see cref="PlayerControl"/> that is killing the <paramref name="target"/>.</param>
+/// <param name="target">The <see cref="PlayerControl"/> that is being killed.</param>
+/// <param name="framed">The <see cref="PlayerControl"/> that is being framed.</param>
+/// <param name="isIndirect">Whether the murder is caused indirectly.</param>
+/// <param name="ignoreDefense">Whether the murder should ignore protection.</param>
+/// <param name="inMeeting">Whether the murder is intended to be triggered in a meeting.</param>
+public sealed class BeforeMurderEvent(PlayerControl source, PlayerControl target, PlayerControl? framed, bool isIndirect = true, bool ignoreDefense = false, MeetingCheck inMeeting = MeetingCheck.Ignore)
+    : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets the player that is killing the target.
+    /// Gets the <see cref="PlayerControl"/> that is killing the <see cref="Target"/>.
     /// </summary>
-    public PlayerControl Source { get; }
+    public PlayerControl Source { get; } = source;
 
     /// <summary>
-    /// Gets the player that is being killed.
+    /// Gets the <see cref="PlayerControl"/> that is being killed.
     /// </summary>
-    public PlayerControl Target { get; }
+    public PlayerControl Target { get; } = target;
 
     /// <summary>
-    /// Gets whether the murder was meant to be done in a meeting via an enum.
+    /// Gets the <see cref="PlayerControl"/> that is being framed, if any.
     /// </summary>
-    public MeetingCheck InMeeting { get; }
+    public PlayerControl? Framed { get; } = framed;
+
+    /// <summary>
+    /// Gets or sets a value indicating whether the murder is done indirectly.
+    /// This is commonly used to prevent the <see cref="Source"/> <see cref="PlayerControl"/> from being killed.
+    /// </summary>
+    public bool IsIndirectAttack { get; set; } = isIndirect;
+
+    /// <summary>
+    /// Gets or sets  a value indicating whether the murder should bypass protective roles or general defense, such as <see cref="GuardianAngelRole"/>.
+    /// </summary>
+    public bool IgnoreDefense { get; set; } = ignoreDefense;
+
+    /// <summary>
+    /// Gets whether the murder was meant to be done in a meeting, via an enum.
+    /// </summary>
+    public MeetingCheck InMeeting { get; } = inMeeting;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="BeforeMurderEvent"/> class.
     /// </summary>
-    /// <param name="source">The player that is killing the target.</param>
-    /// <param name="target">The player that is being killed.</param>
+    /// <param name="source">The <see cref="PlayerControl"/> that is killing the <paramref name="target"/>.</param>
+    /// <param name="target">The <see cref="PlayerControl"/> that is being killed.</param>
     /// <param name="inMeeting">Whether the murder is intended to be triggered in a meeting.</param>
-    public BeforeMurderEvent(PlayerControl source, PlayerControl target, MeetingCheck inMeeting)
+    public BeforeMurderEvent(PlayerControl source, PlayerControl target, MeetingCheck inMeeting = MeetingCheck.Ignore)
+        : this(source, target, false, false, inMeeting)
     {
-        Source = source;
-        Target = target;
-        InMeeting = inMeeting;
     }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="BeforeMurderEvent"/> class.
     /// </summary>
-    /// <param name="source">The player that is killing the target.</param>
-    /// <param name="target">The player that is being killed.</param>
-    public BeforeMurderEvent(PlayerControl source, PlayerControl target)
+    /// <param name="source">The <see cref="PlayerControl"/> that is killing the <paramref name="target"/>.</param>
+    /// <param name="target">The <see cref="PlayerControl"/> that is being killed.</param>
+    /// <param name="isIndirect">Whether the murder is caused indirectly.</param>
+    /// <param name="ignoreDefense">Whether the murder should ignore protection.</param>
+    /// <param name="inMeeting">Whether the murder is intended to be triggered in a meeting.</param>
+    public BeforeMurderEvent(PlayerControl source, PlayerControl target, bool isIndirect, bool ignoreDefense = false, MeetingCheck inMeeting = MeetingCheck.Ignore)
+        : this(source, target, null, isIndirect, ignoreDefense, inMeeting)
     {
-        Source = source;
-        Target = target;
-        InMeeting = MeetingCheck.Ignore;
     }
 }

MiraAPI/Events/Vanilla/Gameplay/BeforeRoundStartEvent.cs

@@ -1,21 +1,13 @@
 namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
-/// Event invoked on IntroCutscene.OnDestroy and ExileController.WrapUp to determine if it should run the round event or not.
+/// Event invoked on <see cref="IntroCutscene.OnDestroy"/> and <see cref="ExileController.WrapUp"/> to determine if it should run the <see cref="RoundStartEvent"/> event or not.
 /// </summary>
-public class BeforeRoundStartEvent : MiraCancelableEvent
+/// <param name="triggeredByIntro">Whether the event was triggered by the intro or not.</param>
+public class BeforeRoundStartEvent(bool triggeredByIntro) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets a value indicating whether the event was triggered by the IntroCutscene or ExileController.
+    /// Gets a value indicating whether the event was triggered by the <see cref="IntroCutscene"/> or <see cref="ExileController"/>.
     /// </summary>
-    public bool TriggeredByIntro { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="BeforeRoundStartEvent"/> class.
-    /// </summary>
-    /// <param name="triggeredByIntro">Whether the event was triggered by the intro or not.</param>
-    public BeforeRoundStartEvent(bool triggeredByIntro)
-    {
-        TriggeredByIntro = triggeredByIntro;
-    }
+    public bool TriggeredByIntro { get; } = triggeredByIntro;
 }

MiraAPI/Events/Vanilla/Gameplay/GameEndEvent.cs

@@ -1,21 +1,13 @@
 namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
-/// The event that is invoked when the end game screen is shown. Non cancelable.
+/// The event that is invoked when the end game screen is shown. Non-cancelable.
 /// </summary>
-public class GameEndEvent : MiraEvent
+/// <param name="manager">The <see cref="global::EndGameManager"/> instance.</param>
+public class GameEndEvent(EndGameManager manager) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the EndGameManager.
+    /// Gets the <see cref="global::EndGameManager"/> instance.
     /// </summary>
-    public EndGameManager EndGameManager { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="GameEndEvent"/> class.
-    /// </summary>
-    /// <param name="manager">The instance of the EndGameManager.</param>
-    public GameEndEvent(EndGameManager manager)
-    {
-        EndGameManager = manager;
-    }
+    public EndGameManager EndGameManager { get; } = manager;
 }

MiraAPI/Events/Vanilla/Gameplay/IntroBeginEvent.cs

@@ -1,21 +1,13 @@
 namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
-/// The event that is invoked when the intro cutscene is shown. Non cancelable.
+/// The event that is invoked when the intro cutscene is shown. Non-cancelable.
 /// </summary>
-public class IntroBeginEvent : MiraEvent
+/// <param name="introCutscene">The intro cutscene.</param>
+public class IntroBeginEvent(IntroCutscene introCutscene) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the IntroCutscene.
+    /// Gets the <see cref="global::IntroCutscene"/> instance.
     /// </summary>
-    public IntroCutscene IntroCutscene { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="IntroBeginEvent"/> class.
-    /// </summary>
-    /// <param name="introCutscene">The intro cutscene.</param>
-    public IntroBeginEvent(IntroCutscene introCutscene)
-    {
-        IntroCutscene = introCutscene;
-    }
+    public IntroCutscene IntroCutscene { get; } = introCutscene;
 }

MiraAPI/Events/Vanilla/Gameplay/IntroEndEvent.cs

@@ -3,10 +3,11 @@
 /// <summary>
 /// The event that is invoked when the intro cutscene has finished playing.
 /// </summary>
+/// <param name="introCutscene">The intro cutscene.</param>
 public class IntroEndEvent(IntroCutscene introCutscene) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the IntroCutscene.
+    /// Gets the <see cref="global::IntroCutscene"/> instance.
     /// </summary>
     public IntroCutscene IntroCutscene { get; } = introCutscene;
 }

MiraAPI/Events/Vanilla/Gameplay/IntroRoleRevealEvent.cs

@@ -1,21 +1,13 @@
 namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
-/// The event that is invoked when the player's role is shown on the intro cutscene. Non cancelable.
+/// The event that is invoked when the player's role is shown on the intro cutscene. Non-cancelable.
 /// </summary>
-public class IntroRoleRevealEvent : MiraEvent
+/// <param name="introCutscene">The intro cutscene.</param>
+public class IntroRoleRevealEvent(IntroCutscene introCutscene) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the IntroCutscene.
+    /// Gets the <see cref="global::IntroCutscene"/> instance.
     /// </summary>
-    public IntroCutscene IntroCutscene { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="IntroRoleRevealEvent"/> class.
-    /// </summary>
-    /// <param name="introCutscene">The intro cutscene.</param>
-    public IntroRoleRevealEvent(IntroCutscene introCutscene)
-    {
-        IntroCutscene = introCutscene;
-    }
+    public IntroCutscene IntroCutscene { get; } = introCutscene;
 }

MiraAPI/Events/Vanilla/Gameplay/RoundStartEvent.cs

@@ -1,21 +1,14 @@
 namespace MiraAPI.Events.Vanilla.Gameplay;
 
 /// <summary>
-/// Start Round event, invoked on IntroCutscene.OnDestroy and ExileController.WrapUp if the event isn't cancelled.
+/// Start Round event, invoked on <see cref="IntroCutscene.OnDestroy"/> and <see cref="ExileController.WrapUp"/>
+/// if the <see cref="BeforeRoundStartEvent"/> isn't cancelled.
 /// </summary>
-public class RoundStartEvent : MiraEvent
+/// <param name="triggeredByIntro">Whether the event was triggered by the intro or not.</param>
+public class RoundStartEvent(bool triggeredByIntro) : MiraEvent
 {
     /// <summary>
-    /// Gets a value indicating whether the event was triggered by the IntroCutscene or ExileController.
+    /// Gets a value indicating whether the event was triggered by the <see cref="IntroCutscene"/> or <see cref="ExileController"/>.
     /// </summary>
-    public bool TriggeredByIntro { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="RoundStartEvent"/> class.
-    /// </summary>
-    /// <param name="triggeredByIntro">Whether the event was triggered by the intro or not.</param>
-    public RoundStartEvent(bool triggeredByIntro)
-    {
-        TriggeredByIntro = triggeredByIntro;
-    }
+    public bool TriggeredByIntro { get; } = triggeredByIntro;
 }

MiraAPI/Events/Vanilla/Gameplay/SetRoleEvent.cs

@@ -5,26 +5,17 @@ namespace MiraAPI.Events.Vanilla.Gameplay;
 /// <summary>
 /// Event that is invoked after a player's role is set. This event is not cancelable.
 /// </summary>
-public class SetRoleEvent : MiraEvent
+/// <param name="player">The player.</param>
+/// <param name="role">The new role.</param>
+public class SetRoleEvent(PlayerControl player, RoleTypes role) : MiraEvent
 {
     /// <summary>
-    /// Gets the player whos role was changed.
+    /// Gets the <see cref="PlayerControl"/> whose role was changed.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = player;
 
     /// <summary>
     /// Gets the role that the player was set to.
     /// </summary>
-    public RoleTypes Role { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="SetRoleEvent"/> class.
-    /// </summary>
-    /// <param name="player">The player.</param>
-    /// <param name="role">The new role.</param>
-    public SetRoleEvent(PlayerControl player, RoleTypes role)
-    {
-        Player = player;
-        Role = role;
-    }
+    public RoleTypes Role { get; } = role;
 }

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonCancelledEvent.cs

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

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonClickEvent.cs

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

MiraAPI/Events/Vanilla/Map/CloseDoorsEvent.cs

@@ -3,19 +3,11 @@
 /// <summary>
 /// Event fired when a player closes the doors in a room.
 /// </summary>
-public class CloseDoorsEvent : MiraCancelableEvent
+/// <param name="room">The room that was closed.</param>
+public class CloseDoorsEvent(SystemTypes room) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets the room that the doors were closed in.
     /// </summary>
-    public SystemTypes Room { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="CloseDoorsEvent"/> class.
-    /// </summary>
-    /// <param name="room">The room that was closed.</param>
-    public CloseDoorsEvent(SystemTypes room)
-    {
-        Room = room;
-    }
+    public SystemTypes Room { get; } = room;
 }

MiraAPI/Events/Vanilla/Map/PlayerOpenSabotageEvent.cs

@@ -3,19 +3,11 @@
 /// <summary>
 /// Sabotage from Vanilla Among Us.
 /// </summary>
-public class PlayerOpenSabotageEvent : MiraCancelableEvent
+/// <param name="mapBehaviour">The <see cref="global::MapBehaviour"/>.</param>
+public class PlayerOpenSabotageEvent(MapBehaviour mapBehaviour) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets the MapBehaviour.
+    /// Gets the <see cref="global::MapBehaviour"/>.
     /// </summary>
-    public MapBehaviour MapBehaviour { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PlayerOpenSabotageEvent"/> class.
-    /// </summary>
-    /// <param name="mapBehaviour">The MapBehaviour.</param>
-    public PlayerOpenSabotageEvent(MapBehaviour mapBehaviour)
-    {
-        MapBehaviour = mapBehaviour;
-    }
+    public MapBehaviour MapBehaviour { get; } = mapBehaviour;
 }

MiraAPI/Events/Vanilla/Map/UpdateSystemEvent.cs

@@ -1,35 +1,25 @@
 namespace MiraAPI.Events.Vanilla.Map;
 
 /// <summary>
-/// Cancelable event that is invoked before a system is updated. Usually used for sabotage events.
+/// <see cref="MiraCancelableEvent"/> that is invoked before a system is updated. Usually used for sabotage events.
 /// </summary>
-public class UpdateSystemEvent : MiraCancelableEvent
+/// <param name="systemType">The <see cref="SystemTypes"/> being updated.</param>
+/// <param name="player">The <see cref="PlayerControl"/> that is updating the system.</param>
+/// <param name="amount">Amount to update System to.</param>
+public class UpdateSystemEvent(SystemTypes systemType, PlayerControl player, byte amount) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets the type of system that will be updated.
     /// </summary>
-    public SystemTypes SystemType { get; }
+    public SystemTypes SystemType { get; } = systemType;
 
     /// <summary>
-    /// Gets the player that is updating the system.
+    /// Gets the <see cref="PlayerControl"/> that is updating the system.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = player;
 
     /// <summary>
     /// Gets the byte amount the system is being updated by.
     /// </summary>
-    public byte Amount { get; }
-
-    /// <summary>
-    ///  Initializes a new instance of the <see cref="UpdateSystemEvent"/> class.
-    /// </summary>
-    /// <param name="systemType">The SystemType being updated.</param>
-    /// <param name="player">The player that is updating the system.</param>
-    /// <param name="amount">Amount to update System to.</param>
-    public UpdateSystemEvent(SystemTypes systemType, PlayerControl player, byte amount)
-    {
-        SystemType = systemType;
-        Player = player;
-        Amount = amount;
-    }
+    public byte Amount { get; } = amount;
 }

MiraAPI/Events/Vanilla/Meeting/EjectionEvent.cs

@@ -3,19 +3,11 @@
 /// <summary>
 /// The event that is invoked when a player is ejected. Non-cancelable.
 /// </summary>
-public class EjectionEvent : MiraEvent
+/// <param name="controller">The <see cref="global::ExileController"/> instance.</param>
+public class EjectionEvent(ExileController controller) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the ExileController.
+    /// Gets the <see cref="global::ExileController"/> instance.
     /// </summary>
-    public ExileController ExileController { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="EjectionEvent"/> class.
-    /// </summary>
-    /// <param name="controller">The exile controller.</param>
-    public EjectionEvent(ExileController controller)
-    {
-        ExileController = controller;
-    }
+    public ExileController ExileController { get; } = controller;
 }

MiraAPI/Events/Vanilla/Meeting/EndMeetingEvent.cs

@@ -6,7 +6,7 @@
 public class EndMeetingEvent(MeetingHud meetingHud) : MiraEvent
 {
     /// <summary>
-    /// Gets the MeetingHud instance.
+    /// Gets the <see cref="global::MeetingHud"/> instance.
     /// </summary>
     public MeetingHud MeetingHud { get; } = meetingHud;
 }

MiraAPI/Events/Vanilla/Meeting/ReportBodyEvent.cs

@@ -1,36 +1,26 @@
 namespace MiraAPI.Events.Vanilla.Meeting;
 
 /// <summary>
-/// The event that is invoked when a body is reported.
-/// This is invoked in CmdReportBody.
+/// The event that is invoked when a body is reported.<br/>
+/// This is invoked in <see cref="PlayerControl.CmdReportDeadBody(NetworkedPlayerInfo)"/>.
 /// </summary>
-public class ReportBodyEvent : MiraCancelableEvent
+/// <param name="reporter">The player who reported the body.</param>
+/// <param name="target">The player being reported.</param>
+/// <param name="body">The <see cref="DeadBody"/> being reported.</param>
+public class ReportBodyEvent(PlayerControl reporter, NetworkedPlayerInfo? target, DeadBody? body) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets the player that is reporting the body.
     /// </summary>
-    public PlayerControl Reporter { get; }
+    public PlayerControl Reporter { get; } = reporter;
 
     /// <summary>
-    /// Gets the player that is being reported. Will be null for emergency meeting.
+    /// Gets the player that is being reported. Will be <see langword="null"/> for emergency meeting.
     /// </summary>
-    public NetworkedPlayerInfo? Target { get; }
+    public NetworkedPlayerInfo? Target { get; } = target;
 
     /// <summary>
-    /// Gets the body that is being reported. Will be null for emergency meeting.
+    /// Gets the <see cref="DeadBody"/> that is being reported. Will be <see langword="null"/> for emergency meeting.
     /// </summary>
-    public DeadBody? Body { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="ReportBodyEvent"/> class.
-    /// </summary>
-    /// <param name="reporter">The player who reported the body.</param>
-    /// <param name="target">The player being reported.</param>
-    /// <param name="body">The body being reported.</param>
-    public ReportBodyEvent(PlayerControl reporter, NetworkedPlayerInfo? target, DeadBody? body)
-    {
-        Reporter = reporter;
-        Target = target;
-        Body = body;
-    }
+    public DeadBody? Body { get; } = body;
 }

MiraAPI/Events/Vanilla/Meeting/StartMeetingEvent.cs

@@ -4,19 +4,11 @@
 /// The event that is invoked when a meeting is called. This event is not cancelable.
 /// This event is called after Mira resets votes, so if you plan on adding votes to a specific player, do it with this event.
 /// </summary>
-public class StartMeetingEvent : MiraEvent
+/// <param name="meetingHud">The <see cref="global::MeetingHud"/> instance.</param>
+public class StartMeetingEvent(MeetingHud meetingHud) : MiraEvent
 {
     /// <summary>
-    /// Gets the MeetingHud instance.
+    /// Gets the <see cref="global::MeetingHud"/> instance.
     /// </summary>
-    public MeetingHud MeetingHud { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="StartMeetingEvent"/> class.
-    /// </summary>
-    /// <param name="meetingHud">The MeetingHud instance.</param>
-    public StartMeetingEvent(MeetingHud meetingHud)
-    {
-        MeetingHud = meetingHud;
-    }
+    public MeetingHud MeetingHud { get; } = meetingHud;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/AfterVoteEvent.cs

@@ -1,30 +1,19 @@
-using MiraAPI.Voting;
-
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
+namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 
 /// <summary>
 /// Event that is invoked after the local player successfully votes a player or skips. This event is not cancelable.
 /// </summary>
-public class AfterVoteEvent : MiraEvent
+/// <param name="playerVoteArea">The <see cref="PlayerVoteArea"/> that was voted on.</param>
+/// <param name="voter">The player who voted.</param>
+public class AfterVoteEvent(PlayerVoteArea playerVoteArea, PlayerControl voter) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the voter's vote data.
+    /// Gets the instance of the voter's <see cref="PlayerVoteArea"/>.
     /// </summary>
-    public PlayerVoteArea VoteArea { get; }
+    public PlayerVoteArea VoteArea { get; } = playerVoteArea;
 
     /// <summary>
     /// Gets the player who voted.
     /// </summary>
-    public PlayerControl Player { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="AfterVoteEvent"/> class.
-    /// </summary>
-    /// <param name="playerVoteArea">The player vote area that was voted on.</param>
-    /// <param name="voter">The player who voted.</param>
-    public AfterVoteEvent(PlayerVoteArea playerVoteArea, PlayerControl voter)
-    {
-        VoteArea = playerVoteArea;
-        Player = voter;
-    }
+    public PlayerControl Player { get; } = voter;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/BeforeVoteEvent.cs

@@ -1,30 +1,19 @@
-using MiraAPI.Voting;
-
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
+namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 
 /// <summary>
 /// Event that is invoked before the local player confirms a vote on a player or when skipping. This event is cancelable.
 /// </summary>
-public class BeforeVoteEvent : MiraCancelableEvent
+/// <param name="playerVoteArea">The <see cref="PlayerVoteArea"/> that was voted on.</param>
+/// <param name="voter">The player who voted.</param>
+public class BeforeVoteEvent(PlayerVoteArea playerVoteArea, PlayerControl voter) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets the instance of the voter's vote data.
+    /// Gets the instance of the voter's <see cref="PlayerVoteArea"/>.
     /// </summary>
-    public PlayerVoteArea VoteArea { get; }
+    public PlayerVoteArea VoteArea { get; } = playerVoteArea;
 
     /// <summary>
     /// Gets the player who voted.
     /// </summary>
-    public PlayerControl Player { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="BeforeVoteEvent"/> class.
-    /// </summary>
-    /// <param name="playerVoteArea">The player vote area that was voted on.</param>
-    /// <param name="voter">The player who voted.</param>
-    public BeforeVoteEvent(PlayerVoteArea playerVoteArea, PlayerControl voter)
-    {
-        VoteArea = playerVoteArea;
-        Player = voter;
-    }
+    public PlayerControl Player { get; } = voter;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/CheckForEndVotingEvent.cs

@@ -3,24 +3,16 @@
 /// <summary>
 /// Checks if voting is complete. If canceled, the default end voting logic will be skipped.
 /// </summary>
-public class CheckForEndVotingEvent : MiraCancelableEvent
+/// <param name="isVotingComplete"><see langword="true"/> if voting is complete, <see langword="false"/> otherwise.</param>
+public class CheckForEndVotingEvent(bool isVotingComplete) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets a value indicating whether default voting logic determines that voting is complete.
     /// </summary>
-    public bool IsVotingComplete { get; }
+    public bool IsVotingComplete { get; } = isVotingComplete;
 
     /// <summary>
     /// Gets or sets a value indicating whether the voting should be forced to end, regardless of the default logic.
     /// </summary>
     public bool ForceEndVoting { get; set; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="CheckForEndVotingEvent"/> class.
-    /// </summary>
-    /// <param name="isVotingComplete">>True if voting is complete, false otherwise.</param>
-    public CheckForEndVotingEvent(bool isVotingComplete)
-    {
-        IsVotingComplete = isVotingComplete;
-    }
 }

MiraAPI/Events/Vanilla/Meeting/Voting/DummyVoteEvent.cs

@@ -7,38 +7,27 @@ namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 /// <summary>
 /// Invoked before the dummy selects their vote. If canceled, the dummy won't vote.
 /// </summary>
-public class DummyVoteEvent : MiraCancelableEvent
+/// <param name="dummy">The voting dummy.</param>
+public class DummyVoteEvent(DummyBehaviour dummy) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets the dummy that needs to vote.
     /// </summary>
-    public DummyBehaviour Dummy { get; }
+    public DummyBehaviour Dummy { get; } = dummy;
 
     /// <summary>
-    /// Gets the instance of the dummy's vote data.
+    /// Gets the instance of the dummy's <see cref="PlayerVoteData"/>.
     /// </summary>
-    public PlayerVoteData VoteData { get; }
+    public PlayerVoteData VoteData { get; } = dummy.myPlayer.GetVoteData();
 
     /// <summary>
     /// Gets or sets a value indicating whether the dummy can vote to skip the meeting.
     /// </summary>
-    public bool CanSkip { get; set; }
+    public bool CanSkip { get; set; } = true;
 
     /// <summary>
     /// Gets or sets a predicate for validating whether the dummy can vote on a player.
     /// By default, excludes dead and disconnected players.
     /// </summary>
-    public Predicate<PlayerControl> PlayerIsValid { get; set; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="DummyVoteEvent"/> class.
-    /// </summary>
-    /// <param name="dummy">The voting dummy.</param>
-    public DummyVoteEvent(DummyBehaviour dummy)
-    {
-        Dummy = dummy;
-        VoteData = dummy.myPlayer.GetVoteData();
-        CanSkip = true;
-        PlayerIsValid = x => !x.Data.IsDead && !x.Data.Disconnected;
-    }
+    public Predicate<PlayerControl> PlayerIsValid { get; set; } = x => !x.Data.IsDead && !x.Data.Disconnected;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/HandleVoteEvent.cs

@@ -4,47 +4,43 @@ namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 
 /// <summary>
 /// The event that is invoked when Mira handles a vote. This is invoked before Mira's behaviour, so be cautious.
-/// If you intend on adding custom vote behaviour, cancel the event and do so.
-/// If you are NOT canceling the event, keep in mind that Mira automatically removes a vote and adds the suspect to the VotedPlayers list after this event is invoked.
 /// </summary>
-public class HandleVoteEvent : MiraCancelableEvent
+/// <remarks>
+/// If you intend on adding custom vote behaviour, cancel the event and do so.<br/>
+/// If you are NOT canceling the event, keep in mind that Mira automatically removes a vote and adds the suspect to the <see cref="PlayerVoteData.Votes"/> list after this event is invoked.
+/// </remarks>
+/// <param name="playerVoteData">The voter's <see cref="PlayerVoteData"/>.</param>
+/// <param name="targetId">The target's playerId.</param>
+/// <param name="isOverruling">Whether the vote is actually for a Judge.</param>
+public class HandleVoteEvent(PlayerVoteData playerVoteData, byte targetId, bool isOverruling = false) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets the instance of the voter's vote data.
+    /// Gets the instance of the voter's <see cref="PlayerVoteData"/>.
     /// </summary>
-    public PlayerVoteData VoteData { get; }
+    public PlayerVoteData VoteData { get; } = playerVoteData;
 
     /// <summary>
     /// Gets the player who voted.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = playerVoteData.Owner;
 
     /// <summary>
     /// Gets the player id of the target.
     /// </summary>
-    public byte TargetId { get; }
+    public byte TargetId { get; } = targetId;
 
     /// <summary>
-    /// Gets a value indicating whether to prevent the vote from commencing.
+    /// Gets or sets a value indicating whether to prevent the vote from commencing.
     /// </summary>
-    public bool PreventVote { get; }
+    public bool PreventVote { get; set; } = false;
 
     /// <summary>
-    /// Gets the player info of the target.
+    /// Gets the <see cref="NetworkedPlayerInfo"/> of the target.
     /// </summary>
-    public NetworkedPlayerInfo TargetPlayerInfo { get; }
+    public NetworkedPlayerInfo TargetPlayerInfo { get; } = GameData.Instance.GetPlayerById(targetId);
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="HandleVoteEvent"/> class.
+    /// Gets or sets a value indicating whether the vote event is an Overrule caused by a Judge.
     /// </summary>
-    /// <param name="playerVoteData">The voter's data.</param>
-    /// <param name="targetId">The target's playerId.</param>
-    public HandleVoteEvent(PlayerVoteData playerVoteData, byte targetId)
-    {
-        VoteData = playerVoteData;
-        Player = playerVoteData.Owner;
-        TargetId = targetId;
-        PreventVote = false;
-        TargetPlayerInfo = GameData.Instance.GetPlayerById(targetId);
-    }
+    public bool IsOverruling { get; set; } = isOverruling;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/MeetingSelectEvent.cs

@@ -5,39 +5,28 @@ namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 /// <summary>
 /// The event that is invoked when the player tries to select another player to vote.
 /// </summary>
-public class MeetingSelectEvent : MiraEvent
+/// <param name="playerVoteData">The voter's <see cref="PlayerVoteData"/>.</param>
+/// <param name="targetId">The target's playerId.</param>
+/// <param name="allowSelect">Whether the player is allowed to select the target.</param>
+public class MeetingSelectEvent(PlayerVoteData playerVoteData, int targetId, bool allowSelect) : MiraEvent
 {
     /// <summary>
-    /// Gets the instance of the voter's vote data.
+    /// Gets the instance of the voter's <see cref="PlayerVoteData"/>.
     /// </summary>
-    public PlayerVoteData VoteData { get; }
+    public PlayerVoteData VoteData { get; } = playerVoteData;
 
     /// <summary>
     /// Gets the player id of the target.
     /// </summary>
-    public int TargetId { get; }
+    public int TargetId { get; } = targetId;
 
     /// <summary>
-    /// Gets the player info of the target.
+    /// Gets the <see cref="NetworkedPlayerInfo"/> of the target.
     /// </summary>
-    public NetworkedPlayerInfo TargetPlayerInfo { get; }
+    public NetworkedPlayerInfo TargetPlayerInfo { get; } = GameData.Instance.GetPlayerById((byte)targetId);
 
     /// <summary>
     /// Gets or sets a value indicating whether the player is allowed to select the target.
     /// </summary>
-    public bool AllowSelect { get; set; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="MeetingSelectEvent"/> class.
-    /// </summary>
-    /// <param name="playerVoteData">The voter's data.</param>
-    /// <param name="targetId">The target's playerId.</param>
-    /// <param name="allowSelect">>Whether the player is allowed to select the target.</param>
-    public MeetingSelectEvent(PlayerVoteData playerVoteData, int targetId, bool allowSelect)
-    {
-        VoteData = playerVoteData;
-        TargetId = targetId;
-        TargetPlayerInfo = GameData.Instance.GetPlayerById((byte)targetId);
-        AllowSelect = allowSelect;
-    }
+    public bool AllowSelect { get; set; } = allowSelect;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/PopulateResultsEvent.cs

@@ -4,22 +4,16 @@ using MiraAPI.Voting;
 namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 
 /// <summary>
-/// Called in VotingUtils.HandlePopulateResults.
-/// Cancelling is NOT advised but if you do plan on cancelling, please ensure you account for displaying ALL player's votes.
+/// Called in <see cref="VotingUtils.HandlePopulateResults"/>.
 /// </summary>
-public class PopulateResultsEvent : MiraCancelableEvent
+/// <remarks>
+/// Cancelling is NOT advised but if you do plan on cancelling, please ensure you account for displaying ALL player's votes.
+/// </remarks>
+/// <param name="votes">The list of <see cref="CustomVote"/>s.</param>
+public class PopulateResultsEvent(List<CustomVote> votes) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets a list of networked votes.
+    /// Gets a list of networked <see cref="CustomVote"/>s.
     /// </summary>
-    public List<CustomVote> Votes { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PopulateResultsEvent"/> class.
-    /// </summary>
-    /// <param name="votes">The list of votes.</param>
-    public PopulateResultsEvent(List<CustomVote> votes)
-    {
-        Votes = votes;
-    }
+    public List<CustomVote> Votes { get; } = votes;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/ProcessVotesEvent.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using MiraAPI.Voting;
 
@@ -7,16 +8,11 @@ namespace MiraAPI.Events.Vanilla.Meeting.Voting;
 /// <summary>
 /// Ran after calculating votes and before displaying the results. Only ran on the host.
 /// </summary>
-/// <remarks>
-/// Initializes a new instance of the <see cref="ProcessVotesEvent"/> class.
-/// </remarks>
-/// <param name="votes">>The list of votes that are being processed.</param>
-/// <param name="exiledPlayer">The player to be exiled. Will be null if no player is to be exiled.</param>
+/// <param name="votes">The list of <see cref="CustomVote"/>s that are being processed.</param>
+/// <param name="exiledPlayer">The player to be exiled. Will be <see langword="null"/> if no player is to be exiled.</param>
 public class ProcessVotesEvent(List<CustomVote> votes, NetworkedPlayerInfo? exiledPlayer = null) : MiraEvent
 {
-    private readonly List<CustomVote> _originalVotes = [.. votes];
-
-    private NetworkedPlayerInfo? _exiledPlayer = exiledPlayer;
+    private readonly List<CustomVote> originalVotes = [.. votes];
 
     /// <summary>
     /// Gets a value indicating whether the exiled player has been modified by the event.
@@ -26,23 +22,35 @@ public class ProcessVotesEvent(List<CustomVote> votes, NetworkedPlayerInfo? exil
     /// <summary>
     /// Gets a value indicating whether the votes have been modified by the event.
     /// </summary>
-    public bool VotesModified => !Votes.SequenceEqual(_originalVotes);
+    public bool VotesModified => !Votes.SequenceEqual(originalVotes);
 
     /// <summary>
-    /// Gets the list of votes that are being processed.
+    /// Gets the list of <see cref="CustomVote"/>s that are being processed.
     /// </summary>
     public List<CustomVote> Votes { get; } = votes;
 
     /// <summary>
-    /// Gets or sets the player to be exiled. Will be null if no player is to be exiled.
+    /// Gets or sets a value indicating whether an overruling was done. Normally set by judge but can be overwritten.
     /// </summary>
+    public bool OverruledVote { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value specifically to determine which Judge (if any) caused the overruling. Normally set by judge but can be overwritten.
+    /// </summary>
+    public ushort OverruledNonce { get; set; }
+
+    /// <summary>
+    /// Gets or sets the player to be exiled. Will be <see langword="null"/> if no player is to be exiled.
+    /// </summary>
+    [SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1513:Closing brace should be followed by blank line", Justification = "Looks weird.")]
     public NetworkedPlayerInfo? ExiledPlayer
     {
-        get => _exiledPlayer;
+        get;
         set
         {
-            _exiledPlayer = value;
+            field = value;
             ExiledPlayerModified = true;
         }
     }
+    = exiledPlayer;
 }

MiraAPI/Events/Vanilla/Meeting/Voting/VotingCompleteEvent.cs

@@ -3,11 +3,11 @@
 /// <summary>
 /// The event that is invoked when the voting phase of a meeting is complete.
 /// </summary>
-/// <param name="meetingHud">The MeetingHud instance.</param>
+/// <param name="meetingHud">The <see cref="global::MeetingHud"/> instance.</param>
 public class VotingCompleteEvent(MeetingHud meetingHud) : MiraEvent
 {
     /// <summary>
-    /// Gets the MeetingHud instance.
+    /// Gets the <see cref="global::MeetingHud"/> instance.
     /// </summary>
     public MeetingHud MeetingHud { get; } = meetingHud;
 }

MiraAPI/Events/Vanilla/Player/CompleteHnsTaskEvent.cs

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

MiraAPI/Events/Vanilla/Player/CompleteTaskEvent.cs

@@ -1,28 +1,19 @@
 namespace MiraAPI.Events.Vanilla.Player;
 
 /// <summary>
-/// The event that is invoked when a player completes a task. Non cancelable.
+/// The event that is invoked when a player completes a task. Non-cancelable.
 /// </summary>
-public class CompleteTaskEvent : MiraEvent
+/// <param name="player">The player who completed the task.</param>
+/// <param name="task">The task that the player completed.</param>
+public class CompleteTaskEvent(PlayerControl player, PlayerTask task) : MiraEvent
 {
     /// <summary>
     /// Gets the instance of the <see cref="PlayerControl"/>.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = player;
 
     /// <summary>
     /// Gets the instance of the <see cref="PlayerTask"/> that the player completed.
     /// </summary>
-    public PlayerTask Task { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="CompleteTaskEvent"/> class.
-    /// </summary>
-    /// <param name="player">The player who completed the task.</param>
-    /// <param name="task">The task that the player completed.</param>
-    public CompleteTaskEvent(PlayerControl player, PlayerTask task)
-    {
-        Player = player;
-        Task = task;
-    }
+    public PlayerTask Task { get; } = task;
 }

MiraAPI/Events/Vanilla/Player/PlayerDeathEvent.cs

@@ -1,35 +1,25 @@
 namespace MiraAPI.Events.Vanilla.Player;
 
 /// <summary>
-/// Event that is invoked when a player dies. Non cancelable.
+/// Event that is invoked when a player dies. Non-cancelable.
 /// </summary>
-public class PlayerDeathEvent : MiraEvent
+/// <param name="player">The player who died.</param>
+/// <param name="reason">The reason the player died.</param>
+/// <param name="deadBody">The player's <see cref="global::DeadBody"/>, if it exists.</param>
+public class PlayerDeathEvent(PlayerControl player, DeathReason reason, DeadBody? deadBody) : MiraEvent
 {
     /// <summary>
     /// Gets the player who died.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = player;
 
     /// <summary>
     /// Gets the reason the player died.
     /// </summary>
-    public DeathReason DeathReason { get; }
+    public DeathReason DeathReason { get; } = reason;
 
     /// <summary>
-    /// Gets the dead body associated with the player, if any.
+    /// Gets the <see cref="global::DeadBody"/> associated with the player, if any.
     /// </summary>
-    public DeadBody? DeadBody { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PlayerDeathEvent"/> class.
-    /// </summary>
-    /// <param name="player">The player who died.</param>
-    /// <param name="reason">The reason the player died.</param>
-    /// <param name="deadBody">The player's body, if it exists.</param>
-    public PlayerDeathEvent(PlayerControl player, DeathReason reason, DeadBody? deadBody)
-    {
-        Player = player;
-        DeathReason = reason;
-        DeadBody = deadBody;
-    }
+    public DeadBody? DeadBody { get; } = deadBody;
 }

MiraAPI/Events/Vanilla/Player/PlayerJoinEvent.cs

@@ -3,21 +3,13 @@
 namespace MiraAPI.Events.Vanilla.Player;
 
 /// <summary>
-/// Event that is invoked when a player joins the lobby. Non cancelable.
+/// Event that is invoked when a player joins the lobby. Non-cancelable.
 /// </summary>
-public class PlayerJoinEvent : MiraEvent
+/// <param name="data">The data of the player who joined.</param>
+public class PlayerJoinEvent(ClientData data) : MiraEvent
 {
     /// <summary>
     /// Gets the player who joined.
     /// </summary>
-    public ClientData ClientData { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PlayerJoinEvent"/> class.
-    /// </summary>
-    /// <param name="data">The data of the player who joined.</param>
-    public PlayerJoinEvent(ClientData data)
-    {
-        ClientData = data;
-    }
+    public ClientData ClientData { get; } = data;
 }

MiraAPI/Events/Vanilla/Player/PlayerLeaveEvent.cs

@@ -3,28 +3,19 @@
 namespace MiraAPI.Events.Vanilla.Player;
 
 /// <summary>
-/// Event that is invoked when a player leaves the game. Non cancelable.
+/// Event that is invoked when a player leaves the game. Non-cancelable.
 /// </summary>
-public class PlayerLeaveEvent : MiraEvent
+/// <param name="data">The data of the player who left.</param>
+/// <param name="reason">The reason why the player left.</param>
+public class PlayerLeaveEvent(ClientData data, DisconnectReasons reason) : MiraEvent
 {
     /// <summary>
     /// Gets the player who left.
     /// </summary>
-    public ClientData ClientData { get; }
+    public ClientData ClientData { get; } = data;
 
     /// <summary>
     /// Gets the reason why the player left.
     /// </summary>
-    public DisconnectReasons Reason { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PlayerLeaveEvent"/> class.
-    /// </summary>
-    /// <param name="data">The data of the player who left.</param>
-    /// <param name="reason">The reason why the player left.</param>
-    public PlayerLeaveEvent(ClientData data, DisconnectReasons reason)
-    {
-        ClientData = data;
-        Reason = reason;
-    }
+    public DisconnectReasons Reason { get; } = reason;
 }

MiraAPI/Events/Vanilla/Usables/EnterVentEvent.cs

@@ -3,26 +3,17 @@
 /// <summary>
 /// Event that is invoked when a player enters a vent. This event is cancelable.
 /// </summary>
-public class EnterVentEvent : MiraCancelableEvent
+/// <param name="player">The <see cref="PlayerControl"/> that is entering the <paramref name="vent"/>.</param>
+/// <param name="vent">The <see cref="global::Vent"/> being entered.</param>
+public class EnterVentEvent(PlayerControl player, Vent? vent) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets the player that is entering the vent.
+    /// Gets the <see cref="PlayerControl"/> that is entering the <see cref="Vent"/>.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = player;
 
     /// <summary>
-    /// Gets the vent that the player is entering.
+    /// Gets the <see cref="global::Vent"/> that the <see cref="Player"/> is entering.
     /// </summary>
-    public Vent? Vent { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="EnterVentEvent"/> class.
-    /// </summary>
-    /// <param name="player">The player that is entering the vent.</param>
-    /// <param name="vent">The vent being entered.</param>
-    public EnterVentEvent(PlayerControl player, Vent? vent)
-    {
-        Player = player;
-        Vent = vent;
-    }
+    public Vent? Vent { get; } = vent;
 }

MiraAPI/Events/Vanilla/Usables/ExitVentEvent.cs

@@ -3,26 +3,17 @@
 /// <summary>
 /// Event that is invoked when a player exits a vent. This event is cancelable.
 /// </summary>
-public class ExitVentEvent : MiraCancelableEvent
+/// <param name="player">The <see cref="PlayerControl"/> who is exiting the <paramref name="vent"/>.</param>
+/// <param name="vent">The <see cref="global::Vent"/> being exited from.</param>
+public class ExitVentEvent(PlayerControl player, Vent? vent) : MiraCancelableEvent
 {
     /// <summary>
-    /// Gets the player that is exiting the vent.
+    /// Gets the <see cref="PlayerControl"/> that is exiting the <see cref="Vent"/>.
     /// </summary>
-    public PlayerControl Player { get; }
+    public PlayerControl Player { get; } = player;
 
     /// <summary>
-    /// Gets the vent that the player is exiting.
+    /// Gets the <see cref="global::Vent"/> that the <see cref="Player"/> is exiting.
     /// </summary>
-    public Vent? Vent { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="ExitVentEvent"/> class.
-    /// </summary>
-    /// <param name="player">The player who is exiting the vent.</param>
-    /// <param name="vent">The vent being exited from.</param>
-    public ExitVentEvent(PlayerControl player, Vent? vent)
-    {
-        Player = player;
-        Vent = vent;
-    }
+    public Vent? Vent { get; } = vent;
 }

MiraAPI/Events/Vanilla/Usables/PlayerCanUseEvent.cs

@@ -1,15 +1,7 @@
 namespace MiraAPI.Events.Vanilla.Usables;
 
 /// <summary>
-/// Event for if a <see cref="PlayerControl"/> can use an <see cref="IUsable"/> from Vanilla Among Us. Will always be ran locally.
+/// Event for if a <see cref="PlayerControl"/> can use an <see cref="IUsable"/> from Vanilla Among Us. Will always be run locally.
 /// </summary>
-public class PlayerCanUseEvent : PlayerUseEvent
-{
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PlayerCanUseEvent"/> class.
-    /// </summary>
-    /// <param name="usable">The IUsable.</param>
-    public PlayerCanUseEvent(IUsable usable) : base(usable)
-    {
-    }
-}
+/// <param name="usable">The <see cref="IUsable"/>.</param>
+public class PlayerCanUseEvent(IUsable usable) : PlayerUseEvent(usable);

MiraAPI/Events/Vanilla/Usables/PlayerUseEvent.cs

@@ -1,34 +1,23 @@
 namespace MiraAPI.Events.Vanilla.Usables;
 
 /// <summary>
-/// Event for <see cref="PlayerControl"/> using a <see cref="IUsable"/> from Vanilla Among Us. Will always be ran locally.
+/// Event for <see cref="PlayerControl"/> using a <see cref="IUsable"/> from Vanilla Among Us. Will always be run locally.
 /// </summary>
-public class PlayerUseEvent : MiraCancelableEvent
+/// <param name="usable">The <see cref="IUsable"/>.</param>
+public class PlayerUseEvent(IUsable usable) : MiraCancelableEvent
 {
     /// <summary>
     /// Gets the instance of <see cref="IUsable"/> that was used.
     /// </summary>
-    public IUsable Usable { get; }
+    public IUsable Usable { get; } = usable;
 
     /// <summary>
-    /// Gets a value indicating whether the IUsable is a <see cref="Console"/>, <see cref="MapConsole"/>, or <see cref="SystemConsole"/>.
+    /// Gets a value indicating whether the <see cref="Usable"/> is a <see cref="Console"/>, <see cref="MapConsole"/>, or <see cref="SystemConsole"/>.
     /// </summary>
-    public bool IsPrimaryConsole { get; }
+    public bool IsPrimaryConsole { get; } = usable.TryCast<Console>() || usable.TryCast<SystemConsole>() || usable.TryCast<MapConsole>();
 
     /// <summary>
-    /// Gets a value indicating whether the IUsable is a <see cref="Vent"/>.
+    /// Gets a value indicating whether the <see cref="Usable"/> is a <see cref="Vent"/>.
     /// </summary>
-    public bool IsVent { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="PlayerUseEvent"/> class.
-    /// </summary>
-    /// <param name="usable">The IUsable.</param>
-    public PlayerUseEvent(IUsable usable)
-    {
-        Usable = usable;
-
-        IsPrimaryConsole = usable.TryCast<Console>() || usable.TryCast<SystemConsole>() || usable.TryCast<MapConsole>();
-        IsVent = usable.TryCast<Vent>();
-    }
+    public bool IsVent { get; } = usable.TryCast<Vent>();
 }

MiraAPI/GameEnd/CustomGameOver.cs

@@ -10,45 +10,46 @@ namespace MiraAPI.GameEnd;
 public abstract class CustomGameOver
 {
     /// <summary>
-    /// Gets the current CustomGameOver.
+    /// Gets the current <see cref="CustomGameOver"/>.
     /// </summary>
     public static CustomGameOver? Instance { get; internal set; }
 
     /// <summary>
-    /// Verifies if the condition for this CustomGameOver is met.
+    /// Verifies if the condition for this <see cref="CustomGameOver"/> is met.
     /// </summary>
-    /// <param name="playerControl">The PlayerControl that requested the Game Over.</param>
+    /// <param name="playerControl">The <see cref="PlayerControl"/> that requested the Game Over.</param>
     /// <param name="winners">The collection of winners.</param>
-    /// <returns>True if the condition is met, otherwise false.</returns>
+    /// <returns><see langword="true"/> if the condition is met, otherwise <see langword="false"/>.</returns>
     public virtual bool VerifyCondition(PlayerControl playerControl, NetworkedPlayerInfo[] winners)
     {
         return true;
     }
 
     /// <summary>
-    /// Runs before the base game calls EndGameManager.SetEverythingUp.
+    /// Runs before the base game calls <see cref="EndGameManager.SetEverythingUp"/>.
     /// </summary>
-    /// <param name="endGameManager">The EndGameManager instance.</param>
-    /// <returns>Return True to use the run the original method, return False to skip it.</returns>
+    /// <param name="endGameManager">The <see cref="EndGameManager"/> instance.</param>
+    /// <returns>Return <see langword="true"/> to use the run the original method, return <see langword="false"/> to skip it.</returns>
     public virtual bool BeforeEndGameSetup(EndGameManager endGameManager)
     {
         return true;
     }
 
     /// <summary>
-    /// Runs after the base game calls EndGameManager.SetEverythingUp.
+    /// Runs after the base game calls <see cref="EndGameManager.SetEverythingUp"/>.
     /// </summary>
-    /// <param name="endGameManager">The EndGameManager instance.</param>
+    /// <param name="endGameManager">The <see cref="EndGameManager"/> instance.</param>
     public virtual void AfterEndGameSetup(EndGameManager endGameManager)
     {
     }
 
     /// <summary>
-    /// Get the GameOverReason associated with this CustomGameOver.
+    /// Get the <see cref="global::GameOverReason"/> associated with this <see cref ="CustomGameOver"/>.
     /// </summary>
     /// <typeparam name="T">Type of the custom game over.</typeparam>
-    /// <returns>The GameOverReason associated with the custom game over.</returns>
-    public static GameOverReason GameOverReason<T>() where T : CustomGameOver
+    /// <returns>The <see cref="global::GameOverReason"/> associated with the custom game over.</returns>
+    public static GameOverReason GameOverReason<T>()
+        where T : CustomGameOver
     {
         return (GameOverReason)GameOverManager.GetGameOverId<T>();
     }
@@ -58,7 +59,8 @@ public abstract class CustomGameOver
     /// </summary>
     /// <param name="winners">A collection of winners.</param>
     /// <typeparam name="T">Type of the custom game over.</typeparam>
-    public static void Trigger<T>(IEnumerable<NetworkedPlayerInfo> winners) where T : CustomGameOver
+    public static void Trigger<T>(IEnumerable<NetworkedPlayerInfo> winners)
+        where T : CustomGameOver
     {
         var reason = GameOverManager.GetGameOverId<T>();
         var data = new GameOverData(reason, [.. winners]);
@@ -67,10 +69,10 @@ public abstract class CustomGameOver
     }
 
     /// <summary>
-    /// Implicitly convert a CustomGameOver to a GameOverReason.
+    /// Implicitly convert a <see cref="CustomGameOver"/> to a <see cref="global::GameOverReason"/>.
     /// </summary>
-    /// <param name="gameOver">The CustomGameOver instance.</param>
-    /// <returns>The GameOverReason associated with the CustomGameOver.</returns>
+    /// <param name="gameOver">The <see cref="CustomGameOver"/> instance.</param>
+    /// <returns>The <see cref="global::GameOverReason"/> associated with the CustomGameOver.</returns>
     public static implicit operator GameOverReason(CustomGameOver gameOver)
     {
         return (GameOverReason)GameOverManager.GetGameOverId(gameOver.GetType());

MiraAPI/GameEnd/GameOverManager.cs

@@ -1,26 +1,25 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
-using Reactor.Utilities;
 
 namespace MiraAPI.GameEnd;
 
 /// <summary>
-/// Manage custom game overs.
+/// Manage <see cref="CustomGameOver"/>s.
 /// </summary>
 public static class GameOverManager
 {
     private static readonly Dictionary<Type, int> GameOverIds = [];
     private static readonly Dictionary<int, Type> GameOverTypes = [];
 
-    private static int _nextId = Enum.GetNames<GameOverReason>().Length;
+    private static int nextId = Enum.GetNames<GameOverReason>().Length;
 
     /// <summary>
-    /// Register a custom game over.
+    /// Register a <see cref="CustomGameOver"/>.
     /// </summary>
-    /// <param name="gameOverType">Type of the custom game over.</param>
-    /// <exception cref="ArgumentException">Thrown when the type is not a subclass of CustomGameOver, is abstract, or does not have a parameterless constructor.</exception>
-    /// <returns>>True if the game over was registered successfully, false otherwise.</returns>
+    /// <param name="gameOverType">Type of the <see cref="CustomGameOver"/>.</param>
+    /// <exception cref="ArgumentException">Thrown when the type is not a subclass of <see cref="CustomGameOver"/>, is abstract, or does not have a parameterless constructor.</exception>
+    /// <returns><see langword="true"/> if the game over was registered successfully, <see langword="false"/> otherwise.</returns>
     public static bool RegisterGameOver(Type gameOverType)
     {
         if (!typeof(CustomGameOver).IsAssignableFrom(gameOverType))
@@ -40,18 +39,18 @@ public static class GameOverManager
             return false;
         }
 
-        GameOverIds.Add(gameOverType, _nextId);
-        GameOverTypes.Add(_nextId, gameOverType);
-        _nextId++;
+        GameOverIds.Add(gameOverType, nextId);
+        GameOverTypes.Add(nextId, gameOverType);
+        nextId++;
         return true;
     }
 
     /// <summary>
-    /// Create an instance of a custom game over.
+    /// Create an instance of a <see cref="CustomGameOver"/>.
     /// </summary>
-    /// <param name="id">ID of the custom game over.</param>
-    /// <param name="customGameOver">The created instance of the custom game over.</param>
-    /// <returns>An instance of the custom game over.</returns>
+    /// <param name="id">ID of the <see cref="CustomGameOver"/>.</param>
+    /// <param name="customGameOver">The created instance of the <see cref="CustomGameOver"/>.</param>
+    /// <returns>An instance of the <see cref="CustomGameOver"/>.</returns>
     public static bool TryGetGameOver(int id, [NotNullWhen(true)] out CustomGameOver? customGameOver)
     {
         if (GameOverTypes.TryGetValue(id, out var gameOverType))
@@ -65,26 +64,26 @@ public static class GameOverManager
     }
 
     /// <summary>
-    /// Get the ID of a custom game over.
+    /// Get the ID of a <see cref="CustomGameOver"/>.
     /// </summary>
-    /// <typeparam name="T">Type of the custom game over.</typeparam>
-    /// <returns>The ID of the custom game over.</returns>
-    public static int GetGameOverId<T>() where T : CustomGameOver
+    /// <typeparam name="T">Type of the <see cref="CustomGameOver"/>.</typeparam>
+    /// <returns>The ID of the <see cref="CustomGameOver"/>.</returns>
+    public static int GetGameOverId<T>()
+        where T : CustomGameOver
     {
         return GetGameOverId(typeof(T));
     }
 
     /// <summary>
-    /// Get the ID of a custom game over.
+    /// Get the ID of a <see cref="CustomGameOver"/>.
     /// </summary>
-    /// <param name="gameOverType">Type of the custom game over.</param>
-    /// <returns>The ID of the custom game over.</returns>
+    /// <param name="gameOverType">Type of the <see cref="CustomGameOver"/>.</param>
+    /// <returns>The ID of the <see cref="CustomGameOver"/>.</returns>
     /// <exception cref="ArgumentException">Thrown when the type is not registered.</exception>
     public static int GetGameOverId(Type gameOverType)
     {
-        if (GameOverIds.TryGetValue(gameOverType, out var id))
-            return id;
-
-        throw new ArgumentException($"{gameOverType.FullName} is not a registered custom game over!");
+        return GameOverIds.TryGetValue(gameOverType, out var id)
+            ? id
+            : throw new ArgumentException($"{gameOverType.FullName} is not a registered custom game over!");
     }
 }

MiraAPI/GameModes/.editorconfig

@@ -1,2 +0,0 @@
-[*.cs]
-dotnet_diagnostic.CS1591.severity = none

MiraAPI/GameModes/AbstractGameMode.cs

@@ -0,0 +1,317 @@
+using System.Collections;
+using System.Collections.Generic;
+using AmongUs.GameOptions;
+using MiraAPI.GameOptions;
+using MiraAPI.PluginLoading;
+using MiraAPI.Translation;
+using MiraAPI.Utilities.Assets;
+using Reactor.Utilities.Extensions;
+using TMPro;
+using UnityEngine;
+
+namespace MiraAPI.GameModes;
+
+/// <summary>
+/// Base class for custom gamemodes.
+/// </summary>
+[MiraIgnore]
+public abstract class AbstractGameMode : IOptionable
+{
+    /// <summary>
+    /// Gets the game mode name.
+    /// </summary>
+    public abstract string Name { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the mode is visible in the menu. Only checked at startup.
+    /// </summary>
+    public virtual bool HideMode => false;
+
+    /// <summary>
+    /// Gets the game mode description.
+    /// </summary>
+    public abstract string Description { get; }
+
+    /// <summary>
+    /// Gets the game mode color to display on the lobby pane.
+    /// </summary>
+    public virtual Color Color { get; } = Color.white;
+
+    /// <summary>
+    /// Gets the icon of the gamemode. Will be shown in options menu underneath the gamemode option.
+    /// </summary>
+    public virtual LoadableAsset<Sprite>? Icon => null;
+
+    /// <summary>
+    /// Gets or sets the icon of the gamemode for use on the options pop-up.
+    /// </summary>
+    public TMP_SpriteAsset TmpIcon { get; set; } = null!;
+
+    /// <summary>
+    /// Gets the colored game mode name, using the color and name properties.
+    /// </summary>
+    public string ColoredName => $"<color=#{Color.ToHtmlStringRGBA()}>{MiraLocaleManager.Get(Name)}</color>";
+
+    /// <summary>
+    /// Gets the game mode id.
+    /// </summary>
+    public uint ID { get; internal set; }
+
+    /// <summary>
+    /// Gets a value indicating whether a specific body type is used by the game mode.
+    /// </summary>
+    public virtual bool GameModeBodyTypeOverride => false;
+
+    /// <summary>
+    /// Gets a value indicating whether the gamemode removes the normal game settings.
+    /// </summary>
+    public virtual bool ShowNormalGameSettings => true;
+
+    /// <summary>
+    /// Gets a value indicating whether the gamemode removes the normal role settings.
+    /// </summary>
+    public virtual bool ShowNormalRoleSettings => true;
+
+    /// <summary>
+    /// Gets a value indicating the default kill cooldown for impostors in this mode.
+    /// </summary>
+    public virtual float DefaultImpostorKillCooldown => GameOptionsManager.Instance.CurrentGameOptions.GetFloat(FloatOptionNames.KillCooldown);
+
+    /// <summary>
+    /// Called on GameManager.GetBodyType().
+    /// </summary>
+    /// <param name="player">Player to get body type from.</param>
+    /// <returns>Resulting body type.</returns>
+    public virtual PlayerBodyTypes GetBodyType(PlayerControl player)
+    {
+        return AprilFoolsMode.ShouldHorseAround()
+            ? PlayerBodyTypes.Horse
+            : (AprilFoolsMode.ShouldLongAround()
+                ? PlayerBodyTypes.Long
+                : PlayerBodyTypes.Normal);
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether a custom intro sequence is implemented by the game mode.
+    /// </summary>
+    public virtual bool ShowGameModeIntroCutscene => false;
+
+    /// <summary>
+    /// Called when Intro Cutscene is destroyed.
+    /// </summary>
+    public virtual void Initialize()
+    {
+    }
+
+    /// <summary>
+    /// Called on HudManager.Start().
+    /// </summary>
+    /// <param name="instance">Instance of HudManager.</param>
+    public virtual void HudStart(HudManager instance)
+    {
+    }
+
+    /// <summary>
+    /// Called every frame on HudManager.Update().
+    /// </summary>
+    /// <param name="instance">Instance of HudManager.</param>
+    public virtual void HudUpdate(HudManager instance)
+    {
+    }
+
+    /// <summary>
+    /// Called when a player is killed.
+    /// </summary>
+    /// <param name="player">PlayerControl that was killed.</param>
+    /// <param name="assignGhostRole">Determines whether to assign a ghost role on the player.</param>
+    public virtual void OnPlayerDeath(PlayerControl player, bool assignGhostRole)
+    {
+        GameManager.Instance.LogicRoleSelection.OnPlayerDeath(player, assignGhostRole);
+    }
+
+    /// <summary>
+    /// Calculate Game End logic.
+    /// </summary>
+    /// <param name="runOriginal">Should original game end logic be used.</param>
+    /// <param name="instance">Instance of LogicGameFlowNormal.</param>
+    public virtual void CheckGameEnd(out bool runOriginal, LogicGameFlowNormal instance)
+    {
+        runOriginal = true;
+    }
+
+    /// <summary>
+    /// Custom role assignment.
+    /// </summary>
+    /// <param name="runOriginal">Should original role assignment be used.</param>
+    /// <param name="instance">Instance of LogicRoleSelection.</param>
+    public virtual void AssignRoles(out bool runOriginal, LogicRoleSelectionNormal instance)
+    {
+        runOriginal = true;
+    }
+
+    /// <summary>
+    /// Custom role assignment to run after all roles are handed out.
+    /// </summary>
+    /// <param name="instance">Instance of LogicRoleSelection.</param>
+    public virtual void PostAssignRoles(LogicRoleSelectionNormal instance)
+    {
+    }
+
+    /// <summary>
+    /// Custom murder logic.
+    /// </summary>
+    /// <param name="runOriginal">Should the original murder logic be used.</param>
+    /// <param name="result">Result of custom murder logic.</param>
+    /// <param name="target">Target player for murder.</param>
+    public virtual void CanKill(out bool runOriginal, out bool result, PlayerControl target)
+    {
+        result = false;
+        runOriginal = true;
+    }
+
+    /// <summary>
+    /// Custom winner selection.
+    /// </summary>
+    /// <returns>List of winners or null.</returns>
+    public virtual List<NetworkedPlayerInfo>? CalculateWinners()
+    {
+        return null;
+    }
+
+    /// <summary>
+    /// The IEnumerator that plays the intro cutscene for this gamemode.
+    /// </summary>
+    /// <param name="introCutscene">An instance of IntroCutscene.</param>
+    /// <returns>An IEnumerator to run the intro cutscene instead of the base game one.</returns>
+    public virtual IEnumerator IntroCutscene(IntroCutscene introCutscene)
+    {
+        yield return new WaitForEndOfFrame();
+    }
+
+    /// <summary>
+    /// Can Admin be used in this gamemode.
+    /// </summary>
+    /// <param name="console">Admin Console.</param>
+    /// <returns>True if Admin console is enabled.</returns>
+    public virtual bool CanUseMapConsole(MapConsole console)
+    {
+        return true;
+    }
+
+    /// <summary>
+    /// Can a body be reported in this gamemode.
+    /// </summary>
+    /// <param name="body">Target body for reporting.</param>
+    /// <returns>True if dead bodies can be reported.</returns>
+    public virtual bool CanReport(DeadBody body)
+    {
+        return true;
+    }
+
+    /// <summary>
+    /// Can system consoles be used in this gamemode.
+    /// </summary>
+    /// <param name="console">System Console.</param>
+    /// <returns>True if system consoles are enabled in this mode.</returns>
+    public virtual bool CanUseSystemConsole(SystemConsole console)
+    {
+        return true;
+    }
+
+    /// <summary>
+    /// Can tasks be interacted with in this gamemode.
+    /// </summary>
+    /// <param name="console">Task console.</param>
+    /// <returns>True if tasks are enabled in this mode.</returns>
+    public virtual bool CanUseTasks(Console console)
+    {
+        return true;
+    }
+
+    /// <summary>
+    /// Should the sabotage map be used when attempting to open sabotage overlay.
+    /// </summary>
+    /// <param name="map">MapBehaviour object.</param>
+    /// <returns>True if the sabotage map should be shown.</returns>
+    public virtual bool ShouldShowSabotageMap(MapBehaviour map)
+    {
+        return true;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="MapOptions"/> to display on the map.
+    /// </summary>
+    /// <returns>The <see cref="MapOptions"/> for the gamemode.</returns>
+    public virtual MapOptions GetMapOptions()
+    {
+        return new MapOptions
+        {
+            Mode = PlayerControl.LocalPlayer.Data.Role.IsImpostor && !MeetingHud.Instance
+                ? MapOptions.Modes.Sabotage
+                : MapOptions.Modes.Normal,
+        };
+    }
+
+    /// <summary>
+    /// Can a player vent in this gamemode.
+    /// </summary>
+    /// <param name="vent">Target vent.</param>
+    /// <param name="playerInfo">Player attempting to vent.</param>
+    /// <returns>True if venting is enabled in this mode.</returns>
+    public virtual bool CanVent(Vent vent, NetworkedPlayerInfo playerInfo)
+    {
+        return true;
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the task bar appears in the gamemode.
+    /// </summary>
+    /// <returns>True if the task bar is enabled in this mode.</returns>
+    public virtual bool ShowTaskBar => true;
+
+    /// <summary>
+    /// Updates the task panel.
+    /// </summary>
+    /// <param name="instance">The task panel to update.</param>
+    public virtual void UpdateTaskPanel(TaskPanelBehaviour instance)
+    {
+        instance.background.transform.localScale = instance.taskText.textBounds.size.x > 0f
+            ? new Vector3(instance.taskText.textBounds.size.x + 0.2f, instance.taskText.textBounds.size.y + 0.2f, 1f)
+            : Vector3.zero;
+        var vector = instance.background.sprite.bounds.extents;
+        vector.y = -vector.y;
+        vector = vector.Mul(instance.background.transform.localScale);
+        instance.background.transform.localPosition = vector;
+        var vector2 = instance.tab.sprite.bounds.extents;
+        vector2 = vector2.Mul(instance.tab.transform.localScale);
+        vector2.y = -vector2.y;
+        vector2.x += vector.x * 2f;
+        instance.tab.transform.localPosition = vector2;
+
+        if (GameManager.Instance == null)
+        {
+            return;
+        }
+
+        var yPos = 0.6f;
+        var xPos = -instance.background.sprite.bounds.size.x * instance.background.transform.localScale.x;
+        instance.closedPosition = new Vector3(xPos, yPos, instance.closedPosition.z);
+        instance.openPosition = new Vector3(instance.openPosition.x, yPos, instance.openPosition.z);
+        instance.timer = instance.open
+            ? Mathf.Min(1f, instance.timer + (Time.deltaTime / instance.animationTimeSeconds))
+            : Mathf.Max(0f, instance.timer - (Time.deltaTime / instance.animationTimeSeconds));
+
+        Vector3 relativePos = new(
+            Mathf.SmoothStep(instance.closedPosition.x, instance.openPosition.x, instance.timer),
+            yPos,
+            instance.openPosition.z);
+        instance.transform.localPosition =
+            AspectPosition.ComputePosition(AspectPosition.EdgeAlignments.LeftTop, relativePos);
+    }
+
+    /// <inheritdoc/>
+    public override string ToString()
+    {
+        return Name;
+    }
+}

MiraAPI/GameModes/ClassicMode.cs

@@ -0,0 +1,21 @@
+using MiraAPI.PluginLoading;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.GameModes;
+
+/// <summary>
+/// The classic game mode.
+/// </summary>
+[MiraIgnore]
+public class ClassicMode : AbstractGameMode
+{
+    /// <inheritdoc/>
+    public override string Name => "MiraApi.Gamemode.Classic";
+
+    /// <inheritdoc/>
+    public override string Description => "MiraApi.Gamemode.Classic.Description";
+
+    /// <inheritdoc/>
+    public override LoadableAsset<Sprite> Icon => MiraAssets.ClassicGamemodeIcon;
+}

MiraAPI/GameModes/CustomGameMode.cs

@@ -1,154 +0,0 @@
-using System.Collections.Generic;
-
-namespace MiraAPI.GameModes;
-
-/// <summary>
-/// Base class for custom gamemodes.
-/// </summary>
-public abstract class CustomGameMode
-{
-    /// <summary>
-    /// Gets the game mode name.
-    /// </summary>
-    public abstract string Name { get; }
-
-    /// <summary>
-    /// Gets the game mode description.
-    /// </summary>
-    public abstract string Description { get; }
-
-    /// <summary>
-    /// Gets the game mode ID.
-    /// </summary>
-    public abstract int Id { get; }
-
-    /// <summary>
-    /// Called when Intro Cutscene is destroyed.
-    /// </summary>
-    public virtual void Initialize()
-    {
-    }
-
-    /// <summary>
-    /// Called on HudManager.Start().
-    /// </summary>
-    /// <param name="instance">Instance of HudManager.</param>
-    public virtual void HudStart(HudManager instance)
-    {
-    }
-
-    /// <summary>
-    /// Called every frame on HudManager.Update().
-    /// </summary>
-    /// <param name="instance">Instance of HudManager.</param>
-    public virtual void HudUpdate(HudManager instance)
-    {
-    }
-
-    /// <summary>
-    /// Called when a player is killed.
-    /// </summary>
-    /// <param name="player">PlayerControl that was killed.</param>
-    public virtual void OnDeath(PlayerControl player)
-    {
-    }
-
-    /// <summary>
-    /// Calculate Game End logic.
-    /// </summary>
-    /// <param name="runOriginal">Should original game end logic be used.</param>
-    /// <param name="instance">Instance of LogicGameFlowNormal.</param>
-    public virtual void CheckGameEnd(out bool runOriginal, LogicGameFlowNormal instance)
-    {
-        runOriginal = true;
-    }
-
-    /// <summary>
-    /// Custom role assignment.
-    /// </summary>
-    /// <param name="runOriginal">Should original role assignment be used.</param>
-    /// <param name="instance">Instance of LogicRoleSelection.</param>
-    public virtual void AssignRoles(out bool runOriginal, LogicRoleSelectionNormal instance)
-    {
-        runOriginal = true;
-    }
-
-    /// <summary>
-    /// Custom murder logic.
-    /// </summary>
-    /// <param name="runOriginal">Should the original murder logic be used.</param>
-    /// <param name="result">Result of custom murder logic.</param>
-    /// <param name="target">Target player for murder.</param>
-    public virtual void CanKill(out bool runOriginal, out bool result, PlayerControl target)
-    {
-        result = false;
-        runOriginal = true;
-    }
-
-    /// <summary>
-    /// Should Roles Settings be available when this gamemode is selected.
-    /// </summary>
-    /// <returns>True if Role Settings are enabled in this game mode.</returns>
-    public virtual bool AreRoleSettingsEnabled() => true;
-
-    /// <summary>
-    /// Should Game Settings be available when this gamemode is selected.
-    /// </summary>
-    /// <returns>True if Game Settings are enabled in this mode.</returns>
-    public virtual bool AreGameSettingsEnabled() => true;
-
-    /// <summary>
-    /// Custom winner selection.
-    /// </summary>
-    /// <returns>List of winners or null.</returns>
-    public virtual List<NetworkedPlayerInfo>? CalculateWinners() => null;
-
-    /// <summary>
-    /// Show gamemode in Intro Cutscene.
-    /// </summary>
-    /// <returns>True if the game mode should be shown in the intro cutscene.</returns>
-    public virtual bool ShowGameModeIntroCutscene() => false;
-
-    /// <summary>
-    /// Can Admin be used in this gamemode.
-    /// </summary>
-    /// <param name="console">Admin Console.</param>
-    /// <returns>True if Admin console is enabled.</returns>
-    public virtual bool CanUseMapConsole(MapConsole console) => true;
-
-    /// <summary>
-    /// Can a body be reported in this gamemode.
-    /// </summary>
-    /// <param name="body">Target body for reporting.</param>
-    /// <returns>True if dead bodies can be reported.</returns>
-    public virtual bool CanReport(DeadBody body) => true;
-
-    /// <summary>
-    /// Can system consoles be used in this gamemode.
-    /// </summary>
-    /// <param name="console">System Console.</param>
-    /// <returns>True if system consoles are enabled in this mode.</returns>
-    public virtual bool CanUseSystemConsole(SystemConsole console) => true;
-
-    /// <summary>
-    /// Can tasks be interacted with in this gamemode.
-    /// </summary>
-    /// <param name="console">Task console.</param>
-    /// <returns>True if tasks are enabled in this mode.</returns>
-    public virtual bool CanUseTasks(Console console) => true;
-
-    /// <summary>
-    /// Should the sabotage map be used when attempting to open sabotage overlay.
-    /// </summary>
-    /// <param name="map">MapBehaviour object.</param>
-    /// <returns>True if the sabotage map should be shown.</returns>
-    public virtual bool ShouldShowSabotageMap(MapBehaviour map) => true;
-
-    /// <summary>
-    /// Can a player vent in this gamemode.
-    /// </summary>
-    /// <param name="vent">Target vent.</param>
-    /// <param name="playerInfo">Player attempting to vent.</param>
-    /// <returns>True if venting is enabled in this mode.</returns>
-    public virtual bool CanVent(Vent vent, NetworkedPlayerInfo playerInfo) => true;
-}

MiraAPI/GameModes/CustomGameModeManager.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using Reactor.Utilities;
+using MiraAPI.PluginLoading;
 
 namespace MiraAPI.GameModes;
 
@@ -10,62 +10,131 @@ namespace MiraAPI.GameModes;
 /// </summary>
 public static class CustomGameModeManager
 {
-    /// <summary>
-    /// List of registered gamemodes.
-    /// </summary>
-    internal static readonly Dictionary<int, CustomGameMode> GameModes = [];
+    internal static readonly Dictionary<uint, AbstractGameMode> IdToModeMap = [];
 
-    public static bool IsDefault()
+    private static uint GetNextId()
     {
-        return ActiveMode?.Id == 0;
+        return ++LastId;
+    }
+
+    private static uint LastId { get; set; }
+
+    /// <summary>
+    /// Register gamemode from type.
+    /// </summary>
+    /// <param name="gameModeType">Type of gamemode class, should inherit from <see cref="AbstractGameMode"/>.</param>
+    /// <param name="pluginInfo">The custom plugin info of the mod.</param>
+    /// <returns>Whether the gamemode was successfully registered.</returns>
+    internal static bool RegisterGameMode(Type gameModeType, MiraPluginInfo pluginInfo)
+    {
+        if (!typeof(AbstractGameMode).IsAssignableFrom(gameModeType))
+        {
+            Warning($"{gameModeType.Name} does not inherit CustomGameMode!");
+            return false;
+        }
+
+        var instance = Activator.CreateInstance(gameModeType);
+
+        if (instance is not AbstractGameMode mode)
+        {
+            Error($"Failed to create instance of {gameModeType.Name}");
+            return false;
+        }
+
+        if (mode.HideMode)
+            return true;
+
+        IdToModeMap.Add(GetNextId(), mode);
+        pluginInfo.GameModes.Add(LastId, mode);
+        mode.ID = LastId;
+        GameModeOption.AddOption(mode);
+        return true;
+    }
+
+    /// <summary>
+    /// Checks to see if the current game mode is an instance of the classic mode.
+    /// </summary>
+    /// <returns>True if the classic mode is the current one.</returns>
+    public static bool IsClassic()
+    {
+        return ActiveMode != null && ActiveMode.GetType().IsAssignableTo(typeof(ClassicMode));
+    }
+
+    /// <summary>
+    /// Checks to see if the current game mode is an instance of the HNS mode.
+    /// </summary>
+    /// <returns>True if the Hide n Seek mode is the current one.</returns>
+    public static bool IsHideNSeek()
+    {
+        return ActiveMode != null && ActiveMode.GetType().IsAssignableTo(typeof(HideAndSeekMode));
+    }
+
+    /// <summary>
+    /// Checks if a provided GameMode is the current active one.
+    /// </summary>
+    /// <typeparam name="T">The AbstractGameMode subclass being checked.</typeparam>
+    /// <returns>Whether the provided mode is the current active one.</returns>
+    public static bool IsActiveGameMode<T>()
+        where T : AbstractGameMode
+    {
+        return ActiveMode is T;
     }
 
     /// <summary>
     /// Gets the current gamemode.
     /// </summary>
-    public static CustomGameMode? ActiveMode { get; internal set; } = new DefaultMode();
+    public static AbstractGameMode? ActiveMode { get; private set; }
 
     /// <summary>
-    /// Set current gamemode.
+    /// Gets a gamemode from an ID.
     /// </summary>
-    /// <param name="id">gamemode ID.</param>
-    public static void SetGameMode(int id)
+    /// <param name="id">The ID of the gamemode to fetch.</param>
+    /// <returns>The gamemode matching that ID.</returns>
+    public static AbstractGameMode GetMode(uint id)
     {
-        if (GameModes.TryGetValue(id, out var gameMode))
-        {
-            ActiveMode = gameMode;
-            return;
-        }
-
-        Error($"No gamemode with id {id} found!");
+        return IdToModeMap[id];
     }
 
     /// <summary>
-    /// Register gamemode from type.
+    /// Finds the parent mod of a custom gamemode.
     /// </summary>
-    /// <param name="gameModeType">Type of gamemode class, should inherit from <see cref="CustomGameMode"/>.</param>
-    internal static void RegisterGameMode(Type gameModeType)
+    /// <param name="gameMode">The <see cref="AbstractGameMode"/> object.</param>
+    /// <returns>A <see cref="MiraPluginInfo"/> object representing the parent mod of the gamemode.</returns>
+    public static MiraPluginInfo? FindParentMod(AbstractGameMode gameMode)
     {
-        if (!typeof(CustomGameMode).IsAssignableFrom(gameModeType))
+        return MiraPluginManager.Instance.RegisteredPlugins.FirstOrDefault(plugin => plugin.GameModes.ContainsValue(gameMode));
+    }
+
+    internal static void RegisterDefaultMode()
+    {
+        var defaultMode = new ClassicMode();
+        IdToModeMap.Add(0, defaultMode);
+
+        // no need to add to game mode option as it already contains it
+        // because we cannot have the option be created with no values
+        defaultMode.ID = 0;
+        var hnsMode = new HideAndSeekMode();
+
+        if (hnsMode.HideMode)
+            return;
+
+        IdToModeMap.Add(1, hnsMode);
+        hnsMode.ID = 1;
+        GameModeOption.AddOption(hnsMode);
+        LastId++;
+    }
+
+    internal static void GetAndSetGameMode()
+    {
+        var id = (uint)GameModeOption.Value;
+
+        if (IdToModeMap.TryGetValue(id, out var mode))
         {
-            Warning($"{gameModeType.Name} does not inherit CustomGameMode!");
+            ActiveMode = mode;
             return;
         }
 
-        var modeObj = Activator.CreateInstance(gameModeType);
-
-        if (modeObj is not CustomGameMode gameMode)
-        {
-            Error($"Failed to create instance of {gameModeType.Name}");
-            return;
-        }
-
-        if (GameModes.Any(x => x.Key == gameMode.Id))
-        {
-            Error($"ID for gamemode {gameMode.Name} already exists!");
-            return;
-        }
-
-        GameModes.Add(gameMode.Id, gameMode);
+        ActiveMode = IdToModeMap[0];
+        Warning($"Unable to find game mode of id {id}!");
     }
 }

MiraAPI/GameModes/DefaultMode.cs

@@ -1,8 +0,0 @@
-namespace MiraAPI.GameModes;
-
-public class DefaultMode : CustomGameMode
-{
-    public override string Name => "Default";
-    public override string Description => "Default Among Us GameMode";
-    public override int Id => 0;
-}

MiraAPI/GameModes/GameModeOption.cs

@@ -0,0 +1,161 @@
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using HarmonyLib;
+using MiraAPI.GameOptions;
+using MiraAPI.Networking;
+using MiraAPI.Patches.GameModes;
+using MiraAPI.Patches.Options;
+using MiraAPI.Translation;
+using Reactor.Networking.Attributes;
+using UnityEngine;
+
+namespace MiraAPI.GameModes;
+
+/// <summary>
+/// The game mode option.
+/// </summary>
+[HarmonyPatch]
+public static class GameModeOption
+{
+    /// <summary>
+    /// Gets the current index of the Game Mode Option.<br/>
+    /// For the value as an <see cref="AbstractGameMode"/>, see <see cref="CustomGameModeManager.ActiveMode"/>.
+    /// </summary>
+    public static int Value
+    {
+        get =>
+            OptionBehaviour != null
+                ? OptionBehaviour.GetInt()
+                : LastValue;
+        private set
+        {
+            LastValue = value;
+            if (OptionBehaviour == null)
+                return;
+            OptionBehaviour.Value = value;
+            OptionBehaviour.UpdateValue();
+            LastValue = value;
+        }
+    }
+
+    internal static readonly StringNames GamemodeName = MiraLocaleManager.GetOrCreateLocaleString("Gamemode");
+    internal static readonly StringNames CustomName = MiraLocaleManager.GetOrCreateLocaleString("Custom");
+    internal static readonly Dictionary<uint, StringNames> Values = new()
+    {
+        [0] = MiraLocaleManager.GetOrCreateLocaleString("MiraApi.Gamemode.Classic"),
+    };
+
+    internal static StringOption OptionBehaviour { get; set; } = null!;
+
+    [SuppressMessage("Critical Code Smell", "S2223:Non-constant static fields should not be visible", Justification = "Internal behaviour that does not need property-level validation.")]
+    [SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "Read above.")] // why so many warnings???
+    internal static int LastValue;
+
+    internal static void AddOption(AbstractGameMode mode)
+    {
+        if (!Values.ContainsKey(mode.ID))
+            Values.Add(mode.ID, MiraLocaleManager.GetOrCreateLocaleString(mode.Name));
+    }
+
+    /*[HarmonyPatch(typeof(GameOptionsMenu), nameof(GameOptionsMenu.CreateSettings))]
+    [HarmonyPostfix]
+    private static void CreateSettingsPatch(GameOptionsMenu __instance)
+    {
+        if (MenuState.Instance.CurrentModIdx != 0 || GameManager.Instance.IsHideAndSeek() || CustomGameModeManager.ActiveMode == null)
+        {
+            return;
+        }
+
+        var num = 0.713f;
+
+        foreach (var category in __instance.settingsContainer.GetComponentsInChildren<CategoryHeaderMasked>())
+        {
+            if (category)
+                category.gameObject.transform.localPosition -= new Vector3(0, 1.3f, 0);
+        }
+        CategoryHeaderMasked categoryHeaderMasked = Object.Instantiate(__instance.categoryHeaderOrigin, Vector3.zero, Quaternion.identity, __instance.settingsContainer);
+        categoryHeaderMasked.SetHeader(CustomName, 20);
+        categoryHeaderMasked.transform.localScale = Vector3.one * 0.63f;
+        categoryHeaderMasked.transform.localPosition = new Vector3(-0.903f, num, -2f);
+        OptionBehaviour = Object.Instantiate(
+            __instance.stringOptionOrigin,
+            Vector3.zero,
+            Quaternion.identity,
+            __instance.settingsContainer);
+        num -= 0.63f;
+        OptionBehaviour.transform.localPosition = new Vector3(0.952f, num, -2f);
+        OptionBehaviour.SetClickMask(__instance.ButtonClickMask);
+        StringGameSetting setting = ScriptableObject.CreateInstance<StringGameSetting>();
+        setting.Type = OptionTypes.MultipleChoice;
+        setting.Title = GamemodeName;
+        setting.Index = _lastValue;
+        setting.Values = new Il2CppStructArray<StringNames>([Values[0]]);
+        OptionBehaviour.SetUpFromData(setting, 20);
+        Set(_lastValue);
+        OptionBehaviour.TitleText.fontSize = 3;
+        foreach (var optionBehaviour in __instance.Children.ToArray().Skip(1))
+        {
+            optionBehaviour.gameObject.transform.localPosition -= new Vector3(0, 1.3f, 0);
+        }
+        __instance.Children.Add(OptionBehaviour);
+        for (var i = 1; i < Values.Count; i++)
+            OptionBehaviour.Values = (Il2CppStructArray<StringNames>)OptionBehaviour.Values.Add(Values.ElementAt(i).Value);
+        __instance.scrollBar.SetYBoundsMax(__instance.scrollBar.GetYBounds().max + 1);
+    }*/
+
+    internal static void Set(int val)
+    {
+        Value = val;
+        var previousMode = CustomGameModeManager.ActiveMode;
+        CustomGameModeManager.GetAndSetGameMode();
+        HudPatches.SetGameModeText(CustomGameModeManager.GetMode(Values.ElementAt(LastValue).Key).ColoredName);
+        var gm = CustomGameModeManager.ActiveMode!;
+
+        if (gm != previousMode)
+        {
+            ModdedOptionsManager.AddSettingsChangeMessage(
+                HudManager.Instance.Notifier,
+                GamemodeName,
+                gm.ColoredName,
+                new Color(0.7333f, 0.7333f, 0.7333f, 1),
+                gm.TmpIcon);
+            if (MenuState.Instance)
+            {
+                // should force reset roles for gamemodes properly
+                foreach (var roleMenu in MenuState.Instance.QueuedRoleMenuRefresh)
+                {
+                    MenuState.Instance.QueuedRoleMenuRefresh[roleMenu.Key] = true;
+                }
+            }
+        }
+
+        // TODO: could make Values a dict of AbstractGameMode too
+    }
+
+    [HarmonyPatch(typeof(GameOptionsMenu), nameof(GameOptionsMenu.ValueChanged))]
+    [HarmonyPrefix]
+    private static bool ValueChanged(GameOptionsMenu __instance, OptionBehaviour option)
+    {
+        if (!OptionBehaviour.Equals(option))
+            return true;
+
+        Info($"Game mode changed to {option.GetInt()}");
+        RpcSyncGamemode(PlayerControl.LocalPlayer, option.GetInt());
+
+        if (GameSettingMenu.Instance && CustomGameModeManager.ActiveMode != null)
+        {
+            GameOptionsMenuPatch.ToggleGamemodeOptions(CustomGameModeManager.ActiveMode, __instance);
+            GameSettingMenu.Instance.RoleSettingsButton.gameObject.SetActive(CustomGameModeManager.ActiveMode.ShowNormalRoleSettings);
+        }
+
+        return false;
+    }
+
+    [MethodRpc((uint)MiraRpc.SyncGamemodeOption)]
+    [SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Intentionally unused because the main intent is for it to be used by dependent mods to add to a blacklist.")]
+    internal static void RpcSyncGamemode(PlayerControl host, int data)
+    {
+        Set(data);
+    }
+}

MiraAPI/GameModes/HideAndSeekMode.cs

@@ -0,0 +1,544 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
+using System.Linq;
+using AmongUs.Data;
+using AmongUs.GameOptions;
+using HarmonyLib;
+using InnerNet;
+using MiraAPI.GameOptions;
+using MiraAPI.HnsReimplemented;
+using MiraAPI.HnsReimplemented.Options;
+using MiraAPI.PluginLoading;
+using MiraAPI.Roles;
+using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
+using PowerTools;
+using UnityEngine;
+
+namespace MiraAPI.GameModes;
+
+/// <summary>
+/// The vanilla Hide and Seek game mode, ported to Mira.
+/// </summary>
+[MiraIgnore]
+public class HideAndSeekMode : AbstractGameMode
+{
+    /// <inheritdoc/>
+    public override string Name => "MiraApi.Gamemode.HideAndSeek";
+
+    /// <inheritdoc/>
+    public override string Description => "MiraApi.Gamemode.HideAndSeek.Description";
+
+    /// <inheritdoc/>
+    // TODO: Once the Hide n Seek port is ready for release, we will remove this.
+    public override bool HideMode => !MiraApiPlugin.IsDevBuild;
+
+    /// <inheritdoc/>
+    public override Color Color { get; } = new Color32(255, 88, 90, 255);
+
+    /// <inheritdoc/>
+    public override LoadableAsset<Sprite> Icon => MiraAssets.HnSGamemodeIcon;
+
+    /// <inheritdoc/>
+    public override bool ShowGameModeIntroCutscene => true;
+
+    /// <inheritdoc/>
+    public override bool GameModeBodyTypeOverride => true;
+
+    /// <inheritdoc/>
+    public override bool ShowNormalGameSettings => false;
+
+    /// <inheritdoc/>
+    public override bool ShowNormalRoleSettings => false;
+
+    /// <inheritdoc/>
+    public override float DefaultImpostorKillCooldown => 1f;
+
+    /// <inheritdoc/>
+    public override bool ShowTaskBar => false;
+
+    /// <inheritdoc/>
+    public override bool CanReport(DeadBody body)
+    {
+        return false;
+    }
+
+    /// <inheritdoc/>
+    public override bool ShouldShowSabotageMap(MapBehaviour map)
+    {
+        return false;
+    }
+
+    private static int ImpostorPlayerID()
+    {
+        return OptionGroupSingleton<HnsImpostorOptions>.Instance.SelectedSeeker.Value;
+    }
+
+    private static bool HasImpostorPlayerID()
+    {
+        return ImpostorPlayerID() > -1;
+    }
+
+    private static bool ValidateImpostorPlayerID(List<NetworkedPlayerInfo> players)
+    {
+        return HasImpostorPlayerID() && players.Find(p => p.PlayerId == ImpostorPlayerID()) != null;
+    }
+
+    /// <inheritdoc/>
+    public override void AssignRoles(out bool runOriginal, LogicRoleSelectionNormal instance)
+    {
+        runOriginal = false;
+        CppCollections.List<ClientData> list = new();
+        AmongUsClient.Instance.GetAllClients(list);
+        List<NetworkedPlayerInfo> list2 = [.. list.ToArray()
+            .Where(c => c.Character != null && c.Character.Data != null && !c.Character.Data.Disconnected &&
+                        !c.Character.Data.IsDead).OrderBy(c => c.Id).Select(c => c.Character.Data)];
+
+        foreach (var networkedPlayerInfo in GameData.Instance.AllPlayers)
+        {
+            if (networkedPlayerInfo.Object != null && networkedPlayerInfo.Object.isDummy)
+            {
+                list2.Add(networkedPlayerInfo);
+            }
+        }
+
+        var currentGameOptions = GameOptionsManager.Instance.CurrentGameOptions;
+        var adjustedNumImpostors = GameOptionsManager.Instance.CurrentGameOptions.GetAdjustedNumImpostors(list2.Count);
+        AssignRolesForTeam(list2, currentGameOptions, RoleTeamTypes.Impostor, Math.Max(adjustedNumImpostors, 1), RoleTypes.Impostor);
+        AssignRolesForTeam(list2, currentGameOptions, RoleTeamTypes.Crewmate, int.MaxValue, RoleTypes.Engineer);
+    }
+
+    private static void AddGuaranteedRoles(IEnumerable<RoleBehaviour> guaranteedRoles, IGameOptions opts, List<RoleTypes> list)
+    {
+        var roleOptions = opts.RoleOptions;
+        foreach (var roleAssignmentData in guaranteedRoles.Select(x =>
+                     new RoleManager.RoleAssignmentData(x, roleOptions.GetNumPerGame(x.Role), 100)))
+        {
+            while (true)
+            {
+                var count = roleAssignmentData.Count;
+                roleAssignmentData.Count = count - 1;
+                if (count <= 0) break;
+
+                list.Add(roleAssignmentData.Role.Role);
+            }
+        }
+    }
+
+    private static void AddPotentialRoles(IEnumerable<RoleBehaviour> source, IGameOptions opts, List<RoleTypes> list)
+    {
+        var roleOptions = opts.RoleOptions;
+        var potentialRoles = source.Where(x => !x.IsDead).Select(role =>
+            new RoleManager.RoleAssignmentData(
+                role,
+                roleOptions.GetNumPerGame(role.Role),
+                roleOptions.GetChancePerGame(role.Role))).ToList();
+
+        list.Clear();
+        foreach (var roleData in potentialRoles)
+        {
+            for (var i = 0; i < roleData.Count; i++)
+            {
+                if (HashRandom.Next(101) < roleData.Chance)
+                {
+                    list.Add(roleData.Role.Role);
+                }
+            }
+        }
+    }
+
+    private static void AddFallbackRoles(List<RoleTypes> list, int targetPlayerCount, int teamMax, int rolesAssigned, RoleTypes basicRole)
+    {
+        while (list.Count < targetPlayerCount && list.Count + rolesAssigned < teamMax)
+        {
+            list.Add(basicRole);
+        }
+    }
+
+    private static void AssignRolesForTeam(
+        List<NetworkedPlayerInfo> players,
+        IGameOptions opts,
+        RoleTeamTypes team,
+        int teamMax,
+        RoleTypes defaultRole)
+    {
+        Info($"Hide And Seek Mode - AssignRolesForTeam: Team: {team}, Max: {teamMax}, Players: {players.Count}, DefaultRole: {defaultRole}");
+        var num = 0;
+        var roleOptions = opts.RoleOptions;
+        var source = RoleManager.Instance.AllRoles.ToArray()
+            .Where(role => role.TeamType == team && !RoleManager.IsGhostRole(role.Role) &&
+                           CustomRoleUtils.CanSpawnOnCurrentMode(role))
+            .ToList();
+
+        var assignmentData = source.Where(x => !x.IsDead).Select(role =>
+            new RoleManager.RoleAssignmentData(
+                role,
+                roleOptions.GetNumPerGame(role.Role),
+                roleOptions.GetChancePerGame(role.Role))).ToList();
+
+        var source2 = CustomRoleUtils.GetPossibleRoles(assignmentData, x => x.Chance == 100);
+        var guaranteedRoles = source.Where(x => source2.Contains(((ushort)x.Role, 100))).ToList();
+        List<RoleTypes> list = [];
+
+        switch (team)
+        {
+            case RoleTeamTypes.Crewmate:
+                Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Before Guaranteed Assignment");
+                AddGuaranteedRoles(guaranteedRoles, opts, list);
+                Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Guaranteed Assignment");
+                AssignRolesFromList(players, teamMax, list, ref num);
+
+                AddPotentialRoles(source, opts, list);
+                Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Potential Assignment");
+                AssignRolesFromList(players, teamMax, list, ref num);
+
+                const RoleTypes basicCrewRole = RoleTypes.Engineer;
+                AddFallbackRoles(list, players.Count, teamMax, num, basicCrewRole);
+                AssignRolesFromList(players, teamMax, list, ref num);
+                Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Fallback Assignment");
+                break;
+
+            case RoleTeamTypes.Impostor:
+                Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Before Guaranteed Assignment");
+                var newImpostors = new List<NetworkedPlayerInfo>();
+
+                if (HasImpostorPlayerID() &&
+                    ValidateImpostorPlayerID(players) &&
+                    !AmongUsClient.Instance.IsGamePublic)
+                {
+                    // Specified Seeker
+                    var networkedPlayerInfo = players.First(p => p.PlayerId == ImpostorPlayerID());
+                    players.Remove(networkedPlayerInfo);
+                    newImpostors.Add(networkedPlayerInfo);
+                    Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Seeker is {networkedPlayerInfo.PlayerName}, ID: {networkedPlayerInfo.PlayerId}");
+                }
+                else
+                {
+                    // Random Seeker
+                    var num2 = 0;
+                    while (num2 < teamMax && players.Count > 0)
+                    {
+                        PseudoRandomList<NetworkedPlayerInfo> pseudoRandomList = new(AmongUsClient.Instance.GameId);
+                        players.Do(pseudoRandomList.Add);
+                        for (var i = 0; i < GameData.RoundsPlayedInSession; i++)
+                        {
+                            pseudoRandomList.PickRandom();
+                        }
+
+                        var networkedPlayerInfo = pseudoRandomList.PickRandom();
+                        players.Remove(networkedPlayerInfo);
+                        newImpostors.Add(networkedPlayerInfo);
+                        num2++;
+                        Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: Seeker is {networkedPlayerInfo.PlayerName}, ID: {networkedPlayerInfo.PlayerId}");
+                    }
+                }
+
+                Info($"MiraAPI.Patches.Roles.LogicRoleSelectionHnsPatch - AssignRolesForTeam: After Guaranteed Assignment");
+
+                AddGuaranteedRoles(guaranteedRoles, opts, list);
+                AssignRolesFromList(newImpostors, teamMax, list, ref num);
+
+                AddPotentialRoles(source, opts, list);
+                AssignRolesFromList(newImpostors, teamMax, list, ref num);
+
+                const RoleTypes basicImpRole = RoleTypes.Impostor;
+                AddFallbackRoles(list, newImpostors.Count, teamMax, num, basicImpRole);
+                AssignRolesFromList(newImpostors, teamMax, list, ref num);
+                break;
+
+            default:
+                throw new ArgumentOutOfRangeException(nameof(team), team, null);
+        }
+    }
+
+    private static void AssignRolesFromList(List<NetworkedPlayerInfo> players, int teamMax, List<RoleTypes> roleList, ref int rolesAssigned)
+    {
+        while (roleList.Count > 0 && players.Count > 0 && rolesAssigned < teamMax)
+        {
+            var index = HashRandom.FastNext(roleList.Count);
+            var roleType = roleList[index];
+            roleList.RemoveAt(index);
+            var index2 = HashRandom.FastNext(players.Count);
+            players[index2].Object.RpcSetRole(roleType);
+            players.RemoveAt(index2);
+            rolesAssigned++;
+        }
+    }
+
+    /// <inheritdoc/>
+    public override IEnumerator IntroCutscene(IntroCutscene introCutscene)
+    {
+        SoundManager.Instance.PlaySound(introCutscene.IntroStinger, false);
+        Logger.GlobalInstance.Info("IntroCutscene :: CoBegin() :: Game Mode: Hide and Seek (MiraAPI)");
+        introCutscene.LogPlayerRoleData();
+        introCutscene.HideAndSeekPanels.SetActive(true);
+        if (PlayerControl.LocalPlayer.Data.Role.IsImpostor)
+        {
+            introCutscene.CrewmateRules.SetActive(false);
+            introCutscene.ImpostorRules.SetActive(true);
+        }
+        else
+        {
+            introCutscene.CrewmateRules.SetActive(true);
+            introCutscene.ImpostorRules.SetActive(false);
+        }
+
+        introCutscene.ImpostorName.gameObject.SetActive(true);
+        introCutscene.ImpostorTitle.gameObject.SetActive(true);
+        introCutscene.BackgroundBar.enabled = false;
+        introCutscene.TeamTitle.gameObject.SetActive(false);
+        var impostor = PlayerControl.AllPlayerControls.ToArray().FirstOrDefault(x => x.Data.Role.IsImpostor);
+        if (impostor == null)
+        {
+            Logger.GlobalInstance.Error("IntroCutscene :: CoBegin() :: impostor is NULL");
+        }
+
+        GameManager.Instance.SetSpecialCosmetics(impostor);
+        introCutscene.ImpostorName.text = impostor != null ? impostor.Data.PlayerName : "???";
+
+        yield return new WaitForSecondsRealtime(0.1f);
+        if (impostor != null)
+        {
+            introCutscene.ImpostorTitle.text = impostor.Data.Role.GetRoleName();
+        }
+
+        PoolablePlayer? playerSlot = null;
+        if (impostor != null)
+        {
+            playerSlot = introCutscene.CreatePlayer(1, 1, impostor.Data, false);
+            playerSlot.SetBodyType(PlayerBodyTypes.Normal);
+            playerSlot.SetFlipX(false);
+            playerSlot.transform.localPosition = introCutscene.impostorPos;
+            playerSlot.transform.localScale = Vector3.one * introCutscene.impostorScale;
+        }
+
+        yield return ShipStatus.Instance.CosmeticsCache.PopulateFromPlayers();
+        yield return new WaitForSecondsRealtime(6f);
+        if (playerSlot != null)
+        {
+            playerSlot.gameObject.SetActive(false);
+        }
+
+        introCutscene.HideAndSeekPanels.SetActive(false);
+        introCutscene.CrewmateRules.SetActive(false);
+        introCutscene.ImpostorRules.SetActive(false);
+        HnsMusicHandler.Instance.StartMusicWithIntro();
+        var hideTimer = 10f;
+
+        if (PlayerControl.LocalPlayer.Data.Role.IsImpostor)
+        {
+            introCutscene.HideAndSeekTimerText.gameObject.SetActive(true);
+            PoolablePlayer poolablePlayer;
+            AnimationClip anim;
+            if (AprilFoolsMode.ShouldHorseAround())
+            {
+                poolablePlayer = introCutscene.HorseWrangleVisualSuit;
+                poolablePlayer.gameObject.SetActive(true);
+                poolablePlayer.SetBodyType(PlayerBodyTypes.Seeker);
+                anim = introCutscene.HnSSeekerSpawnHorseAnim;
+                introCutscene.HorseWrangleVisualPlayer.SetBodyType(PlayerBodyTypes.Normal);
+                introCutscene.HorseWrangleVisualPlayer.UpdateFromPlayerData(
+                    PlayerControl.LocalPlayer.Data,
+                    PlayerControl.LocalPlayer.CurrentOutfitType,
+                    PlayerMaterial.MaskType.None,
+                    false);
+            }
+            else if (AprilFoolsMode.ShouldLongAround())
+            {
+                poolablePlayer = introCutscene.HideAndSeekPlayerVisual;
+                poolablePlayer.gameObject.SetActive(true);
+                poolablePlayer.SetBodyType(PlayerBodyTypes.LongSeeker);
+                anim = introCutscene.HnSSeekerSpawnLongAnim;
+            }
+            else
+            {
+                poolablePlayer = introCutscene.HideAndSeekPlayerVisual;
+                poolablePlayer.gameObject.SetActive(true);
+                poolablePlayer.SetBodyType(PlayerBodyTypes.Seeker);
+                anim = introCutscene.HnSSeekerSpawnAnim;
+            }
+
+            poolablePlayer.SetBodyCosmeticsVisible(false);
+            poolablePlayer.UpdateFromPlayerData(
+                PlayerControl.LocalPlayer.Data,
+                PlayerControl.LocalPlayer.CurrentOutfitType,
+                PlayerMaterial.MaskType.None,
+                false);
+            var component = poolablePlayer.GetComponent<SpriteAnim>();
+            poolablePlayer.gameObject.SetActive(true);
+            poolablePlayer.ToggleName(false);
+            component.Play(anim);
+            while (hideTimer > 0f)
+            {
+                introCutscene.HideAndSeekTimerText.text = Mathf.RoundToInt(hideTimer).ToString(CultureInfo.InvariantCulture);
+                hideTimer -= Time.deltaTime;
+                yield return null;
+            }
+        }
+        else
+        {
+            HideAndSeekHudHelper.Instance.HideCountdown = hideTimer;
+            if (AprilFoolsMode.ShouldHorseAround())
+            {
+                if (impostor != null)
+                {
+                    impostor.AnimateCustom(introCutscene.HnSSeekerSpawnHorseInGameAnim);
+                }
+            }
+            else if (AprilFoolsMode.ShouldLongAround())
+            {
+                if (impostor != null)
+                {
+                    impostor.AnimateCustom(introCutscene.HnSSeekerSpawnLongInGameAnim);
+                }
+            }
+            else if (impostor != null)
+            {
+                impostor.AnimateCustom(introCutscene.HnSSeekerSpawnAnim);
+                impostor.cosmetics.SetBodyCosmeticsVisible(false);
+            }
+        }
+
+        ShipStatus.Instance.StartSFX();
+        HnsMusicHandler.Instance.OnGameStart();
+        HnsDangerMeter.Instance.OnGameStart();
+        UnityEngine.Object.Destroy(introCutscene.gameObject);
+    }
+
+    /// <inheritdoc/>
+    public override void Initialize()
+    {
+        deadPlayerCount = 0;
+        ShipStatus.Instance.BreakEmergencyButton();
+        PlayerControl.LocalPlayer.SetKillTimer(0.01f);
+        if (!HudManager.InstanceExists) return;
+        HudManager.Instance.gameObject.AddComponent<HnsMusicHandler>();
+        HudManager.Instance.gameObject.AddComponent<HideAndSeekHudHelper>();
+        HudManager.Instance.gameObject.AddComponent<HnsDangerMeter>();
+    }
+
+    /// <inheritdoc/>
+    public override MapOptions GetMapOptions()
+    {
+        MapOptions mapOptions = new()
+        {
+            Mode = MapOptions.Modes.Normal,
+        };
+        if (PlayerControl.LocalPlayer.Data.Role.IsImpostor && HideAndSeekHudHelper.Instance.SeekerAdminMapEnabled(PlayerControl.LocalPlayer))
+        {
+            mapOptions.Mode = MapOptions.Modes.CountOverlay;
+            mapOptions.AllowMovementWhileMapOpen = true;
+            mapOptions.IncludeDeadBodies = false;
+            mapOptions.ShowLivePlayerPosition = false;
+        }
+
+        return mapOptions;
+    }
+
+    /// <inheritdoc/>
+    public override void CheckGameEnd(out bool runOriginal, LogicGameFlowNormal instance)
+    {
+        runOriginal = false;
+        var players = Helpers.GetAlivePlayers();
+        if (!players.Any(x => x.Data.Role.IsImpostor))
+        {
+            instance.Manager.RpcEndGame(GameOverReason.ImpostorDisconnect, !DataManager.Player.Ads.HasPurchasedAdRemoval);
+        }
+
+        if (players.Any(x => !x.Data.Role.IsImpostor))
+        {
+            if (HideAndSeekHudHelper.Instance.AllTimersExpired())
+            {
+                instance.Manager.RpcEndGame(GameOverReason.HideAndSeek_CrewmatesByTimer, !DataManager.Player.Ads.HasPurchasedAdRemoval);
+            }
+
+            return;
+        }
+
+        instance.Manager.RpcEndGame(GameOverReason.HideAndSeek_ImpostorsByKills, !DataManager.Player.Ads.HasPurchasedAdRemoval);
+    }
+
+    /// <inheritdoc/>
+    [SuppressMessage("Style", "IDE0046:Convert to conditional expression", Justification = "Warning cascades into forcing the entire tree to be ternary operators.")]
+    public override PlayerBodyTypes GetBodyType(PlayerControl player)
+    {
+        if (player == null || player.Data == null || player.Data.Role == null)
+        {
+            if (AprilFoolsMode.ShouldHorseAround())
+            {
+                return PlayerBodyTypes.Horse;
+            }
+
+            if (AprilFoolsMode.ShouldLongAround())
+            {
+                return PlayerBodyTypes.Long;
+            }
+
+            return PlayerBodyTypes.Normal;
+        }
+
+        if (AprilFoolsMode.ShouldHorseAround())
+        {
+            return player.Data.Role.IsImpostor ? PlayerBodyTypes.Normal : PlayerBodyTypes.Horse;
+        }
+
+        if (AprilFoolsMode.ShouldLongAround())
+        {
+            return player.Data.Role.IsImpostor ? PlayerBodyTypes.LongSeeker : PlayerBodyTypes.Long;
+        }
+
+        return player.Data.Role.IsImpostor ? PlayerBodyTypes.Seeker : PlayerBodyTypes.Normal;
+    }
+
+    /// <inheritdoc/>
+    public override void UpdateTaskPanel(TaskPanelBehaviour instance)
+    {
+        instance.background.transform.localScale = (instance.taskText.textBounds.size.x > 0f)
+            ? new Vector3(instance.taskText.textBounds.size.x + 0.2f, instance.taskText.textBounds.size.y + 0.2f, 1f)
+            : Vector3.zero;
+        var vector = instance.background.sprite.bounds.extents;
+        vector.y = -vector.y;
+        vector = vector.Mul(instance.background.transform.localScale);
+        instance.background.transform.localPosition = vector;
+        var vector2 = instance.tab.sprite.bounds.extents;
+        vector2 = vector2.Mul(instance.tab.transform.localScale);
+        vector2.y = -vector2.y;
+        vector2.x += vector.x * 2f;
+        instance.tab.transform.localPosition = vector2;
+        if (GameManager.Instance == null)
+        {
+            return;
+        }
+
+        var yPos = 1.6f;
+        var xPos = -instance.background.sprite.bounds.size.x * instance.background.transform.localScale.x;
+        instance.closedPosition = new Vector3(xPos, yPos, instance.closedPosition.z);
+        instance.openPosition = new Vector3(instance.openPosition.x, yPos, instance.openPosition.z);
+        instance.timer = instance.open
+            ? Mathf.Min(1f, instance.timer + (Time.deltaTime / instance.animationTimeSeconds))
+            : Mathf.Max(0f, instance.timer - (Time.deltaTime / instance.animationTimeSeconds));
+
+        Vector3 relativePos = new(
+            Mathf.SmoothStep(instance.closedPosition.x, instance.openPosition.x, instance.timer),
+            yPos,
+            instance.openPosition.z);
+        instance.transform.localPosition =
+            AspectPosition.ComputePosition(AspectPosition.EdgeAlignments.LeftTop, relativePos);
+    }
+
+    private int deadPlayerCount;
+
+    /// <inheritdoc/>
+    public override void OnPlayerDeath(PlayerControl player, bool assignGhostRole)
+    {
+        base.OnPlayerDeath(player, assignGhostRole);
+        HudManager.Instance.NotifyOfDeath();
+        var popup = GameManagerCreator.Instance.HideAndSeekManagerPrefab.DeathPopupPrefab;
+        deadPlayerCount++;
+        var item = UnityEngine.Object.Instantiate(popup, HudManager.Instance.transform.parent);
+        item.Show(player, deadPlayerCount);
+    }
+}

MiraAPI/GameOptions/AbstractOptionGroup.cs

@@ -1,7 +1,10 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
 using MiraAPI.Modifiers;
+using MiraAPI.Roles;
 using UnityEngine;
 
 namespace MiraAPI.GameOptions;
@@ -29,15 +32,17 @@ public abstract class AbstractOptionGroup
     public virtual Type? OptionableType => null;
 
     /// <summary>
-    /// Gets a value indicating whether the group should be shown in the modifiers menu. This is deprecated, please use ParentMenu!
+    /// Gets a value indicating whether the group should be shown in the modifiers menu.
     /// </summary>
-    // TODO: make this not a boolean
+    // Completed: make this not a boolean
+    [Obsolete("Use ParentMenu instead.", true)]
+    [SuppressMessage("Info Code Smell", "S1133:Deprecated code should be removed", Justification = "Retained.")]
     public virtual bool ShowInModifiersMenu => false;
 
     /// <summary>
     /// Gets a value indicating which menu the group is in.
     /// </summary>
-    public virtual MenuCategory ParentMenu => MenuCategory.Roles;
+    public virtual MenuCategory ParentMenu => MenuCategory.Game;
 
     /// <summary>
     /// Gets the function that determines whether the group should be visible or not.
@@ -45,56 +50,116 @@ public abstract class AbstractOptionGroup
     public virtual Func<bool> GroupVisible => () => true;
 
     /// <summary>
-    /// Gets the group color. This is used to color the group in the options menu.
+    /// Gets the group <see cref="Color"/>. This is used to color the group in the options menu.
     /// </summary>
     public virtual Color GroupColor => MiraApiPlugin.DefaultHeaderColor;
 
     /// <summary>
     /// Gets the group priority. This is used to determine the order in which groups are displayed in the options menu.
-    /// Zero is the highest priority, and the default value is the max uint value.
+    /// Zero is the highest priority, and the default value is the max <see langword="uint"/> value.
     /// </summary>
     public virtual uint GroupPriority => uint.MaxValue;
 
+    /// <summary>
+    /// Gets the default notification settings for the group.
+    /// </summary>
+    public virtual OptionNotifConfiguration Configuration => new(new Color(0.7333f, 0.7333f, 0.7333f, 1));
+
     internal bool AllOptionsHidden { get; set; }
 
     internal CategoryHeaderMasked? Header { get; set; }
+
+    internal bool Ready { get; set; }
 }
 
 /// <summary>
 /// Base class for option groups. An option group is a collection of options that are displayed together in the options menu.
 /// </summary>
 /// <typeparam name="T">The type of the optionable that this group contains.</typeparam>
-public abstract class AbstractOptionGroup<T> : AbstractOptionGroup where T : IOptionable
+public abstract class AbstractOptionGroup<T> : AbstractOptionGroup
+    where T : IOptionable
 {
     /// <inheritdoc />
     public override Type OptionableType => typeof(T);
 
-    /// <summary>
-    /// Gets a value indicating which menu the group is in.
-    /// </summary>
+    /// <inheritdoc />
     public override MenuCategory ParentMenu
     {
         get
         {
             var type = typeof(T);
-            if (type == typeof(BaseModifier))
+            if (typeof(BaseModifier).IsAssignableFrom(type))
             {
                 return MenuCategory.Modifiers;
             }
-            else if (type == typeof(RoleBehaviour))
+            else if (typeof(RoleBehaviour).IsAssignableFrom(type))
             {
                 return MenuCategory.Roles;
             }
+
             return MenuCategory.Game;
         }
     }
 }
 
+/// <summary>
+/// Base class for option groups. An option group is a collection of options that are displayed together in the options menu.
+/// </summary>
+/// <typeparam name="T">The custom role that the group is for.</typeparam>
+public abstract class AbstractRoleOptionGroup<T> : AbstractOptionGroup<T>
+    where T : ICustomRole
+{
+    /// <inheritdoc />
+    public override Type OptionableType => typeof(T);
+
+    /// <inheritdoc />
+    public override MenuCategory ParentMenu => MenuCategory.Roles;
+
+    /// <inheritdoc />
+    public override OptionNotifConfiguration Configuration
+    {
+        get
+        {
+            var role = CustomRoleManager.CustomMiraRoles.FirstOrDefault(x => x.GetType() == OptionableType);
+            return role == null
+                ? new(new Color(0.7333f, 0.7333f, 0.7333f, 1))
+                : new(role.RoleColor, role.Configuration.IconTmp);
+        }
+    }
+}
+
+/// <summary>
+/// Menu categories for option groups.
+/// </summary>
 public enum MenuCategory
 {
+    /// <summary>
+    /// Placeholder for indexing purposes. Options don't exist in the preset tab.
+    /// </summary>
+    Preset,
+
+    /// <summary>
+    /// Determines the option group is in the game settings tab.
+    /// </summary>
     Game,
+
+    /// <summary>
+    /// Determines the option group is in the role settings tab.
+    /// </summary>
     Roles,
+
+    /// <summary>
+    /// Determines the option group is in the modifier settings tab.
+    /// </summary>
     Modifiers,
+
+    /// <summary>
+    /// Determines the option group is in the first custom settings tab.
+    /// </summary>
     CustomOne,
-    CustomTwo
+
+    /// <summary>
+    /// Determines the option group is in the second custom settings tab.
+    /// </summary>
+    CustomTwo,
 }