Update help command

1 files changed, 160 insertions, 63 deletions

diff --git a/code/cogs/help.py b/code/cogs/help.py
index 523d1b7..e56c030 100644
--- a/code/cogs/help.py
+++ b/code/cogs/help.py
@@ -1,88 +1,185 @@
 import discord
 from discord.ext import commands
-import re
 from discord import app_commands
 
 from global_variables import BOT_COLOR, BOT_INVITE_LINK
 
+commands_and_descriptions = {
+    "play": {
+        "description": "Plays the requested song",
+        "arguments": {"query": "Name or link of the song you want to play"},
+        "usage": "/play <query>",
+    },
+    "skip": {
+        "description": "Skips the song that is currently playing",
+        "optional_arguments": {
+            "number": "The number of songs to skip - leave blank to skip just the current song"
+        },
+        "usage": "/skip (number)",
+    },
+    "queue": {
+        "description": "Sends the songs currently added to the queue",
+        "optional_arguments": {
+            "page": "Page number of the queue to view - leave blank to see only the first page"
+        },
+        "usage": "/queue (page)",
+    },
+    "stop": {
+        "description": "Stops all music, clears the queue, and leave the voice channel",
+        "usage": "/stop",
+    },
+    "np": {"description": "Sends the song that is currently playing", "usage": "/np"},
+    "clear": {"description": "Removes all songs from the queue", "usage": "/clear"},
+    "remove": {
+        "description": "Removes the specified song from the queue",
+        "arguments": {
+            "number": "The queue number of the song that should be removed from the queue"
+        },
+        "usage": "/remove <number>",
+    },
+    "repeat": {
+        "description": "Changes the looping state of the bot",
+        "arguments": {
+            "song": "Repeats the song that is currently playing until changed",
+            "queue": "Continuously repeat the songs in the queue until turned off",
+            "off": "Stop all song or queue repetition",
+        },
+        "usage": "/repeat <song/queue/off>",
+    },
+    "shuffle": {
+        "description": "Turn song shuffling on or off",
+        "arguments": {
+            "on": "Turns randomized song shuffling on",
+            "off": "Turns shuffling off",
+        },
+        "usage": "/shuffle <on/off>",
+    },
+    "bug": {
+        "description": "Fill out a bug report form to alert the developer of issues",
+        "usage": "/bug",
+    },
+    "feedback": {
+        "description": "Fill out a form to give the developer feedback on the bot",
+        "usage": "/feedback",
+    },
+}
 
-class InviteButton(discord.ui.View):
+
+class HelpView(discord.ui.View):
     def __init__(self, timeout=180.0):
         super().__init__(timeout=timeout)
-        self.value = None
         self.add_item(discord.ui.Button(label="Invite Me", url=BOT_INVITE_LINK, row=1))
 
+    @discord.ui.button(
+        label="View All Commands", style=discord.ButtonStyle.green, row=1
+    )
+    async def view_all_commands(
+        self, interaction: discord.Interaction, button: discord.ui.Button
+    ):
+        embed = discord.Embed(
+            title=":musical_note:  All Guava Commands  :musical_note:", color=BOT_COLOR
+        )
+
+        embed.add_field(
+            name="All Commands",
+            value=", ".join(
+                [f"`{command}`" for command in commands_and_descriptions.keys()]
+            ),
+        )
+
+        await interaction.response.edit_message(embed=embed, view=None)
+
 
 class Help(commands.Cog):
     def __init__(self, bot):
         self.bot = bot
 
     @app_commands.command()
-    async def help(self, interaction: discord.Interaction):
+    async def help(self, interaction: discord.Interaction, command: str = None):
         "Sends the bots commands"
 
-        embed = discord.Embed(
-            title=f":musical_note: Guava Help :musical_note:", color=BOT_COLOR
-        )
-        embed.add_field(
-            name="`/play <name/URL>`", value="Plays the requested song", inline=False
-        )
-        embed.add_field(
-            name="`/skip`",
-            value="Skips the song that is currently playing",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/queue (page #)`",
-            value="Sends the songs currently in queue",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/stop`",
-            value="Stops music, clears queue, and leaves VC",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/np`", value="Sends the song that is currently playing", inline=False
-        )
-        embed.add_field(
-            name="`/clear`", value="Completely clears the queue", inline=False
-        )
-        embed.add_field(
-            name="`/remove <song #>`",
-            value="Removes the specified song from the queue",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/repeat <song/queue/off>`",
-            value="Forever repeats the current song, queue, or turns repetition off",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/shuffle <on/off>`",
-            value="Turns song shuffling on or off",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/pause`", value="Pauses the currently playing song", inline=False
-        )
-        embed.add_field(name="`/resume`", value="Resumes the paused song", inline=False)
+        if command == None:
+            embed = discord.Embed(
+                title=f":musical_note:  Guava Help  :musical_note:", color=BOT_COLOR
+            )
 
-        embed.add_field(
-            name="`/bug`",
-            value="Fill out a bug report to let the developer know of any issues",
-            inline=False,
-        )
-        embed.add_field(
-            name="`/feedback`",
-            value="Give the developer feedback about Guava",
-            inline=False,
-        )
+            embed.add_field(
+                name="**Use Guava**",
+                value="> To get started, use the </play:1224840890368000172> command and enter the name or link to the song of your choice.",
+                inline=False,
+            )
+            embed.add_field(
+                name="**Full Command List**",
+                value='> To view of a list of all available commands, click the "View All Commands" button below.',
+                inline=False,
+            )
+            embed.add_field(
+                name="**Help for Specific Commands**",
+                value="> If you want more information on how to use a specific command, use the </help:1224854217597124610> command and include the specific command.",
+                inline=False,
+            )
+
+            embed.set_thumbnail(url=self.bot.user.avatar.url)
+
+            view = HelpView()
+            await interaction.response.send_message(
+                embed=embed, view=view, ephemeral=True
+            )
+
+        elif command in commands_and_descriptions.keys():
+            command = command.lower().strip()
+            embed = discord.Embed(
+                title=f"**{command}**",
+                description=f"{commands_and_descriptions[command]['description']}",
+                color=BOT_COLOR,
+            )
+
+            try:
+                if commands_and_descriptions[command]["arguments"]:
+                    arguments_value = ""
+                    for argument, explanation in commands_and_descriptions[command][
+                        "arguments"
+                    ].items():
+                        arguments_value += f"{argument}\n> {explanation}\n\n"
+
+                    embed.add_field(
+                        name="Arguments", value=arguments_value, inline=False
+                    )
+            except KeyError:
+                pass
+
+            try:
+                if commands_and_descriptions[command]["optional_arguments"]:
+                    arguments_value = ""
+                    for argument, explanation in commands_and_descriptions[command][
+                        "optional_arguments"
+                    ].items():
+                        arguments_value += f"{argument}\n> {explanation}\n\n"
+
+                    embed.add_field(
+                        name="Optional Arguments", value=arguments_value, inline=False
+                    )
+            except KeyError:
+                pass
+
+            embed.add_field(
+                name="Usage", value=f"` {commands_and_descriptions[command]['usage']} `"
+            )
+            embed.set_thumbnail(url=self.bot.user.avatar.url)
+
+            await interaction.response.send_message(embed=embed, ephemeral=True)
 
-        embed.set_thumbnail(url=self.bot.user.avatar.url)
+        else:
+            embed = discord.Embed(
+                title="Command Doesn't Exist",
+                description=f"The command you entered (` {command} `) does not exist, please try again with a different command name.",
+                color=BOT_COLOR,
+            )
 
-        view = InviteButton()
-        await interaction.response.send_message(embed=embed, view=view, ephemeral=True)
+            view = HelpView()
+            await interaction.response.send_message(
+                embed=embed, view=view, ephemeral=True
+            )
 
 
 async def setup(bot):