Metadata-Version: 2.1
Name: slash-cog
Version: 0.0.1
Summary: A drop-in vanilla discord.py cog to add slash command support with little to no code modifications
Home-page: https://github.com/CortexPE/slash_cog
Author: CortexPE
License: MIT
Description: # 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**
        
        ### 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`*)
        
        ### General TO-DOs & RFCs:
        
         - [ ] Make the cog more modular in order to support more customizations
         - [ ] Allow registering guild-specific commands
         - [ ] Allow preventing the cog from automatically registering global commands
        
        ### Unsupported Features (Unsupported by Discord):
        
         - [ ] Translation for Custom checks
         - [ ] Translation for `@commands.check_any()`
         - [ ] `is_owner` (commands currently hidden)
         - [ ] `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](https://github.com/Rapptz/discord.py/tree/master). 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.
        
        ### Usage:
        Simply install the pip package with:
        ```shell script
        pip install -U slash_cog
        ```
        
        Then in your bot's cog loader, load the cog (**CRITICAL:** Load it as the first extension as the cog needs to monkey patch command checks):
        ```python
        bot.load_extension("slash_cog")
        ```
        
        ---
        #### P.S. If this project / POC has been useful [sponsor me](https://www.patreon.com/CortexPE) pls, iambroke
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Internet
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
