InstantCommands¶

Note

These docs refers to the version 1.3.0. Make sure you’re under the good version by typing [p]cog update.

This is the guide for the instantcmd cog. Everything you need is here.

[p] is considered as your prefix.

Installation¶

To install the cog, first load the downloader cog, included in core Red.:

[p]load downloader

Then you will need to install the Laggron’s Dumb Cogs repository:

[p]repo add Laggrons-Dumb-Cogs https://github.com/retke/Laggrons-Dumb-Cogs v3

Finally, you can install the cog:

[p]cog install Laggrons-Dumb-Cogs instantcmd

Warning

The cog is not loaded by default. To load it, type this:

[p]load instantcmd

Usage¶

InstantCommands is designed to create new commands and listeners directly from Discord. You just need basic Python and discord.py knowledge.

You can also edit the Dev’s environment added with Red 3.4.6.

Here’s an example of how it works:

Here’s a list of all commands of this cog:

instantcommand¶

Syntax:

[p][instacmd|instantcmd|instantcommand]

Description

This is the main command used for setting up the code. It will be used for all other commands.

instantcommand create¶

Syntax:

[p]instantcommand [create|add]

Description

Creates a new command/listener from a code snippet.

You will be asked to give a code snippet which will contain your function. It can be a command (you will need to add the commands decorator) or a listener (your function name must correspond to an existing discord.py listener).

Tip

Here are some examples

@commands.command()
async def command(ctx, *, argument):
    """Say your text with some magic"""

    await ctx.send("You excepted to see your text, "
                    "but it was I, Dio!")

return command

async def on_reaction_add(reaction, user):
    if user.bot:
        return
    await reaction.message.add_reaction('❤')
    await reaction.message.channel.send("Here's some love for " + user.mention)

return on_reaction_add

Note

Here are the available values for your code snippet:

bot (client object)
discord
asyncio
redbot

If you try to add a new command/listener that already exists, the bot will ask you if you want to replace the command/listener, useful for a quick bug fix instead of deleting each time.

You can have multiple listeners for the same event but with a different function name by using the instantcmd.utils.listener() decorator. It doesn’t work like discord.ext.commands.Cog.listener, it only exists so you can provide the name of the event you want to listen for.

Example

from instantcmd.utils import listener

@listener("on_message_without_command")
async def my_listener(message: discord.Message):
    # do your thing

return my_listener

This listener will be registered as my_listener and be suscribed to the event on_message_without_command.

instantcommad delete¶

Syntax

[p]instantcommand [delete|del|remove] <name>

Description

Remove an instant command or a listener from what you registered before.

Arguments

<name> The name of the command/listener.

instantcommand list¶

Syntax

[p]instantcommand list

Description

Lists the commands and listeners added with instantcmd.

instantcommand source¶

Syntax

[p]instantcommand source [command]

Description

Shows the source code of an instantcmd command or listener.

Note

This only works with InstantCommands’ commands and listeners.

Arguments

[command] The command/listener name to get the source code from.

instantcommand env¶

Syntax

[p]instantcommand env

Description

This will allow you to add custom values to the dev environment.

Those values will be accessible with any dev command ([p]debug, [p]eval, [p]repl), allowing you to make shortcuts to objects, import more libraries by default or having fixed values and functions.

This group subcommand has itself 4 subcommands, similar to the base commands:

[p]instantcommand env add: Add a new env value
[p]instantcommand env delete: Remove an env value
[p]instantcommand env list: List all env values registered to Red
[p]instantcommand env source: Show an env value’s source code

Use [p]instantcmd env add <name> to add a new value, then the bot will prompt for the code of your value. You must return a callable taking ctx as its sole parameter.

<name> will be the name given to that value.

Warning

You must have the dev mode enabled to use this. Make sure you’re running Red with the --dev flag.

Once added, that value will stay available with your dev commands.

For more informations, see the add_dev_env_value method.

Examples

[p]instantcmd env add me return lambda ctx: ctx.guild.me
[p]instantcmd env add inspect import inspect return lambda ctx: inspect

[p]instantcmd env add conf

def get_conf(ctx):
    return ctx.bot.get_cog("MyCog").config

return get_conf

[p]instantcmd env add smile

def smile(ctx):
    def make_smile(text):
        return "😃" + text + "😃"
    return make_smile

return smile

Frequently Asked Questions¶

Note

Your question is not in the list or you got an unexcpected issue?

You should join the Discord server or post an issue on the repo.

It’s written in the help message that I can add a listener. How can I do so?¶

Instead of giving a Command object, just give a simple function (don’t put the command decorator) and make sure its name is matching the lowercased Discord API listeners.

Warning

Do not use the new @commands.Cog.listener decorator introduced in Red 3.1. The bot uses bot.add_listener which doesn’t need a decorator.

Added in 1.1: InstantCommands now has its own listener decorator. It is optional and used for providing the event name.

My command was added but doesn’t respond when invoked.¶

If a command is not invoked, this is most likely due to missing arguments. Please check that you only have the ctx argument and no self argument.

Can I use Config in my command?¶

Yes you can. The Config module is already imported, you just need to use it as in a cog.

Tip

Here’s an example

@commands.command(name="test")
async def my_command(ctx):
    config = Config.get_conf(cog_instance="InstantCommands", identifier=42)
    # use anything but 260 for the identifier
    # since it's the one used for the cog settings
    config.register_guild(**{
        "foo": None
    })

    await config.guild(ctx.guild).foo.set("bar")
    await ctx.send("Well done")

return my_command

How can limit a command for some users?¶

You can use the checks module, like in a normal cog.

Tip

Here’s an example

@commands.command()
@checks.admin_or_permissions(administrator=True)
async def command(ctx):
    # your code

return command

How can I import a module without problem?¶

You can import your modules outside the function as you wish.

Tip

Here’s an example

from redbot.core import modlog
import time

@commands.command()
async def command(ctx):
    # your code

return command