Forked from nonchris/discord-custom-help-command.py
Last active
April 16, 2021 11:56
-
-
Save stolenvw/1d12aa417a471c2f29f983255e635d22 to your computer and use it in GitHub Desktop.
A kinda advanced custom "help" command for your Discord.py bots!
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import discord | |
from discord.ext import commands | |
from discord.errors import Forbidden | |
"""This custom help command is a perfect replacement for the default one on any Discord Bot written in Discord.py! | |
Original concept by Jared Newsom (AKA Jared M.F.) | |
[Deleted] https://gist.github.com/StudioMFTechnologies/ad41bfd32b2379ccffe90b0e34128b8b | |
Rewritten and optimized by github.com/nonchris | |
https://gist.github.com/nonchris/1c7060a14a9d94e7929aa2ef14c41bc2 | |
Only show commands you have permission for by stolenvw | |
https://gist.github.com/stolenvw/1d12aa417a471c2f29f983255e635d22 | |
You need to set four variables to make that cog run. | |
Have a look at line 55 to 60 | |
""" | |
async def send_embed(ctx, embed): | |
""" | |
Function that handles the sending of embeds | |
-> Takes context and embed to send | |
- tries to send embed in channel | |
- tries to send normal message when that fails | |
- tries to send embed private with information abot missing permissions | |
If this all fails: https://youtu.be/dQw4w9WgXcQ | |
""" | |
try: | |
await ctx.send(embed=embed) | |
except Forbidden: | |
try: | |
await ctx.send("Hey, seems like I can't send embeds. Please check my permissions :)") | |
except Forbidden: | |
await ctx.author.send( | |
f"Hey, seems like I can't send any message in {ctx.channel.name} on {ctx.guild.name}\n" | |
f"May you inform the server team about this issue? :slight_smile: ", embed=embed) | |
class Help(commands.Cog): | |
""" | |
Sends this help message | |
""" | |
def __init__(self, bot): | |
self.bot = bot | |
self.bot.remove_command("help") | |
@commands.command() | |
# @commands.bot_has_permissions(add_reactions=True,embed_links=True) | |
async def help(self, ctx, *input): | |
"""Shows all modules of that bot""" | |
# !SET THOSE VARIABLES TO MAKE THE COG FUNCTIONAL! | |
prefix = # ENTER YOUR PREFIX - loaded from config, as string or how ever you want! | |
version = # enter version of your code | |
# setting owner name - if you don't wanna be mentioned remove line 49-60 and adjust help text (line 88) | |
owner = # ENTER YOU DISCORD-ID | |
owner_name = # ENTER YOUR USERNAME#1234 | |
# checks if cog parameter was given | |
# if not: sending all modules and commands not associated with a cog | |
async def predicate(cmd): | |
try: | |
return await cmd.can_run(ctx) | |
except commands.CommandError: | |
return False | |
if not input: | |
# checks if owner is on this server - used to 'tag' owner | |
try: | |
owner = ctx.guild.get_member(owner).mention | |
except AttributeError as e: | |
owner = owner | |
# starting to build embed | |
emb = discord.Embed(title='Commands and modules', color=discord.Color.blue(), | |
description=f'Use `{prefix}help <module>` to gain more information about that module ' | |
f':smiley:\n') | |
# iterating trough cogs, gathering descriptions | |
cogs_desc = '' | |
for cog in self.bot.cogs: | |
valid = False | |
for command in self.bot.get_cog(cog).get_commands(): | |
if not command.hidden: | |
valid = await predicate(command) | |
if valid: | |
break | |
if valid: | |
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 Bots is developed by Chriѕ#0001, based on discord.py.\n\ | |
This version of it is maintained by {owner}\n\ | |
Please visit https://github.com/nonchris/discord-fury to submit ideas or bugs.") | |
emb.set_footer(text=f"Bot is running {version}") | |
# block called when one cog-name is given | |
# trying to find matching cog and it's commands | |
elif len(input) == 1: | |
# iterating trough cogs | |
for cog in self.bot.cogs: | |
# check if cog is the matching one | |
if cog.lower() == input[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=discord.Color.green()) | |
# getting commands from cog | |
for command in self.bot.get_cog(cog).get_commands(): | |
# if cog is not hidden | |
if not command.hidden: | |
valid = await predicate(command) | |
if valid: | |
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 `{input[0]}` before :scream:", | |
color=discord.Color.orange()) | |
# too many cogs requested - only one at a time allowed | |
elif len(input) > 1: | |
emb = discord.Embed(title="That's too much.", | |
description="Please request only one module at once :sweat_smile:", | |
color=discord.Color.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-fury/issues\n" | |
"Thank you! ~Chris", | |
color=discord.Color.red()) | |
# sending reply embed using our own function defined above | |
await send_embed(ctx, emb) | |
def setup(bot): | |
bot.add_cog(Help(bot)) |
a mess up, let me fix that. I put wrong line in from the edited one i was using to test things
@carrickkv2 fixed now removed that def and put the correct one in around line 64
@stolenvw Thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi. What's config.LOGCHAN_ID on number 50?