All-Of-Us-Mods/MiraAPI
Easy to use Among Us modding API
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.
Mira API
A thorough, but simple, Among Us modding API and utility library that covers:
- Roles
- Options
- Modifiers
- Buttons
- Custom Colors
- Events
- Voting
- Assets
- Keybinds
- Local Settings
- Custom Game Over Conditions
- Compatibility
Game Modes(coming soon)
Mira API strives to be comprehensive, yet straightforward, 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:
- Add a reference to Mira API either through a DLL, project reference, or NuGet package.
- Add a BepInDependency on your plugin class like this:
[BepInDependency(MiraApiPlugin.Id)] - Implement the
IMiraPlugininterface on your plugin class.
Mira API also depends on Reactor to function properly!
Remember to include it as a reference and BepInDependency!
For a full example, see this file.
Recommended Project Structure
It is highly recommended to follow this project structure when using Mira API 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
Documentation
Full documentation for every Mira API feature is available on the wiki: