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

make !help nicer #10

Open
1 of 2 tasks
irgendwr opened this issue Oct 13, 2019 · 1 comment
Open
1 of 2 tasks

make !help nicer #10

irgendwr opened this issue Oct 13, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@irgendwr
Copy link
Collaborator

irgendwr commented Oct 13, 2019

  • TS3: !help should fit more into as few messages as possible to prevent the anti-flood kicking in
  • Discord: we could use rich-embed to make things nicer
  • maybe also show arguments like in !man? not sure but could be useful

These are just suggestions, what do you think @Multivit4min ? I can implement it if you agree.

@irgendwr irgendwr added the enhancement New feature or request label Oct 13, 2019
@irgendwr
Copy link
Collaborator Author

With rich-embed it could look like this:
preview

JSON

{
  "content": "**39** Commands found:",
  "embed": {
    "color": 14758968,
    "thumbnail": {
      "url": "https://sinusbot.github.io/logo.png"
    },
    "fields": [
      {
        "name": "!help",
        "value": "Displays this text"
      },
      {
        "name": "!man",
        "value": "Displays detailed help about a command if available"
      },
      {
        "name": "!register",
        "value": "Register a new user"
      }
    ]
  }
}

Benefits:

Downsides:

  • harder to implement because...
    • we need to use backend.extended().createMessage() which needs a channel ID instead of using the reply() function
    • the construction is a bit more complex and we need to check more char-limits for the embed fields

The first downside is currently stopping me from implementing it because that makes is really annoying :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant