A pretty embeded version of the default help command.
Project description
discord-ext-prettyhelp
An embed version of the built in help command for discord.py
Inspired by the DefaultHelpCommand that discord.py uses, but revised for embeds and additional sorting on individual pages that can be "scrolled" through with reactions.
Installation
pip install discord-ext-prettyhelp
Usage
Example of how to use it:
from discord.ext import commands
from discord.ext.prettyhelp import PrettyHelp
bot = commands.Bot(
command_prefix="!", help_command=PrettyHelp()
)
Added Optional Args
color
- Set the default embed colorending_note
- Set the footer of the embed. Ending notes are fed acommands.Context
(ctx
) and aPrettyHelp
(help
) instance for more advanced customization.index_title
- Set the index page name default is "Categories"menu
- set a custom menu for navigating pages. Uses apretty_help.PrettyMenu()
instance. Default ispretty_help.DefaultMenu()
no_category
- Set the name of the page with commands not part of a category. Default is "No Category"sort_commands
- Sort commands and categories alphabeticallyshow_index
- Show the index page or not
pretty_help.DefaultHelp args
active_time
- Set the time (in seconds) that the message will be active. Default is 30spage_left
- The emoji to use to page leftpage_right
- The emoji to use to page rightremove
- The emoji to use to remove the help message
By default, the help will just pick a random color on every invoke. You can change this using the color
argument:
from discord.ext import commands
from discord.ext.prettyhelp import DefaultMenu, PrettyHelp
# ":discord:743511195197374563" is a custom discord emoji format. Adjust to match your own custom emoji.
menu = DefaultMenu(
page_left="\U0001F44D",
page_right="👎",
remove=":discord:743511195197374563",
active_time=5,
)
# Custom ending note
ending_note = (
"The ending note from {ctx.bot.user.name}"
"\nFor command {help.clean_prefix}{help.invoked_with}"
)
bot = commands.Bot(command_prefix="!")
bot.help_command = PrettyHelp(
menu=menu, ending_note=ending_note
)
The basic help
command will break commands up by cogs. Each cog will be a different page. Those pages can be navigated with
the arrow embeds. The message is unresponsive after 30s of no activity, it'll remove the reactions to let you know.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file discord-ext-prettyhelp-0.2.3.tar.gz
.
File metadata
- Download URL: discord-ext-prettyhelp-0.2.3.tar.gz
- Upload date:
- Size: 9.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2550c513906802336dc44a9096fee5439e9f5cbf6375e4593c946f15421fbc6b |
|
MD5 | 00d47e2c843a54feb4f1b0f87698bab3 |
|
BLAKE2b-256 | 3385e96e05d5cee6675c94a11680af2aebad61f8ea6c404d450f789956820fef |
File details
Details for the file discord_ext_prettyhelp-0.2.3-py3-none-any.whl
.
File metadata
- Download URL: discord_ext_prettyhelp-0.2.3-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82873d8aaf3f70e2e9d956ebd97fc5ef51f3470102fa193313af3fc0e46a401c |
|
MD5 | 54766f6ae9dfa84bf82e17d03db7b519 |
|
BLAKE2b-256 | 00a8a07ed73273823410ba3b5f7a29440d829703641c1b4d94279f1301df285e |