feat(bot): clean up / paginate help command

Myriad/Types/Component/MessageComponent.cs

@@ -3,7 +3,7 @@ namespace Myriad.Types;
 public record MessageComponent
 {
     public ComponentType Type { get; init; }
-    public ButtonStyle? Style { get; init; }
+    public ButtonStyle? Style { get; set; }
     public string? Label { get; init; }
     public Emoji? Emoji { get; init; }
     public string? CustomId { get; init; }

Myriad/Types/Message.cs

@@ -52,6 +52,7 @@ public record Message
     // public bool MentionEveryone { get; init; }
     public User.Extra[] Mentions { get; init; }
     // public ulong[] MentionRoles { get; init; }
+    public MessageComponent[]? Components { get; init; }
 
     public Attachment[] Attachments { get; init; }
     public Embed[]? Embeds { get; init; }

PluralKit.Bot/Commands/Help.cs

@@ -1,5 +1,5 @@
-using Myriad.Builders;
 using Myriad.Types;
+using Myriad.Rest.Types.Requests;
 
 using PluralKit.Core;
 
@@ -10,64 +10,158 @@ public class Help
     private static Embed helpEmbed = new()
     {
         Title = "PluralKit",
-        Description = "PluralKit is a bot designed for plural communities on Discord. It allows you to register systems, maintain system information, set up message proxying, log switches, and more.",
+        Description = "PluralKit is a bot designed for plural communities on Discord, and is open for anyone to use. It allows you to register systems, maintain system information, set up message proxying, log switches, and more.",
-        Fields = new[]
-        {
-            new Embed.Field
-            (
-                "What is this for? What are systems?",
-                "This bot detects messages with certain tags associated with a profile, then replaces that message under a \"pseudo-account\" of that profile using webhooks."
-                + " This is useful for multiple people sharing one body (aka \"systems\"), people who wish to roleplay as different characters without having several accounts, or anyone else who may want to post messages as a different person from the same account."
-            ),
-            new
-            (
-                "Why are people's names saying [BOT] next to them?",
-                "These people are not actually bots, this is just a Discord limitation. See [the documentation](https://pluralkit.me/guide#proxying) for an in-depth explanation."
-            ),
-            new
-            (
-                "How do I get started?",
-                String.Join("\n", new[]
-                {
-                    "To get started using PluralKit, try running the following commands (of course replacing the relevant names with your own):",
-                    "**1**. `pk;system new` - Create a system (if you haven't already)",
-                    "**2**. `pk;member add John` - Add a new member to your system",
-                    "**3**. `pk;member John proxy [text]` - Set up [square brackets] as proxy tags",
-                    "**4**. You're done! You can now type [a message in brackets] and it'll be proxied appropriately.",
-                    "**5**. Optionally, you may set an avatar from the URL of an image with `pk;member John avatar [link to image]`, or from a file by typing `pk;member John avatar` and sending the message with an attached image.",
-                    "\nSee [the Getting Started guide](https://pluralkit.me/start) for more information."
-                })
-            ),
-            new
-            (
-                "Useful tips",
-                String.Join("\n", new[] {
-                    $"React with {Emojis.Error} on a proxied message to delete it (only if you sent it!)",
-                    $"React with {Emojis.RedQuestion} on a proxied message to look up information about it (like who sent it)",
-                    $"React with {Emojis.Bell} on a proxied message to \"ping\" the sender",
-                    "Type **`pk;invite`** to get a link to invite this bot to your own server!"
-                })
-            ),
-            new
-            (
-                "More information",
-                String.Join("\n", new[] {
-                    "For a full list of commands, see [the command list](https://pluralkit.me/commands).",
-                    "For a more in-depth explanation of message proxying, see [the documentation](https://pluralkit.me/guide#proxying).",
-                    "If you're an existing user of Tupperbox, type `pk;import` and attach a Tupperbox export file (from `tul!export`) to import your data from there."
-                })
-            ),
-            new
-            (
-                "Support server",
-                "We also have a Discord server for support, discussion, suggestions, announcements, etc: https://discord.gg/PczBt78"
-            )
-        },
         Footer = new("By @Ske#6201 | Myriad by @Layl#8888 | GitHub: https://github.com/PluralKit/PluralKit/ | Website: https://pluralkit.me/"),
         Color = DiscordUtils.Blue,
     };
 
-    public Task HelpRoot(Context ctx) => ctx.Reply(embed: helpEmbed);
+    private static Dictionary<string, Embed.Field[]> helpEmbedPages = new Dictionary<string, Embed.Field[]>
+    {
+        {
+            "basicinfo",
+            new Embed.Field[]
+            {
+                new
+                (
+                    "What is this for? What are systems?",
+                    "This bot detects messages with certain tags associated with a profile, then replaces that message under a \"pseudo-account\" of that profile using webhooks."
+                    + " This is useful for multiple people sharing one body (aka \"systems\"), people who wish to roleplay as different characters without having several accounts, or anyone else who may want to post messages as a different person from the same account."
+                ),
+                new
+                (
+                    "Why are people's names saying [BOT] next to them?",
+                    "These people are not actually bots, this is just a Discord limitation. See [the documentation](https://pluralkit.me/guide#proxying) for an in-depth explanation."
+                ),
+            }
+        },
+        {
+            "gettingstarted",
+            new Embed.Field[]
+            {
+                new
+                (
+                    "How do I get started?",
+                    String.Join("\n", new[]
+                    {
+                        "To get started using PluralKit, try running the following commands (of course replacing the relevant names with your own):",
+                        "**1**. `pk;system new` - Create a system (if you haven't already)",
+                        "**2**. `pk;member add John` - Add a new member to your system",
+                        "**3**. `pk;member John proxy [text]` - Set up [square brackets] as proxy tags",
+                        "**4**. You're done! You can now type [a message in brackets] and it'll be proxied appropriately.",
+                        "**5**. Optionally, you may set an avatar from the URL of an image with `pk;member John avatar [link to image]`, or from a file by typing `pk;member John avatar` and sending the message with an attached image.",
+                        "\nSee [the Getting Started guide](https://pluralkit.me/start) for more information."
+                    })
+                ),
+            }
+        },
+        {
+            "usefultips",
+            new Embed.Field[]
+            {
+                new
+                (
+                    "Useful tips",
+                    String.Join("\n", new[] {
+                        $"React with {Emojis.Error} on a proxied message to delete it (only if you sent it!)",
+                        $"React with {Emojis.RedQuestion} on a proxied message to look up information about it (like who sent it)",
+                        $"React with {Emojis.Bell} on a proxied message to \"ping\" the sender",
+                        "Type **`pk;invite`** to get a link to invite this bot to your own server!"
+                    })
+                ),
+            }
+        },
+        {
+            "moreinfo",
+            new Embed.Field[]
+            {
+                new
+                (
+                    "More information",
+                    String.Join("\n", new[] {
+                        "For a full list of commands, see [the command list](https://pluralkit.me/commands).",
+                        "For a more in-depth explanation of message proxying, see [the documentation](https://pluralkit.me/guide#proxying).",
+                        "If you're an existing user of Tupperbox, type `pk;import` and attach a Tupperbox export file (from `tul!export`) to import your data from there."
+                    })
+                ),
+                new
+                (
+                    "Support server",
+                    "We also have a Discord server for support, discussion, suggestions, announcements, etc: https://discord.gg/PczBt78"
+                ),
+            }
+        }
+    };
+
+    private static MessageComponent helpPageButtons(ulong userId) => new MessageComponent
+    {
+        Type = ComponentType.ActionRow,
+        Components = new[]
+        {
+            new MessageComponent
+            {
+                Type = ComponentType.Button,
+                Style = ButtonStyle.Secondary,
+                Label = "Basic Info",
+                CustomId = $"help-menu-basicinfo-{userId}",
+                Emoji = new() { Name = "\u2139" },
+            },
+            new()
+            {
+                Type = ComponentType.Button,
+                Style = ButtonStyle.Secondary,
+                Label = "Getting Started",
+                CustomId = $"help-menu-gettingstarted-{userId}",
+                Emoji = new() { Name = "\u2753", },
+            },
+            new()
+            {
+                Type = ComponentType.Button,
+                Style = ButtonStyle.Secondary,
+                Label = "Useful Tips",
+                CustomId = $"help-menu-usefultips-{userId}",
+                Emoji = new() { Name = "\U0001f4a1", },
+
+            },
+            new()
+            {
+                Type = ComponentType.Button,
+                Style = ButtonStyle.Secondary,
+                Label = "More Info",
+                CustomId = $"help-menu-moreinfo-{userId}",
+                Emoji = new() { Id = 986379675066593330, },
+            }
+        }
+    };
+
+    public Task HelpRoot(Context ctx)
+        => ctx.Rest.CreateMessage(ctx.Channel.Id, new MessageRequest
+        {
+            Embeds = new[] { helpEmbed with { Description = helpEmbed.Description + "\n\n**Use the buttons below to see more info!**" } },
+            Components = new[] { helpPageButtons(ctx.Author.Id) },
+        });
+
+    public static Task ButtonClick(InteractionContext ctx)
+    {
+        if (!ctx.CustomId.Contains(ctx.User.Id.ToString()))
+            return ctx.Ignore();
+
+        var buttons = helpPageButtons(ctx.User.Id);
+
+        if (ctx.Event.Message.Components.First().Components.Where(x => x.CustomId == ctx.CustomId).First().Style == ButtonStyle.Primary)
+            return ctx.Respond(InteractionResponse.ResponseType.UpdateMessage, new()
+            {
+                Embeds = new[] { helpEmbed with { Description = helpEmbed.Description + "\n\n**Use the buttons below to see more info!**" } },
+                Components = new[] { buttons }
+            });
+
+        buttons.Components.Where(x => x.CustomId == ctx.CustomId).First().Style = ButtonStyle.Primary;
+
+        return ctx.Respond(InteractionResponse.ResponseType.UpdateMessage, new()
+        {
+            Embeds = new[] { helpEmbed with { Fields = helpEmbedPages.GetValueOrDefault(ctx.CustomId.Split("-")[2]) } },
+            Components = new[] { buttons }
+        });
+    }
 
     private static string explanation = String.Join("\n\n", new[]
     {

PluralKit.Bot/Handlers/InteractionCreated.cs

@@ -21,11 +21,14 @@ public class InteractionCreated: IEventHandler<InteractionCreateEvent>
         if (evt.Type == Interaction.InteractionType.MessageComponent)
         {
             var customId = evt.Data?.CustomId;
-            if (customId != null)
+            if (customId == null) return;
-            {
+
-                var ctx = new InteractionContext(evt, _services);
+            var ctx = new InteractionContext(evt, _services);
+
+            if (customId.Contains("help-menu"))
+                await Help.ButtonClick(ctx);
+            else
                 await _interactionDispatch.Dispatch(customId, ctx);
-            }
         }
     }
 }

PluralKit.Bot/Utils/InteractionContext.cs

@@ -36,7 +36,7 @@ public class InteractionContext
         await Respond(InteractionResponse.ResponseType.DeferredUpdateMessage,
             new InteractionApplicationCommandCallbackData
             {
-                // Components = _evt.Message.Components
+                Components = Event.Message.Components
             });
     }