Merge branch 'dev' into util-extension-dev

MiraAPI.Example/Buttons/Freezer/FreezeButton.cs

@@ -13,7 +13,7 @@ namespace MiraAPI.Example.Buttons.Freezer;
 
 public class FreezeButton : CustomActionButton<PlayerControl>
 {
-    public override string Name => "Freeze";
+    public override string Name => "button.freeze";
 
     public override float Cooldown => OptionGroupSingleton<FreezerRoleSettings>.Instance.FreezeDuration;
     public override bool PauseTimerInVent => true;

MiraAPI.Example/Buttons/MeetingButton.cs

@@ -9,7 +9,7 @@ namespace MiraAPI.Example.Buttons;
 
 public class MeetingButton : CustomActionButton
 {
-    public override string Name => "Call Meeting";
+    public override string Name => "button.callMeeting";
 
     public override float Cooldown => 15;
 

MiraAPI.Example/Buttons/NeutralKillerButton.cs

@@ -10,7 +10,7 @@ namespace MiraAPI.Example.Buttons;
 
 public class NeutralKillerButton : CustomActionButton
 {
-    public override string Name => "Win Game";
+    public override string Name => "button.winGame";
     public override float Cooldown => 0f;
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
     public override MiraKeybind Keybind => ExampleKeybinds.NeutralWinKeybind;

MiraAPI.Example/Buttons/Teleporter/TeleportButton.cs

@@ -12,7 +12,7 @@ namespace MiraAPI.Example.Buttons.Teleporter;
 
 public class TeleportButton : CustomActionButton
 {
-    public override string Name => "Teleport";
+    public override string Name => "button.teleport";
 
     public override float Cooldown => OptionGroupSingleton<TeleporterOptions>.Instance.TeleportCooldown.Value;
 

MiraAPI.Example/Buttons/ThinkButton.cs

@@ -1,4 +1,5 @@
 using MiraAPI.Hud;
+using MiraAPI.Translation;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
@@ -6,7 +7,7 @@ namespace MiraAPI.Example.Buttons;
 
 public class ThinkButton : CustomActionButton
 {
-    public override string Name => "Think";
+    public override string Name => "button.think";
     public override float Cooldown => 15f;
     public override float EffectDuration => 10f;
     public override int MaxUses => 1;
@@ -14,13 +15,12 @@ public class ThinkButton : CustomActionButton
     public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
     protected override void OnClick()
     {
-        // This button does absolutely nothing besides changing its text
-        Button!.OverrideText("Thinking...");
+        Button!.OverrideText("button.think.thinking".Translate());
     }
 
     public override void OnEffectEnd()
     {
-        Button!.OverrideText("Think");
+        Button!.OverrideText("button.think".Translate());
     }
 
     public override bool IsEffectCancellable()

MiraAPI.Example/ExampleAssets.cs

@@ -9,5 +9,6 @@ public static class ExampleAssets
 
     // Credit to EpicHorrors for the teleport button asset.
     public static LoadableResourceAsset TeleportButton { get; } = new("MiraAPI.Example.Resources.TeleportButton.png");
+    public static LoadableResourceAsset SharpshootButton { get; } = new("MiraAPI.Example.Resources.SharpshootButton.png");
     public static LoadableResourceAsset Banner { get; } = new("MiraAPI.Example.Resources.FortniteBanner.jpeg");
 }

MiraAPI.Example/ExampleColors.cs

@@ -6,12 +6,12 @@ namespace MiraAPI.Example;
 [RegisterCustomColors]
 public static class ExampleColors
 {
-    public static CustomColor Cerulean { get; } = new("Cerulean", new Color(0.0f, 0.48f, 0.65f))
+    public static CustomColor Cerulean { get; } = new("color.cerulean", new Color(0.0f, 0.48f, 0.65f))
     {
         ColorBrightness = CustomColorBrightness.Lighter,
     };
 
-    public static CustomColor Rose { get; } = new("Rose", new Color(0.98f, 0.26f, 0.62f));
+    public static CustomColor Rose { get; } = new("color.rose", new Color(0.98f, 0.26f, 0.62f));
 
-    public static CustomColor Gold { get; } = new("Gold", new Color(1.0f, 0.84f, 0.0f));
+    public static CustomColor Gold { get; } = new("color.gold", new Color(1.0f, 0.84f, 0.0f));
 }

MiraAPI.Example/ExampleLocalSetings.cs

@@ -8,7 +8,7 @@ namespace MiraAPI.Example;
 
 public class ExampleLocalSettings(ConfigFile config) : LocalSettingsTab(config)
 {
-    public override string TabName => "Mira Example";
+    public override string TabName => "settings.miraExample";
     protected override bool ShouldCreateLabels => false;
 
     public override LocalSettingTabAppearance TabAppearance => new()
@@ -18,7 +18,7 @@ public class ExampleLocalSettings(ConfigFile config) : LocalSettingsTab(config)
     };
 
     [LocalSettingsButton]
-    public LocalSettingsButton ExampleButton { get; private set; } = new("Example Button", OnExampleButtonClick);
+    public LocalSettingsButton ExampleButton { get; private set; } = new("settings.miraExample.button.exampleButton", OnExampleButtonClick);
 
     [LocalToggleSetting]
     public ConfigEntry<bool> ExampleToggle { get; private set; } = config.Bind("General", "Example Bool", true);

MiraAPI.Example/ExamplePlugin.cs

@@ -3,6 +3,7 @@ using BepInEx.Configuration;
 using BepInEx.Unity.IL2CPP;
 using HarmonyLib;
 using MiraAPI.PluginLoading;
+using MiraAPI.Translation;
 using Reactor;
 using Reactor.Networking;
 using Reactor.Networking.Attributes;
@@ -16,8 +17,13 @@ namespace MiraAPI.Example;
 [ReactorModFlags(ModFlags.RequireOnAllClients)]
 public partial class ExamplePlugin : BasePlugin, IMiraPlugin
 {
+    public ExamplePlugin()
+    {
+        MiraLocaleManager.Register("mira.example");
+    }
     public Harmony Harmony { get; } = new(Id);
     public string OptionsTitleText => "Mira API\nExample Mod";
+    public string CustomOptionMenuNameTwo => "angxl's Options";
     public ConfigFile GetConfigFile() => Config;
     public override void Load()
     {

MiraAPI.Example/GameModes/ExampleMode.cs

@@ -0,0 +1,13 @@
+using MiraAPI.GameModes;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.GameModes;
+
+public class ExampleMode : AbstractGameMode
+{
+    public override string Name => "Example Mode";
+    public override string Description => "An example gamemode.";
+    public override LoadableAsset<Sprite>? Icon => ExampleAssets.ExampleButton;
+    public override Color Color => Color.red;
+}

MiraAPI.Example/GameOver/NeutralKillerGameOver.cs

@@ -1,5 +1,6 @@
 using MiraAPI.Example.Roles;
 using MiraAPI.GameEnd;
+using MiraAPI.Translation;
 using MiraAPI.Utilities;
 using UnityEngine;
 
@@ -14,7 +15,7 @@ public class NeutralKillerGameOver : CustomGameOver
 
     public override void AfterEndGameSetup(EndGameManager endGameManager)
     {
-        endGameManager.WinText.text = "Outcast Killer Wins!";
+        endGameManager.WinText.text = "gameover.outcastKiller.win".Translate();
         endGameManager.WinText.color = Color.magenta;
         endGameManager.BackgroundBar.material.SetColor(ShaderID.Color, Color.magenta);
     }

MiraAPI.Example/MeetingAbilities/EndMeetingButton.cs

@@ -0,0 +1,29 @@
+using MiraAPI.Example.Roles;
+using MiraAPI.MeetingAbilities;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.MeetingAbilities;
+
+public class EndMeetingButton : MeetingActionButton
+{
+    public override string Name => "End Meeting";
+
+    public override float Cooldown => 15;
+
+    public override float InitialCooldown => 30;
+
+    public override int MaxUses => 3;
+
+    public override LoadableAsset<Sprite> Sprite => ExampleAssets.ExampleButton;
+
+    public override bool Enabled(RoleBehaviour? role)
+    {
+        return PlayerControl.LocalPlayer != null && role is MayorRole;
+    }
+
+    protected override void OnClick()
+    {
+        MeetingHud.Instance.RpcClose();
+    }
+}

MiraAPI.Example/MeetingAbilities/ShootButton.cs

@@ -0,0 +1,37 @@
+using MiraAPI.MeetingAbilities;
+using MiraAPI.Networking;
+using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.MeetingAbilities;
+
+public class ShootButton : TargetedMeetingButton
+{
+    public override string Name => "Shoot";
+
+    public override int MaxUses => 3;
+
+    public override float InitialCooldown => 5;
+
+    public override float Cooldown => 3;
+
+    public override LoadableAsset<Sprite> Sprite => ExampleAssets.SharpshootButton;
+
+    public override Color OutlineColor => Color.red;
+
+    public override bool Enabled(RoleBehaviour r)
+    {
+        return r.IsImpostor;
+    }
+
+    protected override void OnClick(PlayerVoteArea playerVoteArea)
+    {
+        playerVoteArea.SetDisabled();
+        var player = playerVoteArea.GetPlayer();
+        if (player != null)
+        {
+            PlayerControl.LocalPlayer.RpcCustomMurder(player);
+        }
+    }
+}

MiraAPI.Example/MeetingAbilities/ShotgunButton.cs

@@ -0,0 +1,54 @@
+using MiraAPI.MeetingAbilities;
+using MiraAPI.Networking;
+using MiraAPI.Utilities;
+using MiraAPI.Utilities.Assets;
+using UnityEngine;
+
+namespace MiraAPI.Example.MeetingAbilities;
+
+public class ShotgunButton : MultiTargetMeetingButton
+{
+    public override string Name => "Shotgun";
+
+    public override int MaxUses => 3;
+
+    public override float InitialCooldown => 5;
+
+    public override float Cooldown => 3;
+
+    public override LoadableAsset<Sprite> Sprite => ExampleAssets.SharpshootButton;
+
+    public override Color OutlineColor => Color.red;
+
+    public override bool Enabled(RoleBehaviour r)
+    {
+        return r.IsImpostor;
+    }
+
+    protected override void OnClick(PlayerVoteArea playerVoteArea)
+    {
+        // Emptu because it only triggers the actual kills once all meeting abilities have been used.
+    }
+
+    public override LoadableAsset<Sprite> SpriteActive => ExampleAssets.CallMeetingButton;
+
+    public override int TargetsCount => 4;
+
+    protected override void OnSelect(PlayerVoteArea playerVoteArea, bool toggle)
+    {
+        HudManager.Instance.PlayerCam.ShakeScreen(0.5f, 2);
+    }
+
+    public override void OnFinish()
+    {
+        foreach (var playerVoteArea in Targets.Keys)
+        {
+            playerVoteArea.SetDisabled();
+            var player = playerVoteArea.GetPlayer();
+            if (player != null)
+            {
+                PlayerControl.LocalPlayer.RpcCustomMurder(player);
+            }
+        }
+    }
+}

MiraAPI.Example/MiraAPI.Example.csproj

@@ -3,6 +3,7 @@
 		<Version>1.0.0</Version>
 		<Description>Example mod for Mira API</Description>
 		<Authors>Angxl, XtraCube</Authors>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<ItemGroup>

MiraAPI.Example/Modifiers/CaptainModifier.cs

@@ -2,6 +2,7 @@
 using MiraAPI.GameOptions;
 using MiraAPI.Modifiers;
 using MiraAPI.Modifiers.Types;
+using MiraAPI.Translation;
 using MiraAPI.Utilities.Assets;
 using UnityEngine;
 
@@ -9,7 +10,7 @@ namespace MiraAPI.Example.Modifiers;
 
 public class CaptainModifier : GameModifier
 {
-    public override string ModifierName => "Captain";
+    public override string ModifierName => MiraLocaleManager.Get("modifier.captain");
     public override LoadableAsset<Sprite>? ModifierIcon => ExampleAssets.CallMeetingButton;
 
     public override void OnDeath(DeathReason reason)
@@ -19,7 +20,7 @@ public class CaptainModifier : GameModifier
 
     public override string GetDescription()
     {
-        return $"You can call a meeting from anywhere on the map.";
+        return MiraLocaleManager.Get("modifier.captain.TabDescription");
     }
 
     public override int GetAssignmentChance()

MiraAPI.Example/Modifiers/Freezer/FreezeModifier.cs

@@ -1,13 +1,14 @@
 using Il2CppSystem;
 using MiraAPI.Example.Roles;
 using MiraAPI.Modifiers.Types;
+using MiraAPI.Translation;
 using UnityEngine;
 
 namespace MiraAPI.Example.Modifiers.Freezer;
 
 public class FreezeModifier : TimedModifier
 {
-    public override string ModifierName => "Freezed";
+    public override string ModifierName => MiraLocaleManager.Get("modifier.freezed");
     public override bool HideOnUi => false;
     public override float Duration => 15f;
     public override bool AutoStart => true;

MiraAPI.Example/Modifiers/HighPriorityModifier.cs

@@ -1,14 +1,15 @@
 using MiraAPI.Modifiers.Types;
+using MiraAPI.Translation;
 
 namespace MiraAPI.Example.Modifiers;
 
 public class HighPriorityModifier : GameModifier
 {
-    public override string ModifierName => "High Priority";
+    public override string ModifierName => MiraLocaleManager.Get("modifier.highPriority");
 
     public override string GetDescription()
     {
-        return "You are high priority! Idrk what this means either tbh...";
+        return MiraLocaleManager.Get("modifier.highPriority.TabDescription");
     }
 
     public override int GetAssignmentChance()

MiraAPI.Example/Options/ExampleOptions.cs

@@ -8,23 +8,23 @@ namespace MiraAPI.Example.Options;
 
 public class ExampleOptions : AbstractOptionGroup
 {
-    public override string GroupName => "Example Options 1";
+    public override string GroupName => "options.exampleOptions1";
     public override Color GroupColor => Color.green;
 
-    [ModdedToggleOption("Toggle Opt 1")]
+    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
     public bool ToggleOpt { get; set; } = false;
 
-    [ModdedToggleOption("Toggle Opt 2")]
+    [ModdedToggleOption("options.exampleOptions1.toggleOpt1")]
     public bool ToggleOpt2 { get; set; } = true;
 
     [ModdedToggleOption("Toggle Opt 3")]
     [ModdedOptionVisiblity(nameof(ToggleOpt2))] // ToggleOpt3 will be visible only when ToggleOpt2 is true
     public bool ToggleOpt3 { get; set; } = true;
 
-    [ModdedNumberOption("Number Opt", min: 0, max: 10, increment: .25f, formatString: "0.00", suffixType: MiraNumberSuffixes.Percent)]
+    [ModdedNumberOption("options.exampleOptions1.numberOpt", min: 0, max: 10, increment: .25f, formatString: "0.00", suffixType: MiraNumberSuffixes.Percent)]
     public float NumberOpt { get; set; } = 4f;
 
-    [ModdedEnumOption("Best API", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
+    [ModdedEnumOption("options.exampleOptions1.bestApi", typeof(BestApi), ["Mira API", "Mitochondria", "Reactor"])]
     public BestApi Opt { get; set; } = BestApi.MiraAPI;
 
     [ModdedEnumOptionList<ValueState>("Value State {0}", ["None", "Primary", "Secondary"])]

MiraAPI.Example/Options/ExampleOptions2.cs

@@ -6,25 +6,25 @@ namespace MiraAPI.Example.Options;
 
 public class ExampleOptions2 : AbstractOptionGroup
 {
-    public override string GroupName => "Example Options 2";
+    public override string GroupName => "options.exampleOptions2";
 
     public override uint GroupPriority => 0; // This group will be displayed first. The default value is uint.MaxValue.
 
     public override MenuCategory ParentMenu => MenuCategory.CustomTwo;
 
-    public ModdedPlayerOption PlayerOption2 { get; } = new("YOU MUST CHOSE A PLAYER", false);
-    public ModdedPlayerOption PlayerOption { get; } = new("Eh whatever");
-    public ModdedToggleOption ToggleOpt1 { get; } = new("Toggle Option 1", false);
+    public ModdedPlayerOption PlayerOption2 { get; } = new("options.exampleOptions2.youMustChoseAPlayer", false);
+    public ModdedPlayerOption PlayerOption { get; } = new("options.exampleOptions2.ehWhatever");
+    public ModdedToggleOption ToggleOpt1 { get; } = new("options.exampleOptions2.toggleOption1", false);
 
     public ModdedOptionList<ModdedNumberOption> PlayerNums { get; } = new(5, i =>
         new($"PlayerNum{i}", 2, 0, 5, 1, Utilities.MiraNumberSuffixes.None));
 
-    public ModdedToggleOption ToggleOpt2 { get; } = new("Toggle Option 2", false)
+    public ModdedToggleOption ToggleOpt2 { get; } = new("options.exampleOptions2.toggleOption2", false)
     {
         Visible = () => OptionGroupSingleton<ExampleOptions2>.Instance.ToggleOpt1, // implicit cast from ModdedToggleOption to bool
     };
 
-    public ModdedEnumOption<TestingData> EnumOpt { get; } = new("Enum Opt", 0)
+    public ModdedEnumOption<TestingData> EnumOpt { get; } = new("options.exampleOptions2.enumOpt", 0)
     {
         ChangedEvent = x => Logger<ExamplePlugin>.Info($"changed Enum Opt to {x}"),
     };

MiraAPI.Example/Options/Modifiers/CaptainModifierSettings.cs

@@ -6,14 +6,14 @@ namespace MiraAPI.Example.Options.Modifiers;
 
 public class CaptainModifierSettings : AbstractOptionGroup<CaptainModifier>
 {
-    public override string GroupName => "Captain Settings";
+    public override string GroupName => "options.captainSettings";
 
-    [ModdedNumberOption("Amount", 0, 5)]
+    [ModdedNumberOption("options.captainSettings.amount", 0, 5)]
     public float Amount { get; set; } = 1;
 
-    [ModdedNumberOption("Chance", 0, 100, 10)]
+    [ModdedNumberOption("options.captainSettings.chance", 0, 100, 10)]
     public float Chance { get; set; } = 50;
 
-    [ModdedNumberOption("Uses", 1, 5)]
+    [ModdedNumberOption("options.captainSettings.uses", 1, 5)]
     public float NumUses { get; set; } = 3;
 }

MiraAPI.Example/Options/Modifiers/FreezeModifierSettings.cs

@@ -6,8 +6,8 @@ namespace MiraAPI.Example.Options.Modifiers;
 
 public class FreezeModifierSettings : AbstractOptionGroup<FreezeModifier>
 {
-    public override string GroupName => "Freeze";
+    public override string GroupName => "options.freezeModifierSettings";
 
-    [ModdedToggleOption("Use Color")]
+    [ModdedToggleOption("options.freezeModifierSettings.useColor")]
     public bool UseColor { get; set; } = true;
 }

MiraAPI.Example/Options/Modifiers/GeneralModifierOptions.cs

@@ -5,15 +5,15 @@ namespace MiraAPI.Example.Options.Modifiers;
 
 public class GeneralModifierOptions : AbstractOptionGroup
 {
-    public override string GroupName => "General";
+    public override string GroupName => "options.generalModifier";
 
     public override uint GroupPriority => 0;
 
     public override MenuCategory ParentMenu => MenuCategory.Modifiers;
 
-    [ModdedToggleOption("Some Boolean Option")]
+    [ModdedToggleOption("options.generalModifier.someBooleanOption")]
     public bool SomeBooleanOption { get; set; } = true;
 
-    [ModdedNumberOption("Number Option", 0, 10, 1)]
+    [ModdedNumberOption("options.generalModifier.numberOption", 0, 10, 1)]
     public float NumberOption { get; set; } = 5;
 }

MiraAPI.Example/Options/Roles/FreezerRoleSettings.cs

@@ -13,11 +13,11 @@ public class FreezerRoleSettings : AbstractOptionGroup<FreezerRole>
         TmpSpriteUtils.CreateSpriteAsset(
             MiraAssets.ImpostorFile.LoadAsset(),
             "ApiExample.Role.Impostor.FreezerRole"));
-    public override string GroupName => "Custom Role";
+    public override string GroupName => "ApiExample.Role.Freezer";
 
-    [ModdedNumberOption("Freeze Duration", 1, 15, 1, MiraNumberSuffixes.Seconds)]
+    [ModdedNumberOption("ApiExample.Role.Freezer.Settings.FreezeDuration", 1, 15, 1, MiraNumberSuffixes.Seconds)]
     public float FreezeDuration { get; set; } = 5;
 
-    [ModdedNumberOption("Freeze Uses", 1, 5)]
+    [ModdedNumberOption("ApiExample.Role.Freezer.Settings.FreezeUses", 1, 5)]
     public float FreezeUses { get; set; } = 1;
 }

MiraAPI.Example/Options/Roles/TeleporterOptions.cs

@@ -8,13 +8,13 @@ namespace MiraAPI.Example.Options.Roles;
 
 public class TeleporterOptions : AbstractRoleOptionGroup<TeleporterRole>
 {
-    public override string GroupName => "Teleporter";
+    public override string GroupName => "ApiExample.Role.Teleporter";
 
-    public ModdedNumberOption TeleportCooldown { get; set; } = new("Teleport Cooldown", 10, 5, 60, 2.5f, MiraNumberSuffixes.Seconds);
+    public ModdedNumberOption TeleportCooldown { get; set; } = new("ApiExample.Role.Teleporter.Settings.TeleportCooldown", 10, 5, 60, 2.5f, MiraNumberSuffixes.Seconds);
 
-    [ModdedNumberOption("Teleport Duration", 5, 25, 1, MiraNumberSuffixes.Seconds)]
+    [ModdedNumberOption("ApiExample.Role.Teleporter.Settings.TeleportDuration", 5, 25, 1, MiraNumberSuffixes.Seconds)]
     public float TeleportDuration { get; set; } = 10;
 
-    [ModdedNumberOption("Zoom Distance", 4, 15)]
+    [ModdedNumberOption("ApiExample.Role.Teleporter.Settings.ZoomDistance", 4, 15)]
     public float ZoomDistance { get; set; } = 6;
 }

MiraAPI.Example/Resources/Locale/en_US.xml

@@ -0,0 +1,83 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<resources>
+    <string name="ApiExample.Role.Crewmate.Teleporter">Teleporter</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.IntroBlurb">Zoom out and teleport across the map!</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.MedDescription">Zoom out and teleport across the map!</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.TabDescription">Zoom out and teleport across the map!</string>
+    <string name="ApiExample.Role.Crewmate.Teleporter.WikiDescription">The Teleporter is a Crewmate role that can move around the map using their dope-ass ability.</string>
+    <string name="ApiExample.Role.Impostor.Freezer">Freezer</string>
+    <string name="ApiExample.Role.Impostor.Freezer.IntroBlurb">Get iced, nerd.</string>
+    <string name="ApiExample.Role.Impostor.Freezer.MedDescription">Freeze others for a duration of time.</string>
+    <string name="ApiExample.Role.Impostor.Freezer.TabDescription">Freeze another player for a duration of time.</string>
+    <string name="ApiExample.Role.Impostor.Freezer.WikiDescription">The Freezer is an Impostor role that can freeze players. Or something along those lines.</string>
+    <string name="ApiExample.Role.Crewmate.Mayor">Mayor</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.IntroBlurb">Democracy is the best policy.</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.MedDescription">Vote out the Impostors with more votes.
+Your votes have double the power.</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.TabDescription">You get one extra vote in the meeting!</string>
+    <string name="ApiExample.Role.Crewmate.Mayor.WikiDescription">The Mayor is a Crewmate role that gets two votes in the meeting, instead of the singular vote other Crewmates get.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon">Chamelon</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.IntroBlurb">Become one with the environment.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.MedDescription">Fade out of everyone's vision by not moving.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.TabDescription">Stay invisible while not moving.</string>
+    <string name="ApiExample.Role.Crewmate.Chamelon.WikiDescription">The Chamelon is a Crewmate role that slowly becomes invisible while standing still.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller">Outcast Killer</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.IntroBlurb">Kill everyone else.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.MedDescription">Be the last outcast standing.
+Eliminate every other faction.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.TabDescription">Outcast who can kill.</string>
+    <string name="ApiExample.Role.Outcast.OutcastKiller.WikiDescription">The Outcast Killer is an Outcast role that can kill, like some sort of neutral killer...</string>
+    <string name="outcast">Outcast</string>
+    <string name="outcast.group">Outcast Roles</string>
+    <string name="outcast.roleTitle">OUTCAST</string>
+    <string name="outcast.teamIntroDescription">You are an Outcast. You do not have a team.</string>
+    <string name="button.think">Think</string>
+    <string name="button.think.thinking">Thinking...</string>
+    <string name="button.freeze">Freeze</string>
+    <string name="button.teleport">Teleport</string>
+    <string name="button.callMeeting">Call Meeting</string>
+    <string name="button.winGame">Win Game</string>
+    <string name="modifier.captain">Captain</string>
+    <string name="modifier.captain.TabDescription">You can call a meeting from anywhere on the map.</string>
+    <string name="modifier.freezed">Freezed</string>
+    <string name="modifier.highPriority">High Priority</string>
+    <string name="modifier.highPriority.TabDescription">You are high priority! Idrk what this means either tbh...</string>
+    <string name="options.exampleOptions1">Example Options 1</string>
+    <string name="options.exampleOptions1.toggleOpt1">Toggle Opt 1</string>
+    <string name="options.exampleOptions1.toggleOpt2">Toggle Opt 2</string>
+    <string name="options.exampleOptions1.numberOpt">Number Opt</string>
+    <string name="options.exampleOptions1.bestApi">Best API</string>
+    <string name="options.exampleOptions2">Example Options 2</string>
+    <string name="options.exampleOptions2.youMustChoseAPlayer">YOU MUST CHOSE A PLAYER</string>
+    <string name="options.exampleOptions2.ehWhatever">Eh whatever</string>
+    <string name="options.exampleOptions2.toggleOption1">Toggle Option 1</string>
+    <string name="options.exampleOptions2.toggleOption2">Toggle Option 2</string>
+    <string name="options.exampleOptions2.enumOpt">Enum Opt</string>
+    <string name="options.captainSettings">Captain Settings</string>
+    <string name="options.captainSettings.amount">Amount</string>
+    <string name="options.captainSettings.chance">Chance</string>
+    <string name="options.captainSettings.uses">Uses</string>
+    <string name="options.freezeModifierSettings">Freeze</string>
+    <string name="options.freezeModifierSettings.useColor">Use Color</string>
+    <string name="options.generalModifier">General</string>
+    <string name="options.generalModifier.someBooleanOption">Some Boolean Option</string>
+    <string name="options.generalModifier.numberOption">Number Option</string>
+    <string name="options.freezerRoleSettings">Custom Role</string>
+    <string name="ApiExample.Role.Freezer.Settings.FreezeDuration">Freeze Duration</string>
+    <string name="ApiExample.Role.Freezer.Settings.FreezeUses">Freeze Uses</string>
+    <string name="ApiExample.Role.Teleporter.Settings.TeleportCooldown">Teleport Cooldown</string>
+    <string name="ApiExample.Role.Teleporter.Settings.TeleportDuration">Teleport Duration</string>
+    <string name="ApiExample.Role.Teleporter.Settings.ZoomDistance">Zoom Distance</string>
+    <string name="settings.miraExample">Mira Example</string>
+    <string name="settings.miraExample.exampleBool">Example Bool</string>
+    <string name="settings.miraExample.exampleBool2">Example Bool 2</string>
+    <string name="settings.miraExample.slider">Slider</string>
+    <string name="settings.miraExample.exampleNumber">Example Number</string>
+    <string name="settings.miraExample.exampleMultiplier">Example Multplier</string>
+    <string name="settings.miraExample.exampleEnum">Example Enum</string>
+    <string name="settings.miraExample.button.exampleButton">Example Button</string>
+    <string name="gameover.outcastKiller.win">Outcast Killer Wins!</string>
+    <string name="color.cerulean">Cerulean</string>
+    <string name="color.rose">Rose</string>
+    <string name="color.gold">Gold</string>
+</resources>

MiraAPI.Example/Resources/Locale/zh_CN.xml

@@ -0,0 +1,66 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<resources>
+  <string name="ApiExample.Role.Teleporter">传送者</string>
+  <string name="ApiExample.Role.Teleporter.IntroBlurb">缩小视野并在地图上传送！</string>
+    <string name="ApiExample.Role.Teleporter.MedDescription">缩小视野并在地图上传送！</string>
+    <string name="ApiExample.Role.Teleporter.TabDescription">缩小视野并在地图上传送！</string>
+  <string name="ApiExample.Role.Freezer">冰冻者</string>
+  <string name="ApiExample.Role.Freezer.TabDescription">将其他玩家冰冻一段时间。</string>
+  <string name="ApiExample.Role.Crewmate.Mayor">市长</string>
+  <string name="ApiExample.Role.Crewmate.Mayor.TabDescription">你拥有额外投票权！</string>
+  <string name="ApiExample.Role.Crewmate.Chamelon">变色龙</string>
+  <string name="ApiExample.Role.Crewmate.Chamelon.TabDescription">静止不动时保持隐身。</string>
+  <string name="ApiExample.Role.Outcast.OutcastKiller">流放杀手</string>
+  <string name="ApiExample.Role.Outcast.OutcastKiller.TabDescription">可以击杀的流放者。</string>
+  <string name="outcast">流放者</string>
+  <string name="outcast.roleTitle">流放者</string>
+  <string name="outcast.teamIntroDescription">你是流放者，你没有队伍。</string>
+  <string name="button.think">思考</string>
+  <string name="button.think.thinking">思考中...</string>
+  <string name="button.freeze">冰冻</string>
+  <string name="button.teleport">传送</string>
+  <string name="button.callMeeting">召集会议</string>
+  <string name="button.winGame">赢得游戏</string>
+  <string name="modifier.captain">队长</string>
+  <string name="modifier.captain.TabDescription">你可以在地图上任意位置召集会议。</string>
+  <string name="modifier.freezed">已被冰冻</string>
+  <string name="modifier.highPriority">高优先级</string>
+  <string name="modifier.highPriority.TabDescription">你是高优先级！老实说我也不太清楚这是什么意思……</string>
+  <string name="options.exampleOptions1">示例选项组 1</string>
+  <string name="options.exampleOptions1.toggleOpt1">开关选项 1</string>
+  <string name="options.exampleOptions1.toggleOpt2">开关选项 2</string>
+  <string name="options.exampleOptions1.numberOpt">数字选项</string>
+  <string name="options.exampleOptions1.bestApi">谁是最好的API</string>
+  <string name="options.exampleOptions2">示例选项组 2</string>
+  <string name="options.exampleOptions2.youMustChoseAPlayer">你必须选择一个玩家</string>
+  <string name="options.exampleOptions2.ehWhatever">咕咕嘎嘎</string>
+  <string name="options.exampleOptions2.toggleOption1">开关选项 1</string>
+  <string name="options.exampleOptions2.toggleOption2">开关选项 2</string>
+  <string name="options.exampleOptions2.enumOpt">枚举选项</string>
+  <string name="options.captainSettings">队长设置</string>
+  <string name="options.captainSettings.amount">数量</string>
+  <string name="options.captainSettings.chance">概率</string>
+  <string name="options.captainSettings.uses">使用次数</string>
+  <string name="options.freezeModifierSettings">冰冻</string>
+  <string name="options.freezeModifierSettings.useColor">使用颜色</string>
+  <string name="options.generalModifier">通用</string>
+  <string name="options.generalModifier.someBooleanOption">某个布尔选项</string>
+  <string name="options.generalModifier.numberOption">数字选项</string>
+  <string name="ApiExample.Role.Freezer.Settings.FreezeDuration">冰冻时长</string>
+  <string name="ApiExample.Role.Freezer.Settings.FreezeUses">冰冻次数</string>
+  <string name="ApiExample.Role.Teleporter.Settings.TeleportCooldown">传送冷却</string>
+  <string name="ApiExample.Role.Teleporter.Settings.TeleportDuration">传送持续时间</string>
+  <string name="ApiExample.Role.Teleporter.Settings.ZoomDistance">缩放距离</string>
+  <string name="settings.miraExample">Mira 示例插件</string>
+  <string name="settings.miraExample.exampleBool">示例布尔</string>
+  <string name="settings.miraExample.exampleBool2">示例布尔 2</string>
+  <string name="settings.miraExample.slider">滑块</string>
+  <string name="settings.miraExample.exampleNumber">示例数字</string>
+  <string name="settings.miraExample.exampleMultiplier">示例倍数</string>
+  <string name="settings.miraExample.exampleEnum">示例枚举</string>
+  <string name="settings.miraExample.button.exampleButton">示例按钮</string>
+  <string name="gameover.outcastKiller.win">流放杀手获胜！</string>
+  <string name="color.cerulean">天蓝</string>
+  <string name="color.rose">玫瑰红</string>
+  <string name="color.gold">金色</string>
+</resources>

MiraAPI.Example/Roles/ChameleonRole.cs

@@ -10,9 +10,8 @@ namespace MiraAPI.Example.Roles;
 
 public class ChameloenRole : CrewmateRole, ICustomRole
 {
-    public string RoleName => "Chamelon";
-    public string RoleLongDescription => "Stay invisible while not moving.";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Chamelon";
+    public string IdPrefix => "ApiExample.Role.Crewmate";
     public Color RoleColor => Palette.AcceptedGreen;
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
 
@@ -22,7 +21,9 @@ public class ChameloenRole : CrewmateRole, ICustomRole
     {
         OptionsScreenshot = ExampleAssets.Banner,
         Icon = MiraAssets.CrewmateFile,
-        IconTmp = TmpSpriteUtils.CreateSpriteAsset(MiraAssets.CrewmateFile.LoadAsset(), "ApiExample.Role.Impostor.ChameleonRole"),
+        IconTmp = TmpSpriteUtils.CreateSpriteAsset(
+            MiraAssets.CrewmateFile.LoadAsset(),
+            "ApiExample.Role.Impostor.ChameleonRole"),
         IntroSound = CustomRoleUtils.GetIntroSound(RoleTypes.Shapeshifter),
     };
 
@@ -56,12 +57,18 @@ public class ChameloenRole : CrewmateRole, ICustomRole
         {
             SpriteRenderer rend = Player.cosmetics.currentBodySprite.BodySprite;
             TextMeshPro tmp = Player.cosmetics.nameText;
-            tmp.color = Color.Lerp(tmp.color, new Color(tmp.color.r, tmp.color.g, tmp.color.b, Player.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
+            tmp.color = Color.Lerp(
+                tmp.color,
+                new Color(tmp.color.r, tmp.color.g, tmp.color.b, Player.AmOwner ? 0.3f : 0),
+                Time.deltaTime * 4f);
             rend.color = Color.Lerp(rend.color, new Color(1, 1, 1, Player.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
 
             foreach (var cosmetic in Player.cosmetics.transform.GetComponentsInChildren<SpriteRenderer>())
             {
-                cosmetic.color = Color.Lerp(cosmetic.color, new Color(1, 1, 1, Player.AmOwner ? 0.3f : 0), Time.deltaTime * 4f);
+                cosmetic.color = Color.Lerp(
+                    cosmetic.color,
+                    new Color(1, 1, 1, Player.AmOwner ? 0.3f : 0),
+                    Time.deltaTime * 4f);
             }
         }
     }
@@ -75,6 +82,7 @@ public class ChameloenRole : CrewmateRole, ICustomRole
         {
             cosmetic.color = Color.white;
         }
+
         Player.cosmetics.currentBodySprite.BodySprite.color = Color.white;
         Player.cosmetics.nameText.color = Color.white;
     }

MiraAPI.Example/Roles/FreezerRole.cs

@@ -6,16 +6,15 @@ namespace MiraAPI.Example.Roles;
 
 public class FreezerRole : ImpostorRole, ICustomRole
 {
-    public string RoleName => "Freezer";
-    public string RoleLongDescription => "Freeze another player for a duration of time.";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Freezer";
+    public string IdPrefix => "ApiExample.Role.Impostor";
     public Color RoleColor => Palette.Blue;
     public ModdedRoleTeams Team => ModdedRoleTeams.Impostor;
 
     public CustomRoleConfiguration Configuration => new CustomRoleConfiguration(this)
     {
         Icon = MiraAssets.ImpostorFile,
-        IconTmp = TmpSpriteUtils.CreateSpriteAsset(MiraAssets.ImpostorFile.LoadAsset(), "ApiExample.Role.Impostor.FreezerRole"),
+        IconTmp = TmpSpriteUtils.CreateSpriteAsset(MiraAssets.ImpostorFile.LoadAsset(), "ApiExample.Role.Impostor.Freezer"),
         OptionsScreenshot = ExampleAssets.Banner,
         MaxRoleCount = 2,
     };

MiraAPI.Example/Roles/MayorRole.cs

@@ -5,9 +5,8 @@ namespace MiraAPI.Example.Roles;
 
 public class MayorRole : CrewmateRole, ICustomRole
 {
-    public string RoleName => "Mayor";
-    public string RoleLongDescription => "You get extra votes!";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Mayor";
+    public string IdPrefix => "ApiExample.Role.Crewmate";
     public Color RoleColor => new Color32(221, 176, 152, 255);
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;
     public CustomRoleConfiguration Configuration => new(this);

MiraAPI.Example/Roles/NeutralKillerRole.cs

@@ -8,9 +8,8 @@ namespace MiraAPI.Example.Roles;
 
 public class NeutralKillerRole : ImpostorRole, ICustomRole
 {
-    public string RoleName => "Outcast Killer";
-    public string RoleDescription => "Outcast who can kill.";
-    public string RoleLongDescription => RoleDescription;
+    public string IdPart => "OutcastKiller";
+    public string IdPrefix => "ApiExample.Role.Outcast";
     public Color RoleColor => Color.magenta;
     public ModdedRoleTeams Team => ModdedRoleTeams.Custom;
 
@@ -21,13 +20,13 @@ public class NeutralKillerRole : ImpostorRole, ICustomRole
         CanUseVent = true,
     };
 
-    public RoleOptionsGroup RoleOptionsGroup { get; } = new("Outcast", Color.gray);
+    public RoleOptionsGroup RoleOptionsGroup { get; } = new("outcast.group", Color.gray);
 
     [HideFromIl2Cpp]
     public TeamIntroConfiguration? IntroConfiguration { get; } = new(
         Color.gray,
-        "OUTCAST",
-        "You are an Outcast. You do not have a team.");
+        "outcast.roleTitle",
+        "outcast.teamIntroDescription");
 
     public override void SpawnTaskHeader(PlayerControl playerControl)
     {

MiraAPI.Example/Roles/TeleporterRole.cs

@@ -5,9 +5,8 @@ namespace MiraAPI.Example.Roles;
 
 public class TeleporterRole : CrewmateRole, ICustomRole
 {
-    public string RoleName => "Teleporter";
-    public string RoleLongDescription => "Zoom out and teleport across the map!";
-    public string RoleDescription => RoleLongDescription;
+    public string IdPart => "Teleporter";
+    public string IdPrefix => "ApiExample.Role.Crewmate";
     public Color RoleColor => new Color32(221, 176, 152, 255);
     public ModdedRoleTeams Team => ModdedRoleTeams.Crewmate;