Add custom help command

This is not the greatest help command out there, but a solid one to start with and better than the default of discord.py

Author: nonchris

src/cogs/help.py

@@ -0,0 +1,124 @@
+import discord
+from discord.ext import commands
+
+import utils as utl
+from environment import OWNER_NAME, OWNER_ID, VERSION, PREFIX
+
+"""
+This custom help command is a replacement for the default one on any Discord Bot written in discord.py!
+However, you must put "bot.remove_command('help')" in your bot, and the command must be in a cog for it to work.
+
+Original concept by Jared Newsom (AKA Jared M.F.)
+[link no longer available] https://gist.github.com/StudioMFTechnologies/ad41bfd32b2379ccffe90b0e34128b8b 
+Rewritten and optimized by https://github.com/nonchris
+https://gist.github.com/nonchris/1c7060a14a9d94e7929aa2ef14c41bc2
+
+This version relies more on the structure around this module than the gist does, which is more 'stand alone'
+"""
+
+
+class Help(commands.Cog):
+    """
+    Sends this help message
+    """
+
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.command(aliases=['h', 'hilfe'])
+    # @commands.bot_has_permissions(add_reactions=True,embed_links=True)
+    async def help(self, ctx, *params):
+        """Shows all modules of that bot"""
+
+        # checks if cog parameter was given
+        # if not: sending all modules and commands not associated with a cog
+        if not params:
+            # checks if owner is on this server - used to 'tag' owner
+            try:
+                owner = ctx.guild.get_member(OWNER_ID).mention
+
+            except AttributeError:
+                owner = OWNER_NAME
+
+            # starting to build embed
+            emb = discord.Embed(title='Commands and modules', color=utl.blue_light,
+                                description=f'Use `{PREFIX}h <module>` to gain more information about that module '
+                                            f':smiley:\n')
+
+            # iterating trough cogs, gathering descriptions
+            cogs_desc = ''
+            for cog in self.bot.cogs:
+                # ignoring boring cogs
+                if cog == "MessageListener" or cog == "Help":
+                    continue
+                cogs_desc += f'`{cog}` {self.bot.cogs[cog].__doc__}\n'
+
+            # adding 'list' of cogs to embed
+            emb.add_field(name='Modules', value=cogs_desc, inline=False)
+
+            # integrating trough uncategorized commands
+            commands_desc = ''
+            for command in self.bot.walk_commands():
+                # if cog not in a cog
+                # listing command if cog name is None and command isn't hidden
+                if not command.cog_name and not command.hidden:
+                    commands_desc += f'{command.name} - {command.help}\n'
+
+            # adding those commands to embed
+            if commands_desc:
+                emb.add_field(name='Not belonging to a module', value=commands_desc, inline=False)
+
+            # setting information about author
+            emb.add_field(name="About", value=f"The base of this Bots is developed by nonchris, using on discord.py.\n\
+                                    This version of it is maintained by {owner}\n\
+                                    Please visit https://github.com/nonchris/discord-bot to submit ideas or bugs.")
+            emb.set_footer(text=f"Bot is running Version: {VERSION}")
+
+        # block called when one cog-name is given
+        # trying to find matching cog and it's commands
+        elif len(params) == 1:
+
+            # iterating trough cogs
+            for cog in self.bot.cogs:
+                # check if cog is the matching one
+                if cog.lower() == params[0].lower():
+
+                    # making title - getting description from doc-string below class
+                    emb = discord.Embed(title=f'{cog} - Commands', description=self.bot.cogs[cog].__doc__,
+                                        color=utl.green)
+
+                    # getting commands from cog
+                    for command in self.bot.get_cog(cog).get_commands():
+                        # if cog is not hidden
+                        if not command.hidden:
+                            emb.add_field(name=f"{PREFIX}{command.name}", value=command.help, inline=False)
+                    # found cog - breaking loop
+                    break
+
+            # if input not found
+            # yes, for-loops have an else statement, it's called when no 'break' was issued
+            else:
+                emb = discord.Embed(title="What's that?!",
+                                    description=f"I've never heard from a module called `{params[0]}` before :scream:",
+                                    color=utl.orange)
+
+        # too many cogs requested - only one at a time allowed
+        elif len(params) > 1:
+            emb = discord.Embed(title="That's too much.",
+                                description="Please request only one module at once :sweat_smile:",
+                                color=utl.orange)
+
+        else:
+            emb = discord.Embed(title="It's a magical place.",
+                                description="I don't know how you got here. But I didn't see this coming at all.\n"
+                                            "Would you please be so kind to report that issue to me on github?\n"
+                                            "https://github.com/nonchris/discord-bot/issues\n"
+                                            "Thank you! ~Chris",
+                                color=utl.orange)
+
+        # sending reply embed using our own function defined above
+        await utl.send_embed(ctx, emb)
+
+
+def setup(bot):
+    bot.add_cog(Help(bot))

src/main.py

@@ -49,12 +49,13 @@ async def on_ready():
         member_count += g.member_count
     print()
     await bot.change_presence(
-        activity=discord.Activity(type=discord.ActivityType.watching, name=f"{prefix}help"))
+        activity=discord.Activity(type=discord.ActivityType.watching, name=f"{PREFIX}help"))
 
 # LOADING Extensions
-# bot.remove_command('help')
+bot.remove_command('help')  # unload default help message
 initial_extensions = [
     'cogs.misc',
+    'cogs.help'
 ]
 
 if __name__ == '__main__':