From 76cdb52b4b59dd1dfd09ea9a47ecdd807e015b27 Mon Sep 17 00:00:00 2001 From: Grant Birkinbine Date: Mon, 6 Dec 2021 12:25:47 -0800 Subject: [PATCH] add play help command --- app/plugins/play/play.py | 42 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/app/plugins/play/play.py b/app/plugins/play/play.py index 5d1c1c74..64ff80aa 100644 --- a/app/plugins/play/play.py +++ b/app/plugins/play/play.py @@ -101,6 +101,48 @@ def play_cron(self): Sentry().capture(e) self.log.exception(f"The play_cron() failed! - Error: {e}") + @botcmd + def play_help(self, msg, args): + """ + The help command for .play + View all the different ways you can use the .play functions + """ + + message = "" + # .play + message += "**`.play`** - Play a song!\n" + message += ( + "• Option: `--queue ` - The position in the queue to add the song\n" + ) + message += "• Example: `.play never gonna give you up`\n" + message += "• Example: `.play https://www.youtube.com/watch?v=dQw4w9WgXcQ`\n\n" + + # .play next + message += "**`.play next`** - Add a song to the queue and play it 'next'\n" + message += "• Example: `.play next never gonna give you up`\n\n" + + # .play queue + message += "**`.play queue`** - View the current queue\n\n" + + # .skip + message += "**`.skip`** - Skip the current song\n\n" + + # .stop + message += "**`.stop`** - Stop and clear all the songs in the queue\n\n" + + # .play stats + message += ( + "**`.play stats`** - View the `.play` stats for the Discord server\n\n" + ) + + return discord.send_card_helper( + bot_self=self, + title="🎧 **.play help** 🎧", + body=message, + color=discord.color("blue"), + in_reply_to=msg, + ) + @botcmd def play_next(self, msg, args): """