modifiers README

MiraAPI.Example/Modifiers/GameModifierExample.cs

@@ -0,0 +1,25 @@
+using MiraAPI.Modifiers;
+using MiraAPI.Modifiers.Types;
+
+namespace MiraAPI.Example.Modifiers;
+
+[RegisterModifier]
+public class GameModifierExample : GameModifier
+{
+    public override string ModifierName => "Example Game Modifier";
+
+    public override bool CanVent()
+    {
+        return true;
+    }
+
+    public override int GetAmountPerGame()
+    {
+        return 1;
+    }
+
+    public override int GetAssignmentChance()
+    {
+        return 100;
+    }
+}

MiraAPI.Example/Modifiers/ModifierTimerExample.cs

@@ -0,0 +1,21 @@
+using MiraAPI.Modifiers;
+using MiraAPI.Modifiers.Types;
+
+namespace MiraAPI.Example.Modifiers;
+
+[RegisterModifier]
+public class ModifierTimerExample : TimedModifier
+{
+    public override string ModifierName => "Color Changer";
+    public override bool HideOnUi => true;
+    public override float Duration => 10f;
+    public override bool AutoStart => true;
+
+    private System.Random _rand = new();
+
+    public override void OnTimerComplete()
+    {
+        Player.SetColor((byte)_rand.Next(0, Palette.PlayerColors.Count));
+        StartTimer();
+    }
+}