Simple-Pycord-Cog-User-Install-Command-Example

An example bot of user install slash command + cog. Using Pycord 2.6.1

What can this bot do?

1. Use slash command in public server, private server and DM. You don't need to have bot installed in the server to use the command, you can use command everywhere!
2. Using your bot command by App Launcher.

Quickstart

1. Download or git clone this repository.

2. Run pip install -r requirements.txt to install required Python library.

3. Run python main.py to start the bot.

Detailed Guide

1. To run this bot, first you need to create a bot at Discord Developer Portal. I assume you are already very familiar with this step. If you don't know how to do this, go watch some tutorial videos on YouTube.

2. Since we are making a bot that supports user install commands, we need to make enable User Install option and some other configuration at dev portal, as below image shown.

3. Now, invite your bot to your test server. Mention the bot, open its profile and click Add App.

Click Add to My Apps.

Click Authorize.

After you authorized the bot, you will see a nice little pop up at bottom right corner tells you App Added!

We can now open App Launcher and check our bot. Of course, you won't see any commands because you haven't run the code. You can see the /ping command in the image because I ran the code earlier.

4. Here comes the coding part. I assume you are familiar with these steps too, so I'll keep it simple.

• Download or git clone this repository.
• Run pip install -r requirements.txt to install required Python library.
• Create a .env file and enter DISCORD_BOT_TOKEN = 'THE_BOT_TOKEN_YOU_GET_FROM_DISCORD_DEV_PORTAL'
• Run python main.py to start the bot.

5. You can see that /ping command works without any problem in servers with/wthout bot installed and in DM :)

FAQ

I want to create another command, how do I do this?

1. Copy ping.py in cogs folder and rename it to the name you like.
2. 2. Rename every 'ping' in ping.py to the name you like.
3. Open main.py, you can see:

    extensions = [
        'cogs.ping',

    ]

now add 'cogs.another_command_name', under 'cogs.ping', 4. Restart main.py

What's the difference between user install command and regular guild install command in code?

ping.py

class ping(commands.Cog):
    def __init__(self, bot):
        self.bot = bot

    @commands.slash_command(
        name='ping',
        description='Check bot latency',
        integration_types=[
            IntegrationType.user_install, # This line shows that the command is a user install command
            IntegrationType.guild_install,
        ],
        contexts=[
            InteractionContextType.guild,
            InteractionContextType.bot_dm, # This line shows that the command can be used in DM
            InteractionContextType.private_channel, # This line shows that the command can be used in private channel
        ],
    )