gurkbot icon indicating copy to clipboard operation
gurkbot copied to clipboard

Custom Help Command

Open ChiliMX opened this issue 4 years ago • 6 comments

We need to add a custom help command, as the default one is ugly and a custom one allows us to display whatever we want for it. I'm thinking that we use the flags extension of discord.py for it, as that's basically what the extension was built to do, but it's up to y'all. What do y'all think?

ChiliMX avatar Dec 29 '20 20:12 ChiliMX

Flags ext is external, right? (not in dpy yet)

Vyvy-vi avatar Dec 31 '20 06:12 Vyvy-vi

How do you want to use flags for the help command?

gustavwilliam avatar Dec 31 '20 10:12 gustavwilliam

Aslo @Vyvy-vi, flags aren't part of the default d.py. We'd also have to change large parts of the codebase iirc if we want to use flags, since they require a custom decorator for all commands. That's not necessarily something bad, but we'd have to discuss that. I think flags may actually be quite nice to have. Would you like to start a Discussion thread on the repo about adding flags?

Let's make a help command without flags for now, though, so we have something prettier than the default. I agree with @ChiliPy that the default is... suboptimal.

gustavwilliam avatar Jan 02 '21 14:01 gustavwilliam

Has anything been decided on this? I'd suggest doing it a bit different from the PyDis way; where it lists all the commands on calling a bare !help - and instead go with displaying all possible cogs - giving you all the different groups of commands available. Calling !help <cog name> gives you the list of commands in that cog with their short help strings and !help <command name> for the detailed description on the command. I think this would avoid wasting time clicking through pages on a long help command, finding the command you need quicker.

anand2312 avatar Jan 27 '21 14:01 anand2312

I had discussed about the command on discord with Vester(@gustavwilliam), he suggested the command could use the new SELECT interaction, I'd be happy to work on this.

advrxh avatar Jan 17 '22 13:01 advrxh

Lovely! I'm looking forward to seeing a fancy new help command 😄

You're assigned to the issue now.

gustavwilliam avatar Jan 17 '22 13:01 gustavwilliam