discord-ext-fslash

discord-ext-fslash

This library registers commands from discord.py command framework as slash commands in discord.py as well by doing a monkey patch.

WARNING
Again, the way this library works is a monkey patch and is not without the possibility of unexpected behavior.

Features

It supports both the cooldown and other decorators of the command framework and the describe decorator of the app command to work.
The converter will automatically replace to the Transformer of slash version.
It can also automatically convert invalid annotations to str and register overnested group commands by accepting subcommands from command arguments.
Even if you have too many commands and reach the maximum number of can be registered slash commands, we have a way to deal with it. (An example is below)
If you are planning to create a bot, we recommend using HybridCommand, which comes standard in discord.py.

Installation

$ pip install discord-ext-fslash

Example

Normal

The following is an example of creating a command called ping that works with both slash and message commands.

from discord.ext.fslash import extend_force_slash

...

bot = extend_force_slash(commands.Bot(command_prefix="fs!", intents=intents))

@bot.command()
async def ping(ctx):
    await ctx.reply("pong")

Split Commands by Categories

Even if there are too many commands in the command framework to register in the slash, it provides a way to implement them all by making only the commands in the slash subcommands of the group command.
The following example creates the group commands server-tool and entertainment and sets up the commands in the command framework as subcommands of those commands.

from discord.ext.fslash import extend_force_slash

...

bot = extend_force_slash(
    commands.Bot(command_prefix="fs!", intents=intents),
    first_groups=(
        discord.app_commands.Group(name="server-tool"),
        discord.app_commands.Group(name="entertainment")
    )
)

@bot.command(description="Ban member", fsparent="server-tool")
@commands.has_guild_permissions(ban_members=True)
@commands.bot_has_guild_permissions(ban_members=True)
@commands.cooldown(1, 10, commands.BucketType.guild)
@discord.app_commands.describe(member="Member to be banned")
async def ban(ctx, *, member: discord.Member):
    # `/server-tool ban member: ...` or `fs!ban ...` to run this command.
    await ctx.typing()
    await member.ban()
    await ctx.reply("pong")

@bot.command(description="Make wow", fsparent="entertainment")
async def wow(ctx):
    # `/entertainment wow` or `fs!wow` to run this command.
    await ctx.reply("wow")

Documentation

There are features to improve compatibility for greater convenience.
See the documentation for details.

Contributing

Issues and PullRequests should be brief in content.
The code should be similar in style to the current code.
Please limit all text to 100 characters per line if possible, except for comments.
For comments, please limit to 200 characters per line if possible.

License

MIT