refactor: make Help.cs content static
This commit is contained in:
spiral
parent
df6a6fcf12
commit
22faa47d00
@ -7,33 +7,74 @@ namespace PluralKit.Bot;
|
||||
|
||||
public class Help
|
||||
{
|
||||
public async Task HelpRoot(Context ctx)
|
||||
private static Embed helpEmbed = new()
|
||||
{
|
||||
await ctx.Reply(embed: new EmbedBuilder()
|
||||
.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.")
|
||||
.Field(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."))
|
||||
.Field(new Embed.Field("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."))
|
||||
.Field(new Embed.Field("How do I get started?",
|
||||
"To get started using PluralKit, try running the following commands (of course replacing the relevant names with your own):\n**1**. `pk;system new` - Create a system (if you haven't already)\n**2**. `pk;member add John` - Add a new member to your system\n**3**. `pk;member John proxy [text]` - Set up [square brackets] as proxy tags\n**4**. You're done! You can now type [a message in brackets] and it'll be proxied appropriately.\n**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.\n\nSee [the Getting Started guide](https://pluralkit.me/start) for more information."))
|
||||
.Field(new Embed.Field("Useful tips",
|
||||
$"React with {Emojis.Error} on a proxied message to delete it (only if you sent it!)\nReact with {Emojis.RedQuestion} on a proxied message to look up information about it (like who sent it)\nReact with {Emojis.Bell} on a proxied message to \"ping\" the sender\nType **`pk;invite`** to get a link to invite this bot to your own server!"))
|
||||
.Field(new Embed.Field("More information",
|
||||
"For a full list of commands, see [the command list](https://pluralkit.me/commands).\nFor a more in-depth explanation of message proxying, see [the documentation](https://pluralkit.me/guide#proxying).\nIf 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."))
|
||||
.Field(new Embed.Field("Support server",
|
||||
"We also have a Discord server for support, discussion, suggestions, announcements, etc: https://discord.gg/PczBt78"))
|
||||
.Footer(new Embed.EmbedFooter(
|
||||
"By @Ske#6201 | Myriad by @Layl#8888 | GitHub: https://github.com/xSke/PluralKit/ | Website: https://pluralkit.me/"))
|
||||
.Color(DiscordUtils.Blue)
|
||||
.Build());
|
||||
}
|
||||
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.",
|
||||
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/xSke/PluralKit/ | Website: https://pluralkit.me/"),
|
||||
Color = DiscordUtils.Blue,
|
||||
};
|
||||
|
||||
public async Task Explain(Context ctx)
|
||||
public Task HelpRoot(Context ctx) => ctx.Reply(embed: helpEmbed);
|
||||
|
||||
private static string explanation = String.Join("\n\n", new[]
|
||||
{
|
||||
await ctx.Reply(
|
||||
"> **About PluralKit**\nPluralKit detects messages enclosed in specific tags associated with a profile, then replaces that message under a \"pseudo-account\" of that profile using Discord webhooks.\n\nThis is useful for multiple people sharing one body (aka. *systems*), people who wish to role-play as different characters without having multiple Discord accounts, or anyone else who may want to post messages under a different identity from the same Discord account.\n\nDue to Discord limitations, these messages will show up with the `[BOT]` tag - however, they are not bots.");
|
||||
}
|
||||
"> **About PluralKit**\nPluralKit detects messages enclosed in specific tags associated with a profile, then replaces that message under a \"pseudo-account\" of that profile using Discord webhooks.",
|
||||
"This is useful for multiple people sharing one body (aka. *systems*), people who wish to role-play as different characters without having multiple Discord accounts, or anyone else who may want to post messages under a different identity from the same Discord account.",
|
||||
"Due to Discord limitations, these messages will show up with the `[BOT]` tag - however, they are not bots."
|
||||
});
|
||||
|
||||
public Task Explain(Context ctx) => ctx.Reply(explanation);
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user