Added documentation commands

Eco-DiscordLink · Jan 20, 2024 · 7d90435 · 7d90435
1 parent bb8d841
commit 7d90435
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/Commands.md b/Commands.md
@@ -43,6 +43,7 @@ All Eco and Discord commands are case insensitive.
 |----------------------------|---------------------|-------------------|-------------------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------|
 | Version                    |                     | Both              |                                                                         | User            | Displays the installed and latest available plugin version.                                                          |
 | About                      |                     | Both              |                                                                         | User            | Displays information about the DiscordLink plugin.                                                                   |
+| Documentation              |                     | Both              |                                                                         | User            | Opens the documentation web page.                                                                                    |
 | LinkInformation            |                     | Both              |                                                                         | User            | Presents information about account linking.                                                                          |
 | PluginStatus               |                     | Both              | Verbose (true/false)                                                    | Admin           | Displays the plugin status. Displays more information if the verbose parameter is set to true.                       |
 | ListLinkedChannels         |                     | Both              |                                                                         | Admin           | Presents a list of all channel links.                                                                                |

diff --git a/DiscordLink/Source/Commands/DiscordCommands.cs b/DiscordLink/Source/Commands/DiscordCommands.cs
@@ -16,6 +16,8 @@
 using static Eco.Plugins.DiscordLink.Enums;
 using static Eco.Plugins.DiscordLink.SharedCommands;
 using static Eco.Plugins.DiscordLink.Utilities.MessageBuilder;
+using Eco.Gameplay.Players;
+using Eco.Gameplay.Systems.Messaging.Chat.Commands;
 
 namespace Eco.Plugins.DiscordLink
 {
@@ -287,6 +289,15 @@ public async Task About(InteractionContext ctx)
             }, ctx);
         }
 
+        [SlashCommand("Documentation", "Opens the documentation web page.")]
+        public async Task Documentation(InteractionContext ctx)
+        {
+            await ExecuteCommand<object>(PermissionType.User, async (lCtx, args) =>
+            {
+                await RespondToCommand(ctx, "The documentation can be found here: <https://github.com/Eco-DiscordLink/EcoDiscordPlugin>");
+            }, ctx);
+        }
+
         [SlashCommand("PluginStatus", "Displays the current plugin status.")]
         public async Task PluginStatus(InteractionContext ctx, [Option("Verbose", "Use verbose output with extra information.")] bool verbose = false)
         {

diff --git a/DiscordLink/Source/Commands/EcoCommands.cs b/DiscordLink/Source/Commands/EcoCommands.cs
@@ -158,6 +158,15 @@ public static async Task About(User callingUser)
             }, callingUser);
         }
 
+        [ChatSubCommand("DiscordLink", "Open the documentation web page", ChatAuthorizationLevel.User)]
+        public static async Task Documentation(User callingUser)
+        {
+            await ExecuteCommand<object>(async (lUser, args) =>
+            {
+                callingUser.OpenWebpage("https://github.com/Eco-DiscordLink/EcoDiscordPlugin");
+            }, callingUser);
+        }
+
         [ChatSubCommand("DiscordLink", "Shows the plugin status.", ChatAuthorizationLevel.Admin)]
         public static async Task PluginStatus(User callingUser, bool verbose = false)
         {