Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom Help Command #38

Open
ChiliMX opened this issue Dec 29, 2020 · 6 comments
Open

Custom Help Command #38

ChiliMX opened this issue Dec 29, 2020 · 6 comments
Assignees
Labels
area: commands Commands, cogs and extensions area: utilities status: discussion Discussing the implementation type: enhancement Changes or improvements to existing features

Comments

@ChiliMX
Copy link

ChiliMX commented Dec 29, 2020

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?

@Vyvy-vi
Copy link

Vyvy-vi commented Dec 31, 2020

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

@gustavwilliam
Copy link
Member

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

@gustavwilliam
Copy link
Member

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 gustavwilliam added area: commands Commands, cogs and extensions area: utilities status: discussion Discussing the implementation type: enhancement Changes or improvements to existing features labels Jan 2, 2021
@anand2312
Copy link

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.

@advrxh
Copy link

advrxh commented Jan 17, 2022

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.

@gustavwilliam
Copy link
Member

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

You're assigned to the issue now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: commands Commands, cogs and extensions area: utilities status: discussion Discussing the implementation type: enhancement Changes or improvements to existing features
Projects
None yet
Development

No branches or pull requests

5 participants