A package allowing you to display interactive help in Discord easily


Keywords
Discord, Interactive, Help, discord-bot, menu
License
MIT
Install
pip install discord-interactive==3.0

Documentation

Discord Interactive Help

gif

A Discord python framework to display an interactive help easily.

Features

  • 🔆 Easy to naviguate : Use reactions to naviguate through the Help manual.
  • Customized reaction : Use any emoji as naviguation icon.
  • 🎮 Commands support : Go even further with interactive commands.

How to use

Download the package :

pip install discord-interactive


Import the Page and Help objects into your bot's code, and create your own help manual :

from discord_interactive import Page, Help

# Define each page
root = Page('Welcome !\n')
page_1 = Page('This is page 1')
page_2 = Page('This is page 2')

# Link pages together
page_1.link(page_2, description='Click this icon to access page 2', reaction='💩')
root.link(page_1, description='Click this icon to access page 1')

# Set the root page as the root of other page (so user can come back with a specific reaction)
root.root_of([page_1, page_2])

# Create the Help object
client = discord.Client()
h = Help(client, root)

...

# And display the help !
await h.display(message.author)

Example

For a full working example, please take a look at this Repl.it.

Or you can simply experience the interactivity of this full working example by joining this Discord server. Just type /help in the chat !

Further details

Check out the wiki !

You can also check the documentation.


The basic usage was shown in this README. If you are interested in advanced usage such as interactive commands, please take a look at the source code (main.py) of the Repl.it example.

Example of advanced usage :

gif

If you can't find what you are looking for, or need help about this library, you can open an issue, we will be glad to help !

Notes

  • This idea was already known for some time, I didn't get the idea myself. I just wanted to share an easy framework to implement it for your own bot.

  • This is working only with the Python Discord API.

  • This package have been updated to work with the new version of Discord py. Just download the last version of the package (pip install -U discord-interactive). If you still use the old version of Discord py, then keep using the version 1.1 of this package (pip install 'discord-interactive==1.1' --force-reinstall)

  • Version 3 of this package is out ! Version 3 brings a better and easier way to deal with multiple choices link, as well as a redesign of the whole API !