Git Product home page Git Product logo

slash_cog's Introduction

discord.py /slash cog

A drop-in vanilla discord.py cog that acts as a translation layer to add slash command support with little to no code modifications, no forks needed

PyPI - License PyPI PyPI - Status PyPI - Python Version

Features:

  • Automatically generates a command map with argument listing for the entire bot
  • Wraps around existing discord.py Context, almost no code modifications needed
  • Automatic Multi-Instance bot detection (currently, it will only register if there is no shards or the bot runs shard 0)
  • Storage-less automatic permissions syncing

General TO-DOs & RFCs:

  • Make the cog more modular in order to support more customizations
  • Avoid monkey-patching command checks
  • Translation for has_role

Unsupported Features (Unsupported by Discord):

  • Translation for Custom checks
  • Translation for @commands.check_any()
  • is_nsfw (commands currently hidden)
  • *has_permissions (only roles and user IDs are accepted)
  • bot_has_(any)?_role
  • guild_only
  • dm_only

Fork Support:

I personally won't provide support for forks as for simplicity's sake I will be basing this cog on Rapptz/discord.py master v2.0.0a. However, fork-specific pull requests are allowed.

A word though, because everyone is making their own forks of discord.py, I would suggest changing up the readme to include what changes and features the fork has added apart from API parity and maintenance just to make everybody's lives easier.

3-step Usage:

Simply install the pip package with:

pip install -U slash_cog

Then in your bot's cog loader, load the command handler (CRITICAL: Load it as the first extension as the cog needs to monkey patch command checks):

bot.load_extension("slash_cog")

Create a new cog to register the commands globally or per-guild, you may copy the example.

Preferably, you should only register the commands once and keep them registered as Discord will retain the command data unless you replace them, but the code for this is for you to decide and/or modify the example to.


P.S. If this project / POC has been useful sponsor me pls, iambroke

slash_cog's People

Contributors

cortexpe avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.