Home

Mira API

A thorough, but simple, Among Us modding API and utility library that covers:

• Roles
• Options
• Modifiers
• Buttons
• Custom Colors
• Assets
• Compatibility
• Game Modes (coming soon)

Mira API strives to be simple and easy to use, while also using as many base game elements as possible. The result is a less intrusive, better modding API that covers general use cases.

Join the Discord for support and to stay updated on the latest releases

Get Started

To start using Mira API, you need to:

1. Add a reference to Mira API either through a DLL, project reference, or NuGet package.
2. Add a BepInDependency on your plugin class like this: [BepInDependency(MiraApiPlugin.Id)]
3. Implement the IMiraPlugin interface on your plugin class.

The IMiraPlugin interface has some methods and properties that need to be properly implemented for Mira API to function correctly:

• public string OptionsTitleText { get; }: The value of this string is shown within the Game Options menu.
• public ConfigFile GetConfigFile(): This method should return the plugin's BepInEx provided Config File. This is used for saving your custom options correctly.

After following these steps, your plugin class should resemble this example one:

[BepInAutoPlugin("mira.example", "MiraExampleMod")]
[BepInProcess("Among Us.exe")]
[BepInDependency(ReactorPlugin.Id)]
[BepInDependency(MiraApiPlugin.Id)] // The Mira API dependency attribute
[ReactorModFlags(ModFlags.RequireOnAllClients)]
public partial class ExamplePlugin : BasePlugin, IMiraPlugin
{
    public Harmony Harmony { get; } = new(Id);
    public string OptionsTitleText => "Mira API\nExample Mod";
    public ConfigFile GetConfigFile() => Config;
    public override void Load()
    {
        Harmony.PatchAll();
    }
}