helpFile.py

import discord
from botClient import colorCode
from discord.ext import commands

"""Module used mainly for commands documentation functions such as comhelp, which returns detailed information
about most commands available to use for the bot"""

class BasicFunctionsHelp:
    def __init__(self, client):
        client.self = client

    @commands.command(aliases=['commandlist', 'comlist', 'commandhelp', 'commands', 'command', 'simonhelp', 'chelp'])
    async def comhelp(self, ctx):
        """====Detailed commands help===="""
        embed = discord.Embed(
            title='Commands List',
            description=
            "Use **>** in front of the command name \n"
            "Example: >hello",
            color=colorCode[0]
        )

        embed.add_field(
            name="General",
            value=
            "``user (mention?)`` - Shows info about the user \n"
            "``server`` - Shows info about the channel's server \n"
            "``weather (city)`` - Shows detailed weather in any city  \n"
            "``time (city)`` - Shows time in any city \n"
            "``hello`` - Check if bot is responsive \n "
            "``mcount`` - Counts user cache messages \n",
            inline=False
        )

        embed.add_field(
            name="Dictionary",
            value=
            "``word (word)`` - Gives definition of a word \n"
            "``ant/syn (word)`` - Gives synonym or antonym of a word \n"
            "``example (word)`` - Example of word used in a sentence",
            inline=False
        )

        embed.add_field(
            name="Games",
            value=
            "``guess`` - Shows the guessing game commands \n"
            "``flip`` - Flip a coin \n"
            "``dice (num?)`` - Roll a dice (up to 5 dices) \n"
            "``roll (max?)`` - Gives a random int number from 1 to max (default = 100)",
            inline=False
        )

        embed.add_field(
            name="Image Search",
            value=
            "**Tags are optional.** If none are given, image is random. \n"
            "You can also search for tags: e.g. ``>kona tag nier`` \n"
            "``kona (tags?)`` - Searches for an image on KonaChan \n"
            "``danb (tags?)`` - Searches for an image on Danbooru \n"
            "``yan (tags?)`` - Searches for image on Yande.re",
            inline=False
        )
        embed.set_thumbnail(url=ctx.message.author.avatar_url)
        embed.set_footer(text='Requested by ' + ctx.message.author.name + '.', icon_url=ctx.message.author.avatar_url)
        await ctx.message.channel.send(embed=embed)

    @commands.command(aliases = ['ginfo', 'guessinfo'])
    async def guess(self, ctx):
        """Letter Guess Game commands"""
        embed = discord.Embed(title='Letter Guessing Game', color=colorCode[0])
        embed.add_field(
            name='Commands',
            value=
            "``gstart`` - Starts the game \n"
            "``ghelp`` - Letter guessing game explanation \n"
            "``gstats`` - See your guessing game statistics \n"
            "``greset`` - Reset your guessing game statistics",
            inline=True
        )
        await ctx.send(embed=embed)

    @commands.command(aliases = ['ghelp', 'guessguide', 'gtutorial', 'guesstutorial'])
    async def guesshelp(self, ctx):
        """Letter Guess Game help"""
        embed = discord.Embed(
            title = 'Guessing Game - How to Play',
            description =
            "Letter Guessing Game Tutorial and Explanation",
            color=colorCode[0])

        embed.add_field(
            name="Objective",
            value=
            "The objective is to find the correct letter from the alphabet. \n"
            "You have 3 attempts by default; you can also add a higher custom amount but "
            "the game result won't be added to stats. "
            "You win if you manage to guess the right letter. \n"
            "If you have used all your attempts and none of them were the right letter, you lose.",
            inline=False
        )

        embed.add_field(
            name="How do I play?",
            value=
            "Once you start the game, Simon will ask you for a letter. "
            "You have 7 seconds to input a **lowercase English alphabet** letter \n"
            "If you manage to score in the first try, you will get a ``LUCKY``. \n"
            "If you don't, that's okay. You should still have more attempts, depending on what you chose. "
            "(The default is 3) Make sure you use the hints explained below. \n"
            "After playing, you can check your stats or reset them at will using the specific commands. \n"
            "For a list of commands, type ``comhelp`` or ``guess``.",
            inline=False
        )

        embed.add_field(
            name="How do I increase my chances?",
            value=
            "The game will give hints in the form of distance to the correct letter "
            "from your currently selected one. \n"
            "**Example1:** If 'd' is the correct answer and you've chosen 'a', "
            "you will get ``Hint: The letter you are looking for is 3 positions away.`` \n"
            "Going 3 spots to the right will net you the correct answer. \n"
            "The hints go in both directions: \n"
            "**Example2** If 'z' is the correct answer and you've chosen 'b', you will get "
            "``Hint: The letter you are looking for is 2 positions away.`` and not 24 positions. \n"
            "Imagine the beginning and end of the alphabet connected,"
            " like this: `` ... w, x, y, z, a, b, c, d, e ...`` \n"
            "So whether you go to the right or to the left is up to you. \n"
            "Keep in mind that it is possible to get every answer right with 3 attempts using the hints.",
            inline=False
        )

        embed.set_footer(text="Requested by " + ctx.message.author.name + '.', icon_url=ctx.message.author.avatar_url)

        await ctx.message.channel.send(embed=embed)


def setup(client):
    client.add_cog(BasicFunctionsHelp(client))