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

Update README.md

Browse Source
This commit is contained in:
Ang authored and GitHub committed 2024-08-27 21:29:29 -04:00
1 parent 4bef2f838d
commit 8d167596d2
1 file changed
+2
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -57,6 +57,8 @@ Roles are very simple in Mira API. There are 3 things you need to do to create a
2. Implement the `ICustomRole` interface from Mira API.
3. Add the `[RegisterCustomRole]` attribute to the class.
**Disclaimer: Make sure your plugin class has the following attribute `[ReactorModFlags(ModFlags.RequireOnAllClients)]` or else your roles will not register correctly.**
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.