WIP Anim API

.editorconfig

@@ -1,88 +1,2 @@
 [*.{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
+dotnet_diagnostic.CA1707.severity = none

.github/workflows/main.yaml

@@ -6,11 +6,11 @@ jobs:
   build:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v3
         with:
           submodules: true
 
-      - uses: actions/cache@v4
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.nuget/packages
@@ -20,7 +20,7 @@ jobs:
             ${{ runner.os }}-nuget-
 
       - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v3
         with:
           dotnet-version: 8.0.x
 
@@ -29,17 +29,17 @@ jobs:
         with:
           verbosity: Diagnostic
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v3
         with:
           name: MiraAPI.dll
           path: MiraAPI/bin/Release/net6.0/MiraAPI.dll
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v3
         with:
           name: AllOfUs.MiraAPI.nupkg
           path: MiraAPI/bin/Release/AllOfUs.MiraAPI.*.nupkg
           
-      - uses: softprops/action-gh-release@v2
+      - uses: softprops/action-gh-release@v1
         if: github.ref_type == 'tag'
         with:
           draft: true

.gitignore

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

AmongUs.props

@@ -1,14 +1,14 @@
 <Project>
     <ItemGroup>
-        <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="2026.8.18" PrivateAssets="all" />
+        <PackageReference Include="Reactor" Version="2.3.1" />
+        <PackageReference Include="BepInEx.Unity.IL2CPP" Version="6.0.0-be.697" Private="false" ExcludeAssets="runtime;native" />
+        <PackageReference Include="AmongUs.GameLibs.Steam" Version="2024.8.13" 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" />
+        <PackageReference Include="BepInEx.IL2CPP.MSBuild" Version="2.0.1" PrivateAssets="all" ExcludeAssets="runtime" />
     </ItemGroup>
-    
+
     <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.5.0</VersionPrefix>
+        <VersionPrefix>0.1.4</VersionPrefix>
         <VersionSuffix>dev</VersionSuffix>
 
         <Authors>All Of Us, XtraCube, Angxl</Authors>
@@ -28,15 +28,18 @@
         <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" />
+        <AdditionalFiles Include="$(MSBuildThisFileDirectory)\stylecop.json" Link="stylecop.json" Visible="false" />
+
+        <PackageReference Include="SonarAnalyzer.CSharp" Version="9.32.0.97167">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+        </PackageReference>
     </ItemGroup>
-</Project>
+    <PropertyGroup>
+        <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)\stylecop.ruleset</CodeAnalysisRuleSet>
+    </PropertyGroup>
+</Project>

ExternalAnnotations/0Harmony.xml

@@ -1,29 +0,0 @@
-<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

@@ -3,23 +3,20 @@ using MiraAPI.Example.Options.Roles;
 using MiraAPI.Example.Roles;
 using MiraAPI.GameOptions;
 using MiraAPI.Hud;
-using MiraAPI.Keybinds;
-using MiraAPI.Modifiers;
 using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons.Freezer;
 
+[RegisterButton]
 public class FreezeButton : CustomActionButton<PlayerControl>
 {
-    public override string Name => "button.freeze";
-
+    public override string Name => "Freeze";
     public override float Cooldown => OptionGroupSingleton<FreezerRoleSettings>.Instance.FreezeDuration;
-    public override bool PauseTimerInVent => true;
-
+    public override float EffectDuration => 0f;
+    public override int MaxUses => (int)OptionGroupSingleton<FreezerRoleSettings>.Instance.FreezeUses;
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
-    public override MiraKeybind? Keybind => MiraGlobalKeybinds.PrimaryAbility;
 
     protected override void OnClick()
     {

MiraAPI.Example/Buttons/MeetingButton.cs

@@ -1,24 +1,27 @@
 using MiraAPI.Example.Modifiers;
 using MiraAPI.Hud;
-using MiraAPI.Keybinds;
-using MiraAPI.Modifiers;
+using MiraAPI.Utilities;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons;
 
+[RegisterButton]
 public class MeetingButton : CustomActionButton
 {
-    public override string Name => "button.callMeeting";
+    public override string Name => "Call Meeting";
+
     public override float Cooldown => 15;
+
+    public override float EffectDuration => 0;
+
     public override int MaxUses => 3;
 
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
-    public override MiraKeybind? Keybind => MiraGlobalKeybinds.ModifierPrimaryAbility;
 
     public override bool Enabled(RoleBehaviour? role)
     {
-        return PlayerControl.LocalPlayer != null && PlayerControl.LocalPlayer.HasModifier<CaptainModifier>();
+        return PlayerControl.LocalPlayer.HasModifier<CaptainModifier>();
     }
 
     protected override void OnClick()
@@ -28,10 +31,10 @@ public class MeetingButton : CustomActionButton
         PlayerControl.LocalPlayer.NetTransform.Halt();
         var minigame = Object.Instantiate(bt.MinigamePrefab, Camera.main!.transform, false);
 
-        var taskAdderGame = minigame.TryCast<TaskAdderGame>();
-        if (taskAdderGame)
+        var taskAdderGame = minigame as TaskAdderGame;
+        if (taskAdderGame != null)
         {
-            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

@@ -1,27 +0,0 @@
-using MiraAPI.Example.GameOver;
-using MiraAPI.Example.Roles;
-using MiraAPI.GameEnd;
-using MiraAPI.Hud;
-using MiraAPI.Keybinds;
-using MiraAPI.Utilities.Assets;
-using UnityEngine;
-
-namespace MiraAPI.Example.Buttons;
-
-public class NeutralKillerButton : CustomActionButton
-{
-    public override string Name => "button.winGame";
-    public override float Cooldown => 0f;
-    public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
-    public override MiraKeybind Keybind => ExampleKeybinds.NeutralWinKeybind;
-
-    protected override void OnClick()
-    {
-        CustomGameOver.Trigger<NeutralKillerGameOver>([PlayerControl.LocalPlayer.Data]);
-    }
-
-    public override bool Enabled(RoleBehaviour? role)
-    {
-        return role is NeutralKillerRole;
-    }
-}

MiraAPI.Example/Buttons/Teleporter/TeleportButton.cs

@@ -1,34 +1,31 @@
-using System.Collections;
-using MiraAPI.Example.Options.Roles;
+using MiraAPI.Example.Options.Roles;
 using MiraAPI.Example.Roles;
 using MiraAPI.GameOptions;
 using MiraAPI.Hud;
-using MiraAPI.Keybinds;
 using MiraAPI.Utilities.Assets;
 using Reactor.Utilities;
+using System.Collections;
 using UnityEngine;
 
 namespace MiraAPI.Example.Buttons.Teleporter;
-
+[RegisterButton]
 public class TeleportButton : CustomActionButton
 {
-    public override string Name => "button.teleport";
+    public override string Name => "Teleport";
 
     public override float Cooldown => OptionGroupSingleton<TeleporterOptions>.Instance.TeleportCooldown.Value;
 
     public override float EffectDuration => OptionGroupSingleton<TeleporterOptions>.Instance.TeleportDuration;
-    public override int MaxUses => 2;
+
+    public override int MaxUses => 0;
 
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.TeleportButton;
-    public override Color TextOutlineColor => new Color32(221, 176, 152, 255);
     public static bool IsZoom { get; private set; }
-    public override MiraKeybind? Keybind => MiraGlobalKeybinds.PrimaryAbility;
 
     public override bool Enabled(RoleBehaviour? role)
     {
         return role is TeleporterRole;
     }
-
     protected override void OnClick()
     {
         Coroutines.Start(ZoomOutCoroutine());
@@ -61,14 +58,11 @@ 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);
     }
 
@@ -78,14 +72,12 @@ 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,35 +0,0 @@
-using MiraAPI.Hud;
-using MiraAPI.Translation;
-using MiraAPI.Utilities.Assets;
-using UnityEngine;
-
-namespace MiraAPI.Example.Buttons;
-
-public class ThinkButton : CustomActionButton
-{
-    public override string Name => "button.think";
-    public override float Cooldown => 15f;
-    public override float EffectDuration => 10f;
-    public override int MaxUses => 1;
-    public override ButtonUsesMode UsesMode => ButtonUsesMode.PerRound;
-    public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
-    protected override void OnClick()
-    {
-        Button!.OverrideText("button.think.thinking".Translate());
-    }
-
-    public override void OnEffectEnd()
-    {
-        Button!.OverrideText("button.think".Translate());
-    }
-
-    public override bool IsEffectCancellable()
-    {
-        return true;
-    }
-
-    public override bool Enabled(RoleBehaviour? role)
-    {
-        return role != null && role.IsImpostor;
-    }
-}

MiraAPI.Example/ExampleAssets.cs

@@ -5,10 +5,8 @@ namespace MiraAPI.Example;
 public static class ExampleAssets
 {
     public static LoadableResourceAsset ExampleButton { get; } = new("MiraAPI.Example.Resources.ExampleButton.png");
-    public static LoadableResourceAsset CallMeetingButton { get; } = new("MiraAPI.Example.Resources.CallMeeting.png");
 
     // 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,9 @@ namespace MiraAPI.Example;
 [RegisterCustomColors]
 public static class ExampleColors
 {
-    public static CustomColor Cerulean { get; } = new("color.cerulean", new Color(0.0f, 0.48f, 0.65f))
-    {
-        ColorBrightness = CustomColorBrightness.Lighter,
-    };
+    public static CustomColor Cerulean { get; } = new("Cerulean", new Color(0.0f, 0.48f, 0.65f));
 
-    public static CustomColor Rose { get; } = new("color.rose", new Color(0.98f, 0.26f, 0.62f));
+    public static CustomColor Rose { get; } = new("Rose", new Color(0.98f, 0.26f, 0.62f));
 
-    public static CustomColor Gold { get; } = new("color.gold", new Color(1.0f, 0.84f, 0.0f));
+    public static CustomColor Gold { get; } = new("Gold", new Color(1.0f, 0.84f, 0.0f));
 }

MiraAPI.Example/ExampleEventHandlers.cs

@@ -1,115 +0,0 @@
-using System.Diagnostics.CodeAnalysis;
-using System.Globalization;
-using System.Linq;
-using MiraAPI.Events;
-using MiraAPI.Events.Mira;
-using MiraAPI.Events.Vanilla.Gameplay;
-using MiraAPI.Events.Vanilla.Map;
-using MiraAPI.Events.Vanilla.Meeting;
-using MiraAPI.Events.Vanilla.Meeting.Voting;
-using MiraAPI.Events.Vanilla.Player;
-using MiraAPI.Example.Buttons.Freezer;
-using MiraAPI.Example.Roles;
-using MiraAPI.Utilities;
-using Reactor.Utilities;
-
-namespace MiraAPI.Example;
-
-public static class ExampleEventHandlers
-{
-    public static void Initialize()
-    {
-        // You can register event handlers with the MiraEventManager class
-        var handle = MiraEventManager.RegisterEventHandler<BeforeMurderEvent>(@event =>
-        {
-            Logger<ExamplePlugin>.Info($"{@event.Source.Data.PlayerName} is about to kill {@event.Target.Data.PlayerName}");
-        });
-
-        MiraEventManager.RegisterEventHandler<AfterMurderEvent>(@event =>
-        {
-            Logger<ExamplePlugin>.Info($"{@event.Source.Data.PlayerName} has killed {@event.Target.Data.PlayerName}");
-        });
-
-        MiraEventManager.RegisterEventHandler<CompleteTaskEvent>(@event =>
-        {
-            Logger<ExamplePlugin>.Info($"{@event.Player.Data.PlayerName} completed {@event.Task.TaskType.ToString()}");
-        });
-
-        // You can also unregister event handlers using the handle returned from RegisterEventHandler.
-        MiraEventManager.UnregisterEventHandler(handle);
-    }
-
-    // If you want to check vanilla buttons, use something like this!
-    [RegisterEvent]
-    public static void VanillaButtonClickHandler(VanillaButtonClickEvent @event)
-    {
-        Logger<ExamplePlugin>.Info($"{@event.Button.buttonLabelText.text} is being used!");
-        if (@event.PlayerTarget != null)
-        {
-            Logger<ExamplePlugin>.Info($"{@event.PlayerTarget.Data.PlayerName} is being targeted!");
-        }
-        else if (@event.VentTarget != null)
-        {
-            Logger<ExamplePlugin>.Info($"Vent with id {@event.VentTarget.Id.ToString(CultureInfo.InvariantCulture)} is being targeted!");
-        }
-    }
-
-    // If you want to add extra votes to a player, do something like this.
-    [RegisterEvent]
-    public static void StartMeetingEvent(StartMeetingEvent _)
-    {
-        foreach (var plr in PlayerControl.AllPlayerControls.ToArray().Where(player => player.Data.Role is MayorRole))
-        {
-            plr.GetVoteData().IncreaseRemainingVotes(1);
-        }
-    }
-
-    // Example of using the Voting API to make a role similar to the Prosecutor from Town of Us.
-    [RegisterEvent(15)]
-    public static void HandleVoteEvent(HandleVoteEvent @event)
-    {
-        if (@event.VoteData.Owner.Data.Role is not NeutralKillerRole) return;
-
-        @event.VoteData.SetRemainingVotes(0);
-
-        for (var i = 0; i < 5; i++)
-        {
-            @event.VoteData.VoteForPlayer(@event.TargetId);
-        }
-
-        foreach (var plr in PlayerControl.AllPlayerControls.ToArray().Where(player => player != @event.VoteData.Owner))
-        {
-            plr.GetVoteData().Votes.Clear();
-            plr.GetVoteData().VotesRemaining = 0;
-        }
-
-        @event.Cancel();
-    }
-
-    // Events can be registered using an attribute as well.
-    [RegisterEvent]
-    public static void UpdateSystemEventHandler(UpdateSystemEvent @event)
-    {
-        Logger<ExamplePlugin>.Error(@event.SystemType.ToString());
-    }
-
-    // Example event handler
-    [RegisterEvent(1)]
-    public static void FreezeButtonClickHandler(MiraButtonClickEvent<FreezeButton> @event)
-    {
-        Logger<ExamplePlugin>.Warning("Freeze button clicked!");
-
-        if (PlayerControl.LocalPlayer.Data.PlayerName != "stupid") return;
-
-        @event.Cancel();
-        @event.Button.SetTimer(15f);
-    }
-
-    // Example event handler
-    [RegisterEvent]
-    public static void FreezeButtonCancelledHandler(MiraButtonCancelledEvent<FreezeButton> @event)
-    {
-        Logger<ExamplePlugin>.Warning("Freeze button cancelled!");
-        @event.Button.OverrideName("Freeze Canceled");
-    }
-}

MiraAPI.Example/ExampleKeybinds.cs

@@ -1,10 +0,0 @@
-using MiraAPI.Keybinds;
-using Rewired;
-
-namespace MiraAPI.Example;
-
-[RegisterCustomKeybinds]
-public static class ExampleKeybinds
-{
-    public static MiraKeybind NeutralWinKeybind { get; } = new("Neutral Win", KeyboardKeyCode.C, [ModifierKey.Shift]);
-}

MiraAPI.Example/ExampleLocalSetings.cs

@@ -1,53 +0,0 @@
-using BepInEx.Configuration;
-using MiraAPI.LocalSettings;
-using MiraAPI.LocalSettings.Attributes;
-using MiraAPI.Utilities;
-using UnityEngine;
-
-namespace MiraAPI.Example;
-
-public class ExampleLocalSettings(ConfigFile config) : LocalSettingsTab(config)
-{
-    public override string TabName => "settings.miraExample";
-    protected override bool ShouldCreateLabels => false;
-
-    public override LocalSettingTabAppearance TabAppearance => new()
-    {
-        ToggleActiveColor = Color.blue,
-        ToggleInactiveColor = Color.red,
-    };
-
-    [LocalSettingsButton]
-    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);
-
-    [LocalToggleSetting]
-    public ConfigEntry<bool> ExampleToggle2 { get; private set; } = config.Bind("General", "Example Bool 2", false);
-
-    [LocalSliderSetting(suffixType: MiraNumberSuffixes.Percent, formatString: "0", roundValue: true)]
-    public ConfigEntry<float> ExampleSlider { get; private set; } = config.Bind("General", "Slider", 50f);
-
-    [LocalNumberSetting]
-    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 Multiplier", 1f);
-
-    [LocalEnumSetting]
-    public ConfigEntry<ExampleEnumSetting> ExampleEnum { get; private set; } = config.Bind("General", "Example Enum", ExampleEnumSetting.Fries);
-
-    private static void OnExampleButtonClick()
-    {
-        LocalSettingsTabSingleton<MiraApiSettings>.Instance.Open();
-    }
-}
-
-public enum ExampleEnumSetting
-{
-    Cheeseburger,
-    Sandwich,
-    Fries,
-    ChickenNuggets,
-}

MiraAPI.Example/ExamplePlugin.cs

@@ -3,7 +3,6 @@ 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,23 +16,11 @@ 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 { get; } = "Mira API\nExample Mod";
-    public string CustomOptionMenuNameTwo { get; } = "Example Options";
-
-    public ConfigFile GetConfigFile()
-    {
-        return Config;
-    }
-
+    public string OptionsTitleText => "Mira API\nExample Mod";
+    public ConfigFile GetConfigFile() => Config;
     public override void Load()
     {
-        ExampleEventHandlers.Initialize();
         Harmony.PatchAll();
     }
 }

MiraAPI.Example/GameModes/ExampleMode.cs

@@ -1,13 +0,0 @@
-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,22 +0,0 @@
-using MiraAPI.Example.Roles;
-using MiraAPI.GameEnd;
-using MiraAPI.Translation;
-using MiraAPI.Utilities;
-using UnityEngine;
-
-namespace MiraAPI.Example.GameOver;
-
-public class NeutralKillerGameOver : CustomGameOver
-{
-    public override bool VerifyCondition(PlayerControl playerControl, NetworkedPlayerInfo[] winners)
-    {
-        return winners is [{ Role: NeutralKillerRole }];
-    }
-
-    public override void AfterEndGameSetup(EndGameManager endGameManager)
-    {
-        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

@@ -1,29 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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

@@ -1,54 +0,0 @@
-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>Author Name</Authors>
-		<NoWarn>$(NoWarn);EnableGenerateDocumentationFile</NoWarn>
+		<Authors>Angxl, XtraCube</Authors>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<ProjectReference Include="..\MiraAPI\MiraAPI.csproj" /> <!-- You typically would use the nuget package here: AllOfUs.MiraAPI -->
+		<ProjectReference Include="..\MiraAPI\MiraAPI.csproj" />
 	</ItemGroup>
 
 	<ItemGroup>
-		<EmbeddedResource Include="Resources\**\*.*" />
+		<EmbeddedResource Include="Resources\ExampleButton.png" />
+		<EmbeddedResource Include="Resources\FortniteBanner.jpeg" />
+		<EmbeddedResource Include="Resources\TeleportButton.png" />
 	</ItemGroup>
 
 	<Import Project="..\AmongUs.props" />

MiraAPI.Example/Modifiers/CaptainModifier.cs

@@ -1,35 +1,20 @@
-using MiraAPI.Example.Options.Modifiers;
-using MiraAPI.GameOptions;
-using MiraAPI.Modifiers;
+using MiraAPI.Modifiers;
 using MiraAPI.Modifiers.Types;
-using MiraAPI.Translation;
-using MiraAPI.Utilities.Assets;
-using UnityEngine;
 
 namespace MiraAPI.Example.Modifiers;
 
+[RegisterModifier]
 public class CaptainModifier : GameModifier
 {
-    public override string ModifierName => MiraLocaleManager.Get("modifier.captain");
-    public override LoadableAsset<Sprite>? ModifierIcon => ExampleAssets.CallMeetingButton;
+    public override string ModifierName => "Captain";
 
-    public override void OnDeath(DeathReason reason)
+    public override int GetAmountPerGame()
     {
-        Player.RemoveModifier(this);
-    }
-
-    public override string GetDescription()
-    {
-        return MiraLocaleManager.Get("modifier.captain.TabDescription");
+        return 1;
     }
 
     public override int GetAssignmentChance()
     {
-        return (int)OptionGroupSingleton<CaptainModifierSettings>.Instance.Chance;
-    }
-
-    public override int GetAmountPerGame()
-    {
-        return (int)OptionGroupSingleton<CaptainModifierSettings>.Instance.Amount;
+        return 100;
     }
 }

MiraAPI.Example/Modifiers/Freezer/FreezeModifier.cs

@@ -1,14 +1,15 @@
 using Il2CppSystem;
 using MiraAPI.Example.Roles;
+using MiraAPI.Modifiers;
 using MiraAPI.Modifiers.Types;
-using MiraAPI.Translation;
 using UnityEngine;
 
 namespace MiraAPI.Example.Modifiers.Freezer;
 
+[RegisterModifier]
 public class FreezeModifier : TimedModifier
 {
-    public override string ModifierName => MiraLocaleManager.Get("modifier.freezed");
+    public override string ModifierName => "Freezed";
     public override bool HideOnUi => false;
     public override float Duration => 15f;
     public override bool AutoStart => true;
@@ -16,7 +17,7 @@ public class FreezeModifier : TimedModifier
 
     public override void OnActivate()
     {
-        if (Player.AmOwner)
+        if (Player?.AmOwner == true)
         {
             Player.moveable = false;
         }
@@ -26,15 +27,15 @@ public class FreezeModifier : TimedModifier
     {
         base.FixedUpdate();
 
-        if (Player.AmOwner || PlayerControl.LocalPlayer.Data.Role is FreezerRole)
+        if (Player?.AmOwner == true || PlayerControl.LocalPlayer.Data.Role is FreezerRole)
         {
-            Player.cosmetics.SetOutline(true, new Nullable<Color>(Palette.LightBlue));
+            Player?.cosmetics.SetOutline(true, new Nullable<Color>(Palette.LightBlue));
         }
     }
 
     public override void OnTimerComplete()
     {
-        if (Player.AmOwner)
+        if (Player?.AmOwner == true)
         {
             Player.moveable = true;
         }

MiraAPI.Example/Modifiers/HighPriorityModifier.cs

@@ -1,29 +0,0 @@
-using MiraAPI.Modifiers.Types;
-using MiraAPI.Translation;
-
-namespace MiraAPI.Example.Modifiers;
-
-public class HighPriorityModifier : GameModifier
-{
-    public override string ModifierName => MiraLocaleManager.Get("modifier.highPriority");
-
-    public override string GetDescription()
-    {
-        return MiraLocaleManager.Get("modifier.highPriority.TabDescription");
-    }
-
-    public override int GetAssignmentChance()
-    {
-        return 100;
-    }
-
-    public override int GetAmountPerGame()
-    {
-        return 1;
-    }
-
-    public override int Priority()
-    {
-        return 100;
-    }
-}

MiraAPI.Example/Options/ExampleOptions.cs

@@ -1,5 +1,4 @@
-using System.Collections.Generic;
-using MiraAPI.GameOptions;
+using MiraAPI.GameOptions;
 using MiraAPI.GameOptions.Attributes;
 using MiraAPI.Utilities;
 using UnityEngine;
@@ -8,28 +7,20 @@ namespace MiraAPI.Example.Options;
 
 public class ExampleOptions : AbstractOptionGroup
 {
-    public override string GroupName => "options.exampleOptions1";
+    public override string GroupName => "Example Options 1";
     public override Color GroupColor => Color.green;
 
-    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
+    [ModdedToggleOption("Toggle Opt 1")]
     public bool ToggleOpt { get; set; } = false;
 
-    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
+    [ModdedToggleOption("Toggle Opt 2")]
     public bool ToggleOpt2 { get; set; } = true;
 
-    [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)]
+    [ModdedNumberOption("Number Opt", min: 0, max: 10, suffixType: MiraNumberSuffixes.Percent)]
     public float NumberOpt { get; set; } = 4f;
 
-    [ModdedEnumOption("options.exampleOptions1.bestApi", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
+    [ModdedEnumOption("Best API", 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
@@ -38,10 +29,3 @@ public enum BestApi
     Mitochondria,
     Reactor,
 }
-
-public enum ValueState
-{
-    None,
-    Primary,
-    Secondary,
-}

MiraAPI.Example/Options/ExampleOptions2.cs

@@ -6,31 +6,24 @@ namespace MiraAPI.Example.Options;
 
 public class ExampleOptions2 : AbstractOptionGroup
 {
-    public override string GroupName => "options.exampleOptions2";
+    public override string GroupName => "Example Options 2";
 
     public override uint GroupPriority => 0; // This group will be displayed first. The default value is uint.MaxValue.
 
-    public override MenuCategory ParentMenu => MenuCategory.CustomTwo;
+    public ModdedToggleOption ToggleOpt1 { get; } = new("Toggle Option 1", 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)
+    public ModdedToggleOption ToggleOpt2 { get; } = new("Toggle Option 2", false)
     {
-        Visible = () => OptionGroupSingleton<ExampleOptions2>.Instance.ToggleOpt1, // implicit cast from ModdedToggleOption to bool
+        Visible = () => OptionGroupSingleton<ExampleOptions2>.Instance.ToggleOpt1.Value,
     };
 
-    public ModdedEnumOption<TestingData> EnumOpt { get; } = new("options.exampleOptions2.enumOpt", 0)
+    public ModdedEnumOption EnumOpt { get; } = new("Enum Opt", 0, typeof(TestingData))
     {
         ChangedEvent = x => Logger<ExamplePlugin>.Info($"changed Enum Opt to {x}"),
     };
 }
 
-public enum TestingData : ulong
+public enum TestingData
 {
     Happy,
     Sad,

MiraAPI.Example/Options/Modifiers/CaptainModifierSettings.cs

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

MiraAPI.Example/Options/Modifiers/FreezeModifierSettings.cs

@@ -1,13 +0,0 @@
-using MiraAPI.Example.Modifiers.Freezer;
-using MiraAPI.GameOptions;
-using MiraAPI.GameOptions.Attributes;
-
-namespace MiraAPI.Example.Options.Modifiers;
-
-public class FreezeModifierSettings : AbstractOptionGroup<FreezeModifier>
-{
-    public override string GroupName => "options.freezeModifierSettings";
-
-    [ModdedToggleOption("options.freezeModifierSettings.useColor")]
-    public bool UseColor { get; set; } = true;
-}

MiraAPI.Example/Options/Modifiers/GeneralModifierOptions.cs

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

MiraAPI.Example/Options/Roles/FreezerRoleSettings.cs

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

MiraAPI.Example/Options/Roles/TeleporterOptions.cs

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

MiraAPI.Example/Resources/Locale/en_US.xml

@@ -1,83 +0,0 @@
-<?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

@@ -1,66 +0,0 @@
-<?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,88 +1,46 @@
-using AmongUs.GameOptions;
-using MiraAPI.Patches.Stubs;
-using MiraAPI.Roles;
+using MiraAPI.Roles;
 using MiraAPI.Utilities.Assets;
-using Reactor.Utilities;
+using TMPro;
 using UnityEngine;
 
 namespace MiraAPI.Example.Roles;
 
-public class ChameleonRole : CrewmateRole, ICustomRole
+[RegisterCustomRole]
+public class ChameloenRole : CrewmateRole, ICustomRole
 {
-    private bool shouldHide;
-
-    public string IdPart => "Chameleon";
-    public string IdPrefix => "ApiExample.Role.Crewmate";
+    public string RoleName => "Chamelon";
+    public string RoleLongDescription => "Stay invisible while not moving.";
+    public string RoleDescription => RoleLongDescription;
     public Color RoleColor => Palette.AcceptedGreen;
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
+    public LoadableAsset<Sprite> OptionsScreenshot => ExampleAssets.Banner;
+    public int MaxPlayers => 2;
 
-    public CustomRoleConfiguration Configuration => new(this)
+    public void PlayerControlFixedUpdate(PlayerControl playerControl)
     {
-        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 ChameleonRole for player: " + player.PlayerId);
-        RoleBehaviourStubs.Initialize(this, player);
-        shouldHide = true;
-    }
-
-    public void FixedUpdate()
-    {
-        if (!Player || !shouldHide)
+        if (playerControl.MyPhysics.Velocity.magnitude > 0)
         {
-            return;
-        }
-
-        if (Player.MyPhysics.Velocity.magnitude > 0)
-        {
-            var rend = Player.cosmetics.currentBodySprite.BodySprite;
-            var tmp = Player.cosmetics.nameText;
+            SpriteRenderer rend = playerControl.cosmetics.currentBodySprite.BodySprite;
+            TextMeshPro tmp = playerControl.cosmetics.nameText;
             tmp.color = Color.Lerp(tmp.color, new Color(tmp.color.r, tmp.color.g, tmp.color.b, 1), Time.deltaTime * 4f);
             rend.color = Color.Lerp(rend.color, new Color(1, 1, 1, 1), Time.deltaTime * 4f);
 
-            foreach (var cosmetic in Player.cosmetics.transform.GetComponentsInChildren<SpriteRenderer>())
+            foreach (var cosmetic in playerControl.cosmetics.transform.GetComponentsInChildren<SpriteRenderer>())
             {
                 cosmetic.color = Color.Lerp(cosmetic.color, new Color(1, 1, 1, 1), Time.deltaTime * 4f);
             }
         }
         else
         {
-            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);
+            SpriteRenderer rend = playerControl.cosmetics.currentBodySprite.BodySprite;
+            TextMeshPro tmp = playerControl.cosmetics.nameText;
+            tmp.color = Color.Lerp(tmp.color, new Color(tmp.color.r, tmp.color.g, tmp.color.b, playerControl.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
+            rend.color = Color.Lerp(rend.color, new Color(1, 1, 1, playerControl.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
 
-            foreach (var cosmetic in Player.cosmetics.transform.GetComponentsInChildren<SpriteRenderer>())
+            foreach (var cosmetic in playerControl.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, playerControl.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
             }
         }
     }
-
-    public override void Deinitialize(PlayerControl targetPlayer)
-    {
-        Logger<ExamplePlugin>.Info("Deinitializing ChameleonRole for player: " + targetPlayer.PlayerId);
-        RoleBehaviourStubs.Deinitialize(this, targetPlayer);
-        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,21 +1,19 @@
-using MiraAPI.Roles;
+using Il2CppInterop.Runtime.Attributes;
+using MiraAPI.Roles;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
 namespace MiraAPI.Example.Roles;
 
+[RegisterCustomRole]
 public class FreezerRole : ImpostorRole, ICustomRole
 {
-    public string IdPart => "Freezer";
-    public string IdPrefix => "ApiExample.Role.Impostor";
+    public string RoleName => "Freezer";
+    public string RoleLongDescription => "Freeze another player for a duration of time.";
+    public string RoleDescription => RoleLongDescription;
     public Color RoleColor => Palette.Blue;
     public ModdedRoleTeams Team => ModdedRoleTeams.Impostor;
-
-    public CustomRoleConfiguration Configuration => new(this)
-    {
-        Icon = MiraAssets.ImpostorFile,
-        IconTmp = TmpSpriteUtils.CreateSpriteAsset(MiraAssets.ImpostorFile.LoadAsset(), "ApiExample.Role.Impostor.Freezer"),
-        OptionsScreenshot = ExampleAssets.Banner,
-        MaxRoleCount = 2,
-    };
+    [HideFromIl2Cpp]
+    public LoadableAsset<Sprite> OptionsScreenshot => ExampleAssets.Banner;
+    public int MaxPlayers => 2;
 }

MiraAPI.Example/Roles/MayorRole.cs

@@ -1,13 +0,0 @@
-using MiraAPI.Roles;
-using UnityEngine;
-
-namespace MiraAPI.Example.Roles;
-
-public class MayorRole : CrewmateRole, ICustomRole
-{
-    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

@@ -1,32 +1,19 @@
-using Il2CppInterop.Runtime.Attributes;
-using MiraAPI.Example.GameOver;
-using MiraAPI.GameEnd;
-using MiraAPI.Roles;
+using MiraAPI.Roles;
 using UnityEngine;
 
 namespace MiraAPI.Example.Roles;
 
+[RegisterCustomRole]
 public class NeutralKillerRole : ImpostorRole, ICustomRole
 {
-    public string IdPart => "OutcastKiller";
-    public string IdPrefix => "ApiExample.Role.Outcast";
+    public string RoleName => "Neutral Killer";
+    public string RoleDescription => "Neutral who can kill.";
+    public string RoleLongDescription => RoleDescription;
     public Color RoleColor => Color.magenta;
-    public ModdedRoleTeams Team => ModdedRoleTeams.Custom;
-
-    public CustomRoleConfiguration Configuration => new(this)
-    {
-        UseVanillaKillButton = true,
-        CanGetKilled = true,
-        CanUseVent = true,
-    };
-
-    public RoleOptionsGroup RoleOptionsGroup { get; } = new("outcast.group", Color.gray);
-
-    [HideFromIl2Cpp]
-    public TeamIntroConfiguration? IntroConfiguration { get; } = new(
-        Color.gray,
-        "outcast.roleTitle",
-        "outcast.teamIntroDescription");
+    public ModdedRoleTeams Team => ModdedRoleTeams.Neutral;
+    public bool UseVanillaKillButton => true;
+    public bool CanGetKilled => true;
+    public bool CanUseVent => true;
 
     public override void SpawnTaskHeader(PlayerControl playerControl)
     {
@@ -35,6 +22,6 @@ public class NeutralKillerRole : ImpostorRole, ICustomRole
 
     public override bool DidWin(GameOverReason gameOverReason)
     {
-        return gameOverReason == CustomGameOver.GameOverReason<NeutralKillerGameOver>();
+        return GameManager.Instance.DidHumansWin(gameOverReason);
     }
 }

MiraAPI.Example/Roles/TeleporterRole.cs

@@ -1,25 +1,18 @@
-using MiraAPI.Roles;
+using Il2CppInterop.Runtime.Attributes;
+using MiraAPI.Roles;
+using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
 namespace MiraAPI.Example.Roles;
 
+[RegisterCustomRole]
 public class TeleporterRole : CrewmateRole, ICustomRole
 {
-    public string IdPart => "Teleporter";
-    public string IdPrefix => "ApiExample.Role.Crewmate";
+    public string RoleName => "Teleporter";
+    public string RoleLongDescription => "Zoom out and teleport across the map!";
+    public string RoleDescription => RoleLongDescription;
     public Color RoleColor => new Color32(221, 176, 152, 255);
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
-
-    public CustomRoleConfiguration Configuration => new(this)
-    {
-        OptionsScreenshot = ExampleAssets.Banner,
-        CanModifyChance = false,
-        DefaultChance = 73,
-        DefaultRoleCount = 4,
-    };
-
-    public bool CanLocalPlayerSeeRole(PlayerControl player)
-    {
-        return true;
-    }
+    [HideFromIl2Cpp]
+    public LoadableAsset<Sprite> OptionsScreenshot => ExampleAssets.Banner;
 }

MiraAPI/Animations/AnimationPresetManager.cs

@@ -0,0 +1,46 @@
+using MiraAPI.Animations;
+using System;
+using System.Collections.Generic;
+
+namespace MiraAPI.Modifiers;
+
+/// <summary>
+/// The manager for handling modifiers.
+/// </summary>
+public static class AnimationPresetManager
+{
+    private static uint _nextId;
+
+    /// <summary>
+    /// Gets registered Animation Presets.
+    /// </summary>
+    public static List<CustomAnimationPreset> Presets { get; internal set; } = new List<CustomAnimationPreset>();
+
+    private static uint GetNextId()
+    {
+        _nextId++;
+        return _nextId;
+    }
+
+    /// <summary>
+    /// Get Animation Preset by ID.
+    /// </summary>
+    /// <param name="id">The id of the preset you want to find.</param>
+    /// <returns>The animation preset.</returns>
+    public static CustomAnimationPreset? GetPresetById(uint id)
+    {
+        return Presets.Find(p => p.Id == id);
+    }
+
+    internal static void RegisterPreset(Type modifierType)
+    {
+        if (!typeof(CustomAnimationPreset).IsAssignableFrom(modifierType))
+        {
+            return;
+        }
+
+        CustomAnimationPreset preset = (CustomAnimationPreset)Activator.CreateInstance(modifierType);
+        preset.Id = GetNextId();
+        Presets.Add(preset);
+    }
+}

MiraAPI/Animations/CustomAnimationPreset.cs

@@ -0,0 +1,24 @@
+using UnityEngine;
+
+namespace MiraAPI.Animations;
+
+/// <summary>
+/// Configure an animation's settings using presets.
+/// </summary>
+/// <param name="clip">The animation clip the preset will use.</param>
+public abstract class CustomAnimationPreset(AnimationClip clip)
+{
+    internal uint Id;
+
+    internal void PlayAnimation(PlayerControl source)
+    {
+
+    }
+
+    /// <summary>
+    /// Check whether the local player should be able to see this animation.
+    /// </summary>
+    /// <param name="source">The player who the animation is being triggered upon.</param>
+    /// <returns>Whether the local player can see the animation or not.</returns>
+    public abstract bool AnimationVisible(PlayerControl source);
+}

MiraAPI/Animations/CustomAnimator.cs

@@ -0,0 +1,38 @@
+using MiraAPI.Animations.Presets;
+using MiraAPI.Modifiers;
+using MiraAPI.Networking;
+using MiraAPI.Utilities;
+using Reactor.Networking.Attributes;
+using Reactor.Utilities.Attributes;
+using System;
+using UnityEngine;
+
+namespace MiraAPI.Animations;
+
+[RegisterInIl2Cpp]
+public class CustomAnimator(IntPtr cppPtr) : MonoBehaviour(cppPtr)
+{
+    private PlayerControl _player;
+
+    private void Start()
+    {
+        _player = gameObject.GetComponent<PlayerControl>();
+
+        _player.GetCustomAnimator()?.TriggerCustomAnimation(new LocalAnimationPreset(new AnimationClip()));
+    }
+
+    public void TriggerCustomAnimation(CustomAnimationPreset preset) => RpcTriggerCustomAnimation(_player, preset.Id);
+
+
+    [MethodRpc((uint)MiraRpc.TriggerAnimation)]
+    internal static void RpcTriggerCustomAnimation(PlayerControl source, uint presetId)
+    {
+        CustomAnimationPreset preset = AnimationPresetManager.GetPresetById(presetId);
+        if (preset is null) return;
+
+        if (preset.AnimationVisible(source))
+        {
+            preset.PlayAnimation(source);
+        }
+    }
+}

MiraAPI/Animations/Presets/LocalAnimationPreset.cs

@@ -0,0 +1,11 @@
+using UnityEngine;
+
+namespace MiraAPI.Animations.Presets;
+public class LocalAnimationPreset(AnimationClip clip) : CustomAnimationPreset(clip)
+{
+    /// <inheritdoc/>
+    public override bool AnimationVisible(PlayerControl source)
+    {
+        return source.AmOwner;
+    }
+}

MiraAPI/Animations/RegisterAnimationPresetAttribute.cs

@@ -0,0 +1,6 @@
+using System;
+
+namespace MiraAPI.Animations;
+
+[AttributeUsage(AttributeTargets.Class)]
+public class RegisterAnimationPresetAttribute : Attribute;

MiraAPI/Colors/CustomColor.cs

@@ -1,5 +1,5 @@
-using MiraAPI.Translation;
-using MiraAPI.Utilities;
+using MiraAPI.Utilities;
+using Reactor.Localization.Utilities;
 using UnityEngine;
 
 namespace MiraAPI.Colors;
@@ -13,56 +13,32 @@ namespace MiraAPI.Colors;
 public sealed class CustomColor(StringNames name, Color32 mainColor, Color32 shadowColor)
 {
     /// <summary>
-    /// Gets or sets the main color.
+    /// Gets the main color.
     /// </summary>
-    public Color32 MainColor { get; set; } = mainColor;
+    public Color32 MainColor { get; } = mainColor;
 
     /// <summary>
-    /// Gets or sets the shadow color.
+    /// Gets the shadow color.
     /// </summary>
-    public Color32 ShadowColor { get; set; } = shadowColor;
+    public Color32 ShadowColor { get; } = shadowColor;
 
     /// <summary>
-    /// Gets or sets the name of the color.
+    /// Gets the name of the color.
     /// </summary>
-    public StringNames Name { get; set; } = name;
+    public StringNames Name { get; } = name;
 
-    /// <summary>
-    /// Gets or sets whether the color is lighter or darker. Can be used to help with colorblind stuff.
-    /// </summary>
-    public CustomColorBrightness ColorBrightness { get; set; } = CustomColorBrightness.Darker;
-
-    /// <inheritdoc cref="CustomColor"/>
-    public CustomColor(StringNames name, Color32 mainColor)
-        : this(name, mainColor, mainColor.GetShadowColor(60))
+    /// <inheritdoc />
+    public CustomColor(StringNames 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) : this(name, mainColor, mainColor.GetShadowColor(60))
     {
     }
 
-    /// <inheritdoc cref="CustomColor"/>
-    public CustomColor(string name, Color32 mainColor, Color32 shadowColor)
-        : this(MiraLocaleManager.GetOrCreateLocaleString(name), mainColor, shadowColor)
+    /// <inheritdoc />
+    public CustomColor(string name, Color32 mainColor, Color32 shadowColor) : this(CustomStringName.CreateAndRegister(name), mainColor, shadowColor)
     {
     }
 }
-
-/// <summary>
-/// Can be used to help with colorblind stuff.
-/// </summary>
-public enum CustomColorBrightness
-{
-    /// <summary>
-    /// A lighter color.
-    /// </summary>
-    Lighter,
-
-    /// <summary>
-    /// A darker color.
-    /// </summary>
-    Darker,
-}

MiraAPI/Colors/PaletteManager.cs

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

MiraAPI/Colors/RegisterCustomColorsAttribute.cs

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

MiraAPI/Events/Mira/MiraButtonCancelledEvent.cs

@@ -1,29 +0,0 @@
-using MiraAPI.Hud;
-
-namespace MiraAPI.Events.Mira;
-
-/// <summary>
-/// Invoked when a <see cref="CustomActionButton"/> click is cancelled. Do not use for vanilla <see cref="AbilityButton"/>s.
-/// </summary>
-/// <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 the <see cref="CustomActionButton"/> whose click was cancelled.
-    /// </summary>
-    public T Button { get; } = button;
-}
-
-/// <summary>
-/// Invoked when a <see cref="CustomActionButton"/> click is cancelled. Do not use for vanilla <see cref="AbilityButton"/>s.
-/// </summary>
-/// <param name="button">The <see cref="CustomActionButton"/> whose click was cancelled.</param>
-public sealed class MiraButtonCancelledEvent(CustomActionButton button) : MiraEvent
-{
-    /// <summary>
-    /// Gets the <see cref="CustomActionButton"/> whose click was cancelled.
-    /// </summary>
-    public CustomActionButton Button { get; } = button;
-}

MiraAPI/Events/Mira/MiraButtonClickEvent.cs

@@ -1,35 +0,0 @@
-using MiraAPI.Hud;
-
-namespace MiraAPI.Events.Mira;
-
-/// <summary>
-/// Button click event for <see cref="CustomActionButton"/>s only. Do not use for vanilla <see cref="AbilityButton"/>s.
-/// </summary>
-/// <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 the <see cref="CustomActionButton"/> that was clicked.
-    /// </summary>
-    public T Button { get; } = button;
-
-    /// <summary>
-    /// Gets the generic <see cref="MiraButtonClickEvent"/> that is invoked before this button-specific event.
-    /// </summary>
-    public MiraButtonClickEvent GenericClickEvent { get; } = genericClickEvent;
-}
-
-/// <summary>
-/// Button click event for <see cref="CustomActionButton"/>s only. Do not use for vanilla <see cref="AbilityButton"/>s.
-/// </summary>
-/// <param name="button">The <see cref="CustomActionButton"/> that was clicked.</param>
-public class MiraButtonClickEvent(CustomActionButton button) : MiraCancelableEvent
-{
-    /// <summary>
-    /// Gets the <see cref="CustomActionButton"/> that was clicked.
-    /// </summary>
-    public CustomActionButton Button { get; } = button;
-}

MiraAPI/Events/Mira/UiButtonPostResetEvent.cs

@@ -1,21 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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,31 +0,0 @@
-using MiraAPI.PluginLoading;
-
-namespace MiraAPI.Events;
-
-/// <summary>
-/// Abstract class for Mira Events that can be cancelled.
-/// </summary>
-[MiraIgnore]
-public abstract class MiraCancelableEvent : MiraEvent
-{
-    /// <summary>
-    /// Gets a value indicating whether the event is cancelled.
-    /// </summary>
-    public bool IsCancelled { get; private set; }
-
-    /// <summary>
-    /// Cancels the event.
-    /// </summary>
-    public void Cancel()
-    {
-        IsCancelled = true;
-    }
-
-    /// <summary>
-    /// Uncancels the event.
-    /// </summary>
-    public void UnCancel()
-    {
-        IsCancelled = false;
-    }
-}

MiraAPI/Events/MiraEvent.cs

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

MiraAPI/Events/MiraEventHandle.cs

@@ -1,22 +0,0 @@
-using System;
-
-namespace MiraAPI.Events;
-
-/// <summary>
-/// Event handle to use when unregistering a <see cref="MiraEvent"/>.
-/// </summary>
-public class MiraEventHandle
-{
-    /// <summary>
-    /// Gets the type of event.
-    /// </summary>
-    public Type EventType { get; }
-
-    internal MiraEventWrapper EventWrapper { get; }
-
-    internal MiraEventHandle(Type type, MiraEventWrapper eventWrapper)
-    {
-        EventType = type;
-        EventWrapper = eventWrapper;
-    }
-}

MiraAPI/Events/MiraEventManager.cs

@@ -1,156 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Reflection;
-
-namespace MiraAPI.Events;
-
-/// <summary>
-/// Mira Event manager.
-/// </summary>
-public static class MiraEventManager
-{
-    private static readonly Dictionary<Type, List<MiraEventWrapper>> EventWrappers = [];
-
-    /// <summary>
-    /// Invoke a <see cref="MiraEvent"/>.
-    /// </summary>
-    /// <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 <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;
-        }
-
-        foreach (var handler in handlers)
-        {
-            try
-            {
-                ((Action<T>)handler.EventHandler).Invoke(eventInstance);
-            }
-            catch (Exception ex)
-            {
-                Error($"Error invoking event handler for {typeof(T).Name}: {ex.ToString()}");
-            }
-        }
-
-        return true;
-    }
-
-    /// <summary>
-    /// Invoke a <see cref="MiraEvent"/> and use a specific type to find the handlers.
-    /// </summary>
-    /// <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 <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;
-        }
-
-        foreach (var handler in handlers)
-        {
-            try
-            {
-                handler.EventHandler.DynamicInvoke(eventInstance);
-            }
-            catch (Exception ex)
-            {
-                Error($"Error invoking event handler for {type.Name}: {ex.ToString()}");
-            }
-        }
-
-        return true;
-    }
-
-    /// <summary>
-    /// Register a <see cref="MiraEvent"/> handler.
-    /// </summary>
-    /// <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>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)))
-        {
-            throw new InvalidOperationException($"Type must be a subclass of MiraEvent: {type.FullName}");
-        }
-
-        EventWrappers.TryAdd(type, []);
-        var handlers = EventWrappers[type];
-
-        var @delegate = Delegate.CreateDelegate(typeof(Action<>).MakeGenericType(type), methodInfo);
-        var eventWrapper = new MiraEventWrapper(@delegate, priority);
-
-        var index = handlers.BinarySearch(eventWrapper, Comparer<MiraEventWrapper>.Create((a, b) => a.Priority.CompareTo(b.Priority)));
-
-        if (index < 0)
-        {
-            index = ~index;
-        }
-
-        handlers.Insert(index, eventWrapper);
-        return new MiraEventHandle(type, eventWrapper);
-    }
-
-    /// <summary>
-    /// 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 <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), []);
-
-        var handlers = EventWrappers[typeof(T)];
-        var eventWrapper = new MiraEventWrapper(handler, priority);
-
-        var index = handlers.BinarySearch(eventWrapper, Comparer<MiraEventWrapper>.Create((a, b) => a.Priority.CompareTo(b.Priority)));
-
-        if (index < 0)
-        {
-            index = ~index;
-        }
-
-        handlers.Insert(index, eventWrapper);
-        return new MiraEventHandle(typeof(T), eventWrapper);
-    }
-
-    /// <summary>
-    /// Unregister a <see cref="MiraEvent"/> handler using the <see cref="MiraEventHandle"/>.
-    /// </summary>
-    /// <param name="eventHandle">A handle to the event.</param>
-    /// <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))
-        {
-            return false;
-        }
-
-        if (!handlers.Remove(eventHandle.EventWrapper))
-        {
-            return false;
-        }
-
-        if (handlers.Count == 0)
-        {
-            EventWrappers.Remove(eventHandle.EventType);
-        }
-
-        return true;
-    }
-}

MiraAPI/Events/MiraEventWrapper.cs

@@ -1,21 +0,0 @@
-using System;
-
-namespace MiraAPI.Events;
-
-/// <summary>
-/// Wrapper for <see cref="MiraEvent"/> handlers.
-/// </summary>
-/// <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; } = eventHandler;
-
-    /// <summary>
-    /// Gets the priority of the handler. Lower values are called first.
-    /// </summary>
-    public int Priority { get; } = priority;
-}

MiraAPI/Events/RegisterEventAttribute.cs

@@ -1,16 +0,0 @@
-using System;
-
-namespace MiraAPI.Events;
-
-/// <summary>
-/// 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(int priority = 0) : Attribute
-{
-    /// <summary>
-    /// Gets the priority of the event. Lower values are called first.
-    /// </summary>
-    public int Priority { get; } = priority;
-}

MiraAPI/Events/Vanilla/Gameplay/AfterMurderEvent.cs

@@ -1,68 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// Event that is invoked after a player is murdered. Only called after a successful murder. This event is not cancelable.
-/// </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="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 <see cref="PlayerControl"/> that killed the <see cref="Target"/>.
-    /// </summary>
-    public PlayerControl Source { get; } = source;
-
-    /// <summary>
-    /// Gets the <see cref="PlayerControl"/> that was killed.
-    /// </summary>
-    public PlayerControl Target { get; } = target;
-
-    /// <summary>
-    /// Gets the <see cref="PlayerControl"/> that was framed, if any.
-    /// </summary>
-    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 <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)
-    {
-    }
-}

MiraAPI/Events/Vanilla/Gameplay/BeforeGameEndEvent.cs

@@ -1,13 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// Invoked before <see cref="GameManager.RpcEndGame"/> is called, allowing cancellation of the game end entirely.
-/// </summary>
-/// <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; } = reason;
-}

MiraAPI/Events/Vanilla/Gameplay/BeforeMurderEvent.cs

@@ -1,71 +0,0 @@
-using MiraAPI.Networking;
-
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// Event that is invoked before a player is murdered. This event is cancelable.
-/// </summary>
-/// <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 <see cref="PlayerControl"/> that is killing the <see cref="Target"/>.
-    /// </summary>
-    public PlayerControl Source { get; } = source;
-
-    /// <summary>
-    /// Gets the <see cref="PlayerControl"/> that is being killed.
-    /// </summary>
-    public PlayerControl Target { get; } = target;
-
-    /// <summary>
-    /// Gets the <see cref="PlayerControl"/> that is being framed, if any.
-    /// </summary>
-    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 <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 = MeetingCheck.Ignore)
-        : this(source, target, false, false, inMeeting)
-    {
-    }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="BeforeMurderEvent"/> class.
-    /// </summary>
-    /// <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)
-    {
-    }
-}

MiraAPI/Events/Vanilla/Gameplay/BeforeRoundStartEvent.cs

@@ -1,13 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// 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>
-/// <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 <see cref="IntroCutscene"/> or <see cref="ExileController"/>.
-    /// </summary>
-    public bool TriggeredByIntro { get; } = triggeredByIntro;
-}

MiraAPI/Events/Vanilla/Gameplay/GameEndEvent.cs

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

MiraAPI/Events/Vanilla/Gameplay/IntroBeginEvent.cs

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

MiraAPI/Events/Vanilla/Gameplay/IntroEndEvent.cs

@@ -1,13 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <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 <see cref="global::IntroCutscene"/> instance.
-    /// </summary>
-    public IntroCutscene IntroCutscene { get; } = introCutscene;
-}

MiraAPI/Events/Vanilla/Gameplay/IntroRoleRevealEvent.cs

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

MiraAPI/Events/Vanilla/Gameplay/RoundStartEvent.cs

@@ -1,14 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// Start Round event, invoked on <see cref="IntroCutscene.OnDestroy"/> and <see cref="ExileController.WrapUp"/>
-/// if the <see cref="BeforeRoundStartEvent"/> isn't cancelled.
-/// </summary>
-/// <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 <see cref="IntroCutscene"/> or <see cref="ExileController"/>.
-    /// </summary>
-    public bool TriggeredByIntro { get; } = triggeredByIntro;
-}

MiraAPI/Events/Vanilla/Gameplay/SetRoleEvent.cs

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

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonCancelledEvent.cs

@@ -1,29 +0,0 @@
-using MiraAPI.Hud;
-
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// Invoked when a Vanilla <see cref="AbilityButton"/> click is cancelled. Do not use for <see cref="CustomActionButton"/>.
-/// </summary>
-/// <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 the Vanilla <see cref="AbilityButton"/> whose click was cancelled.
-    /// </summary>
-    public T Button { get; } = button;
-}
-
-/// <summary>
-/// Invoked when a Vanilla <see cref="AbilityButton"/> click is cancelled. Do not use for <see cref="CustomActionButton"/>s.
-/// </summary>
-/// <param name="button">The vanilla <see cref="AbilityButton"/> whose click was cancelled.</param>
-public sealed class VanillaButtonCancelledEvent(AbilityButton button) : MiraEvent
-{
-    /// <summary>
-    /// Gets the Vanilla <see cref="AbilityButton"/> whose click was cancelled.
-    /// </summary>
-    public AbilityButton Button { get; } = button;
-}

MiraAPI/Events/Vanilla/Gameplay/VanillaButtonClickEvent.cs

@@ -1,47 +0,0 @@
-using MiraAPI.Hud;
-
-namespace MiraAPI.Events.Vanilla.Gameplay;
-
-/// <summary>
-/// Button click event for Vanilla <see cref="AbilityButton"/>s only. Do not use for <see cref="CustomActionButton"/>s.
-/// </summary>
-/// <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 the vanilla <see cref="AbilityButton"/> that was clicked.
-    /// </summary>
-    public T Button { get; } = button;
-
-    /// <summary>
-    /// Gets the generic <see cref="VanillaButtonClickEvent"/> that is invoked before this button-specific event.
-    /// </summary>
-    public VanillaButtonClickEvent GenericClickEvent { get; } = genericClickEvent;
-}
-
-/// <summary>
-/// Button click event for Vanilla <see cref="AbilityButton"/> only. Do not use for <see cref="CustomActionButton"/>s.
-/// </summary>
-/// <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 the Vanilla <see cref="AbilityButton"/> that was clicked.
-    /// </summary>
-    public AbilityButton Button { get; } = button;
-
-    /// <summary>
-    /// Gets the target <see cref="PlayerControl"/>, if any, of the Vanilla <see cref="AbilityButton"/> that was clicked.
-    /// </summary>
-    public PlayerControl? PlayerTarget { get; } = playerTarget;
-
-    /// <summary>
-    /// Gets the target <see cref="Vent"/>, if any, of the Vanilla <see cref="AbilityButton"/> that was clicked.
-    /// </summary>
-    public Vent? VentTarget { get; } = ventTarget;
-}

MiraAPI/Events/Vanilla/Map/CloseDoorsEvent.cs

@@ -1,13 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Map;
-
-/// <summary>
-/// Event fired when a player closes the doors in a room.
-/// </summary>
-/// <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; } = room;
-}

MiraAPI/Events/Vanilla/Map/PlayerOpenSabotageEvent.cs

@@ -1,13 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Map;
-
-/// <summary>
-/// Sabotage from Vanilla Among Us.
-/// </summary>
-/// <param name="mapBehaviour">The <see cref="global::MapBehaviour"/>.</param>
-public class PlayerOpenSabotageEvent(MapBehaviour mapBehaviour) : MiraCancelableEvent
-{
-    /// <summary>
-    /// Gets the <see cref="global::MapBehaviour"/>.
-    /// </summary>
-    public MapBehaviour MapBehaviour { get; } = mapBehaviour;
-}

MiraAPI/Events/Vanilla/Map/UpdateSystemEvent.cs

@@ -1,25 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Map;
-
-/// <summary>
-/// <see cref="MiraCancelableEvent"/> that is invoked before a system is updated. Usually used for sabotage events.
-/// </summary>
-/// <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; } = systemType;
-
-    /// <summary>
-    /// Gets the <see cref="PlayerControl"/> that is updating the system.
-    /// </summary>
-    public PlayerControl Player { get; } = player;
-
-    /// <summary>
-    /// Gets the byte amount the system is being updated by.
-    /// </summary>
-    public byte Amount { get; } = amount;
-}

MiraAPI/Events/Vanilla/Meeting/EjectionEvent.cs

@@ -1,13 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Meeting;
-
-/// <summary>
-/// The event that is invoked when a player is ejected. Non-cancelable.
-/// </summary>
-/// <param name="controller">The <see cref="global::ExileController"/> instance.</param>
-public class EjectionEvent(ExileController controller) : MiraEvent
-{
-    /// <summary>
-    /// Gets the <see cref="global::ExileController"/> instance.
-    /// </summary>
-    public ExileController ExileController { get; } = controller;
-}

MiraAPI/Events/Vanilla/Meeting/EndMeetingEvent.cs

@@ -1,12 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Meeting;
-
-/// <summary>
-/// The event that is invoked when the meeting has ended.
-/// </summary>
-public class EndMeetingEvent(MeetingHud meetingHud) : MiraEvent
-{
-    /// <summary>
-    /// Gets the <see cref="global::MeetingHud"/> instance.
-    /// </summary>
-    public MeetingHud MeetingHud { get; } = meetingHud;
-}

MiraAPI/Events/Vanilla/Meeting/ReportBodyEvent.cs

@@ -1,26 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Meeting;
-
-/// <summary>
-/// The event that is invoked when a body is reported.<br/>
-/// This is invoked in <see cref="PlayerControl.CmdReportDeadBody(NetworkedPlayerInfo)"/>.
-/// </summary>
-/// <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; } = reporter;
-
-    /// <summary>
-    /// Gets the player that is being reported. Will be <see langword="null"/> for emergency meeting.
-    /// </summary>
-    public NetworkedPlayerInfo? Target { get; } = target;
-
-    /// <summary>
-    /// Gets the <see cref="DeadBody"/> that is being reported. Will be <see langword="null"/> for emergency meeting.
-    /// </summary>
-    public DeadBody? Body { get; } = body;
-}

MiraAPI/Events/Vanilla/Meeting/StartMeetingEvent.cs

@@ -1,14 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Meeting;
-
-/// <summary>
-/// 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>
-/// <param name="meetingHud">The <see cref="global::MeetingHud"/> instance.</param>
-public class StartMeetingEvent(MeetingHud meetingHud) : MiraEvent
-{
-    /// <summary>
-    /// Gets the <see cref="global::MeetingHud"/> instance.
-    /// </summary>
-    public MeetingHud MeetingHud { get; } = meetingHud;
-}

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

@@ -1,19 +0,0 @@
-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>
-/// <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 <see cref="PlayerVoteArea"/>.
-    /// </summary>
-    public PlayerVoteArea VoteArea { get; } = playerVoteArea;
-
-    /// <summary>
-    /// Gets the player who voted.
-    /// </summary>
-    public PlayerControl Player { get; } = voter;
-}

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

@@ -1,19 +0,0 @@
-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>
-/// <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 <see cref="PlayerVoteArea"/>.
-    /// </summary>
-    public PlayerVoteArea VoteArea { get; } = playerVoteArea;
-
-    /// <summary>
-    /// Gets the player who voted.
-    /// </summary>
-    public PlayerControl Player { get; } = voter;
-}

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

@@ -1,18 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
-
-/// <summary>
-/// Checks if voting is complete. If canceled, the default end voting logic will be skipped.
-/// </summary>
-/// <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; } = 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; }
-}

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

@@ -1,33 +0,0 @@
-using System;
-using MiraAPI.Utilities;
-using MiraAPI.Voting;
-
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
-
-/// <summary>
-/// Invoked before the dummy selects their vote. If canceled, the dummy won't vote.
-/// </summary>
-/// <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; } = dummy;
-
-    /// <summary>
-    /// Gets the instance of the dummy's <see cref="PlayerVoteData"/>.
-    /// </summary>
-    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; } = 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; } = x => !x.Data.IsDead && !x.Data.Disconnected;
-}

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

@@ -1,46 +0,0 @@
-using MiraAPI.Voting;
-
-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.
-/// </summary>
-/// <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 <see cref="PlayerVoteData"/>.
-    /// </summary>
-    public PlayerVoteData VoteData { get; } = playerVoteData;
-
-    /// <summary>
-    /// Gets the player who voted.
-    /// </summary>
-    public PlayerControl Player { get; } = playerVoteData.Owner;
-
-    /// <summary>
-    /// Gets the player id of the target.
-    /// </summary>
-    public byte TargetId { get; } = targetId;
-
-    /// <summary>
-    /// Gets or sets a value indicating whether to prevent the vote from commencing.
-    /// </summary>
-    public bool PreventVote { get; set; } = false;
-
-    /// <summary>
-    /// Gets the <see cref="NetworkedPlayerInfo"/> of the target.
-    /// </summary>
-    public NetworkedPlayerInfo TargetPlayerInfo { get; } = GameData.Instance.GetPlayerById(targetId);
-
-    /// <summary>
-    /// Gets or sets a value indicating whether the vote event is an Overrule caused by a Judge.
-    /// </summary>
-    public bool IsOverruling { get; set; } = isOverruling;
-}

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

@@ -1,32 +0,0 @@
-using MiraAPI.Voting;
-
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
-
-/// <summary>
-/// The event that is invoked when the player tries to select another player to vote.
-/// </summary>
-/// <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 <see cref="PlayerVoteData"/>.
-    /// </summary>
-    public PlayerVoteData VoteData { get; } = playerVoteData;
-
-    /// <summary>
-    /// Gets the player id of the target.
-    /// </summary>
-    public int TargetId { get; } = targetId;
-
-    /// <summary>
-    /// Gets the <see cref="NetworkedPlayerInfo"/> of the target.
-    /// </summary>
-    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; } = allowSelect;
-}

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

@@ -1,19 +0,0 @@
-using System.Collections.Generic;
-using MiraAPI.Voting;
-
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
-
-/// <summary>
-/// Called in <see cref="VotingUtils.HandlePopulateResults"/>.
-/// </summary>
-/// <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 <see cref="CustomVote"/>s.
-    /// </summary>
-    public List<CustomVote> Votes { get; } = votes;
-}

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

@@ -1,56 +0,0 @@
-using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
-using System.Linq;
-using MiraAPI.Voting;
-
-namespace MiraAPI.Events.Vanilla.Meeting.Voting;
-
-/// <summary>
-/// Ran after calculating votes and before displaying the results. Only ran on the host.
-/// </summary>
-/// <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];
-
-    /// <summary>
-    /// Gets a value indicating whether the exiled player has been modified by the event.
-    /// </summary>
-    public bool ExiledPlayerModified { get; private set; }
-
-    /// <summary>
-    /// Gets a value indicating whether the votes have been modified by the event.
-    /// </summary>
-    public bool VotesModified => !Votes.SequenceEqual(originalVotes);
-
-    /// <summary>
-    /// Gets the list of <see cref="CustomVote"/>s that are being processed.
-    /// </summary>
-    public List<CustomVote> Votes { get; } = votes;
-
-    /// <summary>
-    /// 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;
-        set
-        {
-            field = value;
-            ExiledPlayerModified = true;
-        }
-    }
-    = exiledPlayer;
-}

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

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

MiraAPI/Events/Vanilla/Player/CompleteHnsTaskEvent.cs

@@ -1,25 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Player;
-
-/// <summary>
-/// The event that is invoked when a player completes a task within Hide and Seek. Non-cancelable.
-/// </summary>
-/// <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; } = player;
-
-    /// <summary>
-    /// Gets the instance of the <see cref="PlayerTask"/> that the player completed.
-    /// </summary>
-    public PlayerTask Task { get; } = task;
-
-    /// <summary>
-    /// Gets the instance of the <see cref="HideAndSeekManager"/> attached to the game.
-    /// </summary>
-    public HideAndSeekManager HnsManager { get; } = hnsManager;
-}

MiraAPI/Events/Vanilla/Player/CompleteTaskEvent.cs

@@ -1,19 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Player;
-
-/// <summary>
-/// The event that is invoked when a player completes a task. Non-cancelable.
-/// </summary>
-/// <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; } = player;
-
-    /// <summary>
-    /// Gets the instance of the <see cref="PlayerTask"/> that the player completed.
-    /// </summary>
-    public PlayerTask Task { get; } = task;
-}

MiraAPI/Events/Vanilla/Player/PlayerDeathEvent.cs

@@ -1,25 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Player;
-
-/// <summary>
-/// Event that is invoked when a player dies. Non-cancelable.
-/// </summary>
-/// <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; } = player;
-
-    /// <summary>
-    /// Gets the reason the player died.
-    /// </summary>
-    public DeathReason DeathReason { get; } = reason;
-
-    /// <summary>
-    /// Gets the <see cref="global::DeadBody"/> associated with the player, if any.
-    /// </summary>
-    public DeadBody? DeadBody { get; } = deadBody;
-}

MiraAPI/Events/Vanilla/Player/PlayerJoinEvent.cs

@@ -1,15 +0,0 @@
-using InnerNet;
-
-namespace MiraAPI.Events.Vanilla.Player;
-
-/// <summary>
-/// Event that is invoked when a player joins the lobby. Non-cancelable.
-/// </summary>
-/// <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; } = data;
-}

MiraAPI/Events/Vanilla/Player/PlayerLeaveEvent.cs

@@ -1,21 +0,0 @@
-using InnerNet;
-
-namespace MiraAPI.Events.Vanilla.Player;
-
-/// <summary>
-/// Event that is invoked when a player leaves the game. Non-cancelable.
-/// </summary>
-/// <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; } = data;
-
-    /// <summary>
-    /// Gets the reason why the player left.
-    /// </summary>
-    public DisconnectReasons Reason { get; } = reason;
-}

MiraAPI/Events/Vanilla/Usables/EnterVentEvent.cs

@@ -1,19 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Usables;
-
-/// <summary>
-/// Event that is invoked when a player enters a vent. This event is cancelable.
-/// </summary>
-/// <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 <see cref="PlayerControl"/> that is entering the <see cref="Vent"/>.
-    /// </summary>
-    public PlayerControl Player { get; } = player;
-
-    /// <summary>
-    /// Gets the <see cref="global::Vent"/> that the <see cref="Player"/> is entering.
-    /// </summary>
-    public Vent? Vent { get; } = vent;
-}

MiraAPI/Events/Vanilla/Usables/ExitVentEvent.cs

@@ -1,19 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Usables;
-
-/// <summary>
-/// Event that is invoked when a player exits a vent. This event is cancelable.
-/// </summary>
-/// <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 <see cref="PlayerControl"/> that is exiting the <see cref="Vent"/>.
-    /// </summary>
-    public PlayerControl Player { get; } = player;
-
-    /// <summary>
-    /// Gets the <see cref="global::Vent"/> that the <see cref="Player"/> is exiting.
-    /// </summary>
-    public Vent? Vent { get; } = vent;
-}

MiraAPI/Events/Vanilla/Usables/PlayerCanUseEvent.cs

@@ -1,7 +0,0 @@
-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 run locally.
-/// </summary>
-/// <param name="usable">The <see cref="IUsable"/>.</param>
-public class PlayerCanUseEvent(IUsable usable) : PlayerUseEvent(usable);

MiraAPI/Events/Vanilla/Usables/PlayerUseEvent.cs

@@ -1,23 +0,0 @@
-namespace MiraAPI.Events.Vanilla.Usables;
-
-/// <summary>
-/// Event for <see cref="PlayerControl"/> using a <see cref="IUsable"/> from Vanilla Among Us. Will always be run locally.
-/// </summary>
-/// <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; } = usable;
-
-    /// <summary>
-    /// 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; } = usable.TryCast<Console>() || usable.TryCast<SystemConsole>() || usable.TryCast<MapConsole>();
-
-    /// <summary>
-    /// Gets a value indicating whether the <see cref="Usable"/> is a <see cref="Vent"/>.
-    /// </summary>
-    public bool IsVent { get; } = usable.TryCast<Vent>();
-}

MiraAPI/GameEnd/CustomGameOver.cs

@@ -1,80 +0,0 @@
-using System.Collections.Generic;
-using MiraAPI.Networking;
-using Reactor.Networking.Rpc;
-
-namespace MiraAPI.GameEnd;
-
-/// <summary>
-/// Custom Game Over.
-/// </summary>
-public abstract class CustomGameOver
-{
-    /// <summary>
-    /// Gets the current <see cref="CustomGameOver"/>.
-    /// </summary>
-    public static CustomGameOver? Instance { get; internal set; }
-
-    /// <summary>
-    /// Verifies if the condition for this <see cref="CustomGameOver"/> is met.
-    /// </summary>
-    /// <param name="playerControl">The <see cref="PlayerControl"/> that requested the Game Over.</param>
-    /// <param name="winners">The collection of winners.</param>
-    /// <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 <see cref="EndGameManager.SetEverythingUp"/>.
-    /// </summary>
-    /// <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 <see cref="EndGameManager.SetEverythingUp"/>.
-    /// </summary>
-    /// <param name="endGameManager">The <see cref="EndGameManager"/> instance.</param>
-    public virtual void AfterEndGameSetup(EndGameManager endGameManager)
-    {
-    }
-
-    /// <summary>
-    /// 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 <see cref="global::GameOverReason"/> associated with the custom game over.</returns>
-    public static GameOverReason GameOverReason<T>()
-        where T : CustomGameOver
-    {
-        return (GameOverReason)GameOverManager.GetGameOverId<T>();
-    }
-
-    /// <summary>
-    /// Send a custom game over.
-    /// </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
-    {
-        var reason = GameOverManager.GetGameOverId<T>();
-        var data = new GameOverData(reason, [.. winners]);
-
-        Rpc<CustomGameOverRpc>.Instance.Send(PlayerControl.LocalPlayer, data, true);
-    }
-
-    /// <summary>
-    /// Implicitly convert a <see cref="CustomGameOver"/> to a <see cref="global::GameOverReason"/>.
-    /// </summary>
-    /// <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/GameOverData.cs

@@ -1,10 +0,0 @@
-using System.Collections.Generic;
-
-namespace MiraAPI.GameEnd;
-
-/// <summary>
-/// Data for a game over.
-/// </summary>
-/// <param name="Reason">Reason for the game over.</param>
-/// <param name="Winners">A collection of winners.</param>
-public record struct GameOverData(int Reason, List<NetworkedPlayerInfo> Winners);

MiraAPI/GameEnd/GameOverManager.cs

@@ -1,89 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
-
-namespace MiraAPI.GameEnd;
-
-/// <summary>
-/// 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;
-
-    /// <summary>
-    /// Register a <see cref="CustomGameOver"/>.
-    /// </summary>
-    /// <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))
-        {
-            return false;
-        }
-
-        if (gameOverType.IsAbstract)
-        {
-            Error("The type must not be abstract.");
-            return false;
-        }
-
-        if (gameOverType.GetConstructor(Type.EmptyTypes) == null)
-        {
-            Error("The type must have a parameterless constructor.");
-            return false;
-        }
-
-        GameOverIds.Add(gameOverType, nextId);
-        GameOverTypes.Add(nextId, gameOverType);
-        nextId++;
-        return true;
-    }
-
-    /// <summary>
-    /// Create an instance of a <see cref="CustomGameOver"/>.
-    /// </summary>
-    /// <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))
-        {
-            customGameOver = Activator.CreateInstance(gameOverType) as CustomGameOver;
-            return customGameOver != null;
-        }
-
-        customGameOver = null;
-        return false;
-    }
-
-    /// <summary>
-    /// Get the ID of a <see cref="CustomGameOver"/>.
-    /// </summary>
-    /// <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 <see cref="CustomGameOver"/>.
-    /// </summary>
-    /// <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)
-    {
-        return GameOverIds.TryGetValue(gameOverType, out var id)
-            ? id
-            : throw new ArgumentException($"{gameOverType.FullName} is not a registered custom game over!");
-    }
-}