Redesigned help command

ColaIan · ColaIan · commit f6c60bf2dbce · 2020-01-27T20:09:08.000+08:00
Signed-off-by: ColaIan &lt;colaian.yt@gmail.com&gt;
diff --git a/Teapot.py b/Teapot.py
@@ -53,14 +53,17 @@
     time_start = time.perf_counter()
     database = teapot.managers.database.__init__()
     db = teapot.managers.database.db(database)
-    db.execute('CREATE TABLE IF NOT EXISTS `guilds` (`guild_id` BIGINT, `guild_name` TINYTEXT)')
-    db.execute('CREATE TABLE IF NOT EXISTS `channels` (`channel_id` BIGINT, `channel_name` TINYTEXT)')
-    db.execute("CREATE TABLE IF NOT EXISTS `users` (`user_id` BIGINT, `user_name` TINYTEXT, `user_discriminator` INT)")
-    db.execute("CREATE TABLE IF NOT EXISTS `bot_logs` (`timestamp` TEXT, `type` TINYTEXT, `class` TINYTEXT, `message` "
-               "MEDIUMTEXT)")
+    db.execute('ALTER DATABASE teapot CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci')
+    db.execute(
+        'CREATE TABLE IF NOT EXISTS `guilds` (`guild_id` BIGINT, `guild_name` TINYTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci')
+    db.execute(
+        'CREATE TABLE IF NOT EXISTS `channels` (`channel_id` BIGINT, `channel_name` TINYTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci')
+    db.execute(
+        "CREATE TABLE IF NOT EXISTS `users` (`user_id` BIGINT, `user_name` TINYTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci, `user_discriminator` INT) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci")
+    db.execute(
+        "CREATE TABLE IF NOT EXISTS `bot_logs` (`timestamp` TEXT, `type` TINYTEXT, `class` TINYTEXT, `message` MEDIUMTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci")
     teapot.managers.database.create_table(
-        "CREATE TABLE IF NOT EXISTS `guild_logs` (`timestamp` TEXT, `guild_id` BIGINT, `channel_id` BIGINT, "
-        "`message_id` BIGINT, `user_id` BIGINT, `action_type` TINYTEXT, `message` MEDIUMTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci)")
+        "CREATE TABLE IF NOT EXISTS `guild_logs` (`timestamp` TEXT, `guild_id` BIGINT, `channel_id` BIGINT, `message_id` BIGINT, `user_id` BIGINT, `action_type` TINYTEXT, `message` MEDIUMTEXT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci")
 
     print(
         f"Connected to database ({teapot.config.db_host()}:{teapot.config.db_port()}) in {round(time.perf_counter() - time_start, 2)}s")
diff --git a/teapot/cogs/cat.py b/teapot/cogs/cat.py
@@ -9,7 +9,7 @@
 
 
 class Cat(commands.Cog):
-    """ Cat Module"""
+    """ Cat and dog command"""
 
     def __init__(self, bot):
         """ Initialize Cat Class"""
@@ -18,7 +18,7 @@ def __init__(self, bot):
 
     @commands.command(pass_context=True, aliases=['meow'])
     async def cat(self, ctx):
-        """ When User Types ~meow, return a cat link """
+        """ Get a cat image """
         req = requests.get('https://api.thecatapi.com/v1/images/search')
         if req.status_code != 200:
             print("Could not get a meow")
@@ -30,6 +30,7 @@ async def cat(self, ctx):
 
     @commands.command(pass_context=True, aliases=['woof'])
     async def dog(self, ctx):
+        """ Get a dog image """
         req = requests.get('http://random.dog/')
         if req.status_code != 200:
             print("Could not get a woof")
diff --git a/teapot/cogs/cmds.py b/teapot/cogs/cmds.py
@@ -19,27 +19,53 @@ def helpcmd(bot):
     bot.remove_command('help')
 
     @bot.command(aliases=['?'])
-    async def help(ctx):
-        embed = discord.Embed(title="Command List", description="List of commands that you can use",
-                              color=0x7400FF)
-        embed.set_author(name=f"Teapot.py {teapot.version()}",
-                         icon_url="https://cdn.discordapp.com/avatars/612634758744113182/7fe078b5ea6b43000dfb7964e3e4d21d.png?size=512")
-        embed.set_thumbnail(url="https://avatars2.githubusercontent.com/u/60006969?s=200&v=4")
-        embed.add_field(name="General", value="``help``, ``info``", inline=False)
-        embed.add_field(name="Music",
-                        value="``play``, ``pause``, ``resume``, ``stop``, ``repeat``, ``seek``, ``skip``, ``remove``, ``now``, ``queue``, ``volume``, ``shuffle``, ``find``, ``disconnect``",
-                        inline=False)
-        embed.add_field(name="Tools", value="``github``, ``osu``", inline=False)
-        embed.add_field(name="Fun", value="``cat``, ``dog``, ``neko``, ``hentai [NSFW]``", inline=False)
-        embed.add_field(name="Staff", value="``purge``, ``ping``, ``kick``, ``ban``", inline=False)
-        embed.add_field(name="Links",
-                        value="[Support Discord](https://discord.gg/7BRGs6F) | [Add bot to server](https://discordapp.com/api/oauth2/authorize?client_id=669880564270104586&permissions=0&scope=bot) | [Repository](https://github.com/RedCokeDevelopment/Teapot.py)",
-                        inline=False)
-
-        embed.set_image(
-            url="https://user-images.githubusercontent.com/43201383/72987537-89830a80-3e25-11ea-95ef-ecfa0afcff7e.png")
-        embed.set_footer(text=f"{teapot.copyright()} | Code licensed under the MIT License")
-        await ctx.send(embed=embed)
+    async def help(ctx, *cog):
+        if not cog:
+            embed = discord.Embed(description="📖 Help", color=0x7400FF,
+                                  icon_url="https://cdn.discordapp.com/avatars/612634758744113182/7fe078b5ea6b43000dfb7964e3e4d21d.png?size=512")
+            embed.set_thumbnail(url="https://avatars2.githubusercontent.com/u/60006969?s=200&v=4")
+            cogs_desc = ""
+            for x in bot.cogs:
+                cogs_desc += f'**{x}** - {bot.cogs[x].__doc__}\n'
+            embed.add_field(name='Modules', value=cogs_desc[0:len(cogs_desc) - 1])
+            embed.set_footer(text=f"{teapot.copyright()} | Code licensed under the MIT License")
+            await ctx.send(embed=embed)
+            await ctx.message.add_reaction(emoji='✅')
+        else:
+            if len(cog) > 1:
+                await ctx.send(embed=teapot.messages.toomanyarguments())
+                await ctx.message.add_reaction(emoji='🛑')
+            else:
+                found = False
+                for x in bot.cogs:
+                    for y in cog:
+                        if x == y:
+                            embed = discord.Embed(color=0x7400FF)
+                            cog_info = ''
+                            for c in bot.get_cog(y).get_commands():
+                                if not c.hidden:
+                                    cog_info += f"**{c.name}** - {c.help}\n"
+                            embed.add_field(name=f"{cog[0]} Module", value=cog_info)
+                            await ctx.send(embed=embed)
+                            await ctx.message.add_reaction(emoji='✅')
+                            found = True
+                if not found:
+                    for x in bot.cogs:
+                        for c in bot.get_cog(x).get_commands():
+                            if c.name.lower() == cog[0].lower():
+                                embed = discord.Embed(title=f"Command: {c.name.lower().capitalize()}",
+                                                      description=f"**Description:** {c.help}\n**Syntax:** {c.qualified_name} {c.signature}",
+                                                      color=0x7400FF)
+                                embed.set_author(name=f"Teapot.py {teapot.version()}",
+                                                 icon_url="https://cdn.discordapp.com/avatars/612634758744113182/7fe078b5ea6b43000dfb7964e3e4d21d.png?size=512")
+                                await ctx.message.add_reaction(emoji='✅')
+                                found = True
+                    if not found:
+                        embed = teapot.messages.notfound("Module")
+                        await ctx.message.add_reaction(emoji='🛑')
+                    await ctx.send(embed=embed)
+                else:
+                    await ctx.message.add_reaction(emoji='✅')
 
 
 def info(bot):
@@ -61,6 +87,9 @@ async def info(ctx):
         embed.add_field(name="Bug Report:", value="[Issues](https://github.com/RedCokeDevelopment/Teapot.py/issues)",
                         inline=True)
         embed.add_field(name="Discussion:", value="[Forums](https://forum.redtea.red)", inline=True)
+        embed.add_field(name="Links",
+                        value="[Support Discord](https://discord.gg/7BRGs6F) | [Add bot to server](https://discordapp.com/oauth2/authorize?client_id=669880564270104586&permissions=8&scope=bot) | [Repository](https://github.com/RedCokeDevelopment/Teapot.py)",
+                        inline=False)
         embed.set_footer(text=f"{teapot.copyright()} | Code licensed under the MIT License")
         embed.set_image(
             url="https://user-images.githubusercontent.com/43201383/72987537-89830a80-3e25-11ea-95ef-ecfa0afcff7e.png")
diff --git a/teapot/cogs/github.py b/teapot/cogs/github.py
@@ -16,6 +16,7 @@ def __init__(self, bot):
 
     @commands.command(pass_context=True, aliases=['gh'])
     async def github(self, ctx, arg):
+        """Fetch repository info"""
         req = requests.get(f'https://api.github.com/repos/{arg}')
         apijson = json.loads(req.text)
         if req.status_code == 200:
diff --git a/teapot/cogs/music.py b/teapot/cogs/music.py
@@ -11,6 +11,8 @@
 
 
 class Music(commands.Cog):
+    """Music Time"""
+
     def __init__(self, bot):
         self.bot = bot
 
diff --git a/teapot/cogs/neko.py b/teapot/cogs/neko.py
@@ -1,4 +1,4 @@
-""" Module for generating a random cat picture"""
+""" Module for generating random neko pictures"""
 import io
 import json
 
@@ -12,10 +12,10 @@
 
 
 class Neko(commands.Cog):
-    """ Cat Module"""
+    """Neko!!! :3"""
 
     def __init__(self, bot):
-        """ Initialize Cat Class"""
+        """ Initialize neko class"""
 
         self.bot = bot
 
@@ -51,10 +51,6 @@ async def wallpaper(self, ctx):
     async def tickle(self, ctx):
         await ctx.send(embed=self.neko_api(ctx, "tickle"))
 
-    @commands.command(pass_context=True)
-    async def ngif(self, ctx):
-        await ctx.send(embed=self.neko_api(ctx, "ngif"))
-
     @commands.command(pass_context=True)
     async def poke(self, ctx):
         await ctx.send(embed=self.neko_api(ctx, "poke"))
@@ -90,7 +86,7 @@ async def gox_girl(self, ctx):
     @commands.command(pass_context=True)
     async def hentai(self, ctx, type=""):
         if ctx.message.channel.nsfw:
-            api_types = ['femdom', 'classic', 'erofeet', 'erok', 'les',
+            api_types = ['femdom', 'classic', 'ngif', 'erofeet', 'erok', 'les',
                          'hololewd', 'lewdk', 'keta', 'feetg', 'nsfw_neko_gif', 'eroyuri',
                          'tits', 'pussy_jpg', 'cum_jpg', 'pussy', 'lewdkemo', 'lewd', 'cum', 'spank',
                          'smallboobs', 'Random_hentai_gif', 'nsfw_avatar', 'hug', 'gecg', 'boobs', 'pat',
diff --git a/teapot/cogs/osu.py b/teapot/cogs/osu.py
@@ -46,15 +46,14 @@ def display(self, author):
 
 
 class Osu(commands.Cog):
+    """Osu! Statistics"""
+
     def __init__(self, bot):
         self.bot = bot
 
     @commands.command(pass_context=True, no_pm=True)
     async def osu(self, ctx, *, args: str):
-        """
-        Look up an osu player:
-        Usage: osu [UserID/Username]
-        """
+        """ Look up an osu player """
 
         args_array = args.split(' ')
         if len(args_array) == 2:
diff --git a/teapot/events.py b/teapot/events.py
@@ -99,7 +99,7 @@ async def on_raw_message_edit(ctx):
                 except Exception as e:
                     print(e)
         except:
-            content = str(json.loads(json.dumps(ctx.data))['embeds'][0])
+            content = str(json.loads(json.dumps(ctx.data))['embeds'])
             if teapot.config.storage_type() == "mysql":
                 try:
                     database = teapot.database.__init__()
diff --git a/teapot/messages.py b/teapot/messages.py
@@ -2,8 +2,9 @@
 
 
 def WIP():
-    return discord.Embed(title="⏲ This feature is Work In Progress!",
-                         description="Please stay tuned to our latest updates!", color=0x89CFF0)
+    return discord.Embed(title="⏲ This feature is work in progress!",
+                         description="Please stay tuned to our latest updates [here]("
+                                     "https://github.com/RedCokeDevelopment/Teapot.py)!", color=0x89CFF0)
 
 
 def PermissionDenied():
@@ -31,3 +32,8 @@ def error(e="executing command"):
 def invalidargument(arg):
     return discord.Embed(title="🟥 Invalid argument!", description=f"Valid argument(s): ``{arg}``",
                          color=0xFF0000)
+
+
+def toomanyarguments():
+    return discord.Embed(title="🛑 Too many arguments!", description=f"You have entered too many arguments!",
+                         color=0xFF0000)
diff --git a/teapot/setup.py b/teapot/setup.py
@@ -66,8 +66,7 @@ def __init__():
 
 LAVALINK_HOST={input_lavalink_host}
 LAVALINK_PORT={input_lavalink_port}
-LAVALINK_PASSWORD={input_lavalink_password}
-        """
+LAVALINK_PASSWORD={input_lavalink_password}"""
         open('./.env', 'w').write(config)
         print("\n[*] Successfully created config.ini!")
         print("Setup complete!")
