MiraAPI/README.md

Mira API

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

• Roles
• Options
• Buttons
• Assets
• Compatibility
• Modifiers (coming soon)
• 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

Usage

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.

For a full example, see this file.

Recommended Project Structure

It is highly recommended to follow this project structure when using Mira API in order to keep your code clean and organized. You can also view the Example Mod in this repository for some guidance.

MyMiraMod/
├── Buttons/
│   └── MyCoolButton.cs
├── Options/
│   ├── Roles/
│   │   └── CoolCustomRoleOptions.cs
│   └── MainOptionGroup.cs
├── Patches/
│   ├── Roles/
│   │   └── CoolCustomRole/
│   │       ├── PlayerControlPatches.cs
│   │       └── ExileControllerPatches.cs
│   └── General/
│       └── HudManagerPatches.cs
├── Resources/
│   ├── CoolButton.png
│   └── myAssets-win-x86.bundle
├── Roles/
│   └── CoolCustomRole.cs
├── MyMiraModPlugin.cs
└── MyModAssets.cs

Roles

Roles are very simple in Mira API. There are 3 things you need to do to create a custom role:

1. Create a class that inherits from a base game role (like CrewmateRole, ImpostorRole, etc)
2. Implement the ICustomRole interface from Mira API.
3. Add the [RegisterCustomRole] attribute to the class.

Note: For step 1, if you are making neutral roles, choose either CrewmateRole or ImpostorRole as the base depending on if it can kill or not!

Mira API handles everything else, from adding the proper options to the settings menu, to managing the role assignment at the start of the game. There are no extra steps on the developer's part.

See this file for a code example.

Options

Options are also very simple in Mira API. Mira API handles all the hard work behind the scenes, so developers only have to follow a few steps to create their custom options. The Options API is split up into Groups and Options. Every Option needs to be in a Group.

To create a group, you need to create a class that inherits from the AbstractOptionGroup abstract class. Groups contain 4 properties, GroupName, GroupColor, GroupVisible, and AdvancedRole. Only the GroupName is required.

Here is an example of a group class:

public class MyOptionsGroup : AbstractOptionGroup
{
    public override string GroupName => "My Options"; // this is required
    
    [ModdedNumberOption("My Number Option", min: 0, max: 10)]
    public float MyNumberOption { get; set; } = 5f;
}

You can access any group class using the OptionGroupSingleton class like this:

// MyOptionsGroup is a class that inherits from AbstractOptionGroup
var myGroup = OptionGroupSingleton<MyOptionsGroup>.Instance; // gets the instance of the group
System.Out.Console.WriteLine(myGroup.MyNumberOption); // prints the value of the option to the console

Once you have an options group, there are two ways to make the actual options:

• Use an Option Attribute with a property.
• Create a ModdedOption property.

Option Attributes

This is an example of using an Option Attribute on a property:

// The first parameter is always the name of the option. The rest are dependent on the type of option.
[ModdedNumberOption("Sussy level", min: 0, max: 10)]
public float SussyLevel { get; set; } = 4f; // You can set a default value here.

Here are the available Option Attributes and their signatures:

ModdedEnumOption(string name, Type enumType, Type roleType = null)
    
ModdedNumberOption(
    string name,
    float min,
    float max,
    float increment=1
    NumberSuffixes suffixType = NumberSuffixes.None,
    bool zeroInfinity = false,
    Type roleType = null)
    
ModdedStringOption(string title, string[] values, Type roleType = null)

ModdedToggleOption(string name, Type roleType = null)

ModdedOption Properties

And this is an example of a ModdedOption property:

public ModdedToggleOption YeezusAbility { get; } = new ModdedToggleOption("Yeezus Ability", false);

Here is a full list of ModdedOption classes you can use:

• ModdedEnumOption
• ModdedNumberOption
• ModdedStringOption
• ModdedToggleOption

To see a full example of an options class, see this file.

Role Options

You can also specify a role type for an option or option group.

To set the role type for an entire group, set the AdvancedRole property on that group like this:

public class MyOptionsGroup : AbstractOptionGroup
{
    public override string GroupName => "My Options";
    public override Type AdvancedRole => typeof(MyRole); // this is the role that will have these options
    
    [ModdedNumberOption("Ability Uses", min: 0, max: 10)]
    public float AbilityUses { get; set; } = 5f;
}

To set the role type for individual options, specify the roleType parameter in the option like this:

// this group doesnt specify a role, so it will show up in the global settings
public class MyOptionsGroup : AbstractOptionGroup
{
    public override string GroupName => "My Options";
    
    // this option will only show up in the settings for MyRole
    [ModdedNumberOption("Ability Uses", min: 0, max: 10, roleType: typeof(MyRole))]
    public float AbilityUses { get; set; } = 5f;
}

An example can be found here.

Buttons

Mira API provides a simple interface for adding ability buttons to the game. There is only 2 steps:

1. Create a class that inherits from the CustomActionButton class and implement the properties and methods.
2. Add the [RegisterCustomButton] attribute to the class.

All other tasks and logic required to add the button to the game are handled by Mira API.

The button API is simple, but provides a lot of flexibility. There are various methods you can override to customize the behaviour of your button. See this file for a full list of methods you can override.

An example button can be found here.

Assets

Mira API provides a simple, but expandable asset system. The core of the system is the LoadableAsset<T> class. This is a generic abstract class that provides a pattern for loading assets.

Mira API comes with two asset loaders:

1. LoadableBundleAsset<T>: This is used for loading assets from AssetBundles.
2. LoadableResourceAsset: This is used for loading only sprites from the Embedded Resources within a mod.

The code below shows how to use these asset loaders:

// Load a sprite from an AssetBundle
AssetBundle bundle = AssetBundleManager.Load("MyBundle"); // AssetBundleManager is a utility provided by Reactor
LoadableAsset<Sprite> mySpriteAsset = new LoadableBundleAsset<Sprite>("MySprite", bundle);
Sprite sprite = mySpriteAsset.LoadAsset();

// Load a sprite from an Embedded Resource
// Make sure to set the Build Action of your image to Embedded Resource!
LoadableAsset<Sprite> buttonAsset = new LoadableResourceAsset("ExampleMod.Resources.MyButton.png");
Sprite button = buttonSpriteAsset.LoadAsset();

You can view an example file here.

You can create your own asset loaders by inheriting from LoadableAsset<T> and implementing the LoadAsset method.

Disclaimer

This mod is not affiliated with Among Us or Innersloth LLC, and the content contained therein is not endorsed or otherwise sponsored by Innersloth LLC. Portions of the materials contained herein are property of Innersloth LLC. © Innersloth LLC.