AmongUsMods/MiraAPI
1
0 Fork 0
mirror of https://github.com/All-Of-Us-Mods/MiraAPI.git synced 2026-10-20 01:46:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates to readme (formatting, info, etc)

Browse Source
This commit is contained in:
XtraCube committed 2024-08-24 11:31:37 -04:00
1 parent 7480217d6c
commit 3a14a95e3b
1 file changed
+5 -4
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -4
View File
@@ -2,14 +2,15 @@
# Mira API # Mira API
A thorough, but simple, Among Us modding API that covers: A thorough, but simple, Among Us modding API and utility library that covers:
- Roles - Roles
- Options - Options
- Gamemodes - Modifiers
- Game Modes
- Assets - Assets
- HUD Elements - HUD Elements
- Compatibility - Compatibility
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. 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.
# Usage # Usage
@@ -46,7 +47,7 @@ public class MyOptionsGroup : AbstractOptionGroup
``` ```
You can access any group class using the `OptionGroupSingleton` class like this: You can access any group class using the `OptionGroupSingleton` class like this:
``` ```csharp
// MyOptionsGroup is a class that inherits from AbstractOptionGroup // MyOptionsGroup is a class that inherits from AbstractOptionGroup
var myGroup = OptionGroupSingleton<MyOptionsGroup>.Instance; // gets the instance of the group 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 System.Out.Console.WriteLine(myGroup.MyNumberOption); // prints the value of the option to the console