mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
febca8ccbb
* Temporarily set d.py to use latest git revision
* Remove `bot` param to Client.start
* Switch to aware datetimes
A lot of this is removing `.replace(...)` which while not technically
needed, simplifies the code base. There's only a few changes that are
actually necessary here.
* Update to work with new Asset design
* [threads] Update core ModLog API to support threads
- Added proper support for passing `Thread` to `channel`
when creating/editing case
- Added `parent_channel_id` attribute to Modlog API's Case
- Added `parent_channel` property that tries to get parent channel
- Updated case's content to show both thread and parent information
* [threads] Disallow usage of threads in some of the commands
- announceset channel
- filter channel clear
- filter channel add
- filter channel remove
- GlobalUniqueObjectFinder converter
- permissions addglobalrule
- permissions removeglobalrule
- permissions removeserverrule
- Permissions cog does not perform any validation for IDs
when setting through YAML so that has not been touched
- streamalert twitch/youtube/picarto
- embedset channel
- set ownernotifications adddestination
* [threads] Handle threads in Red's permissions system (Requires)
- Made permissions system apply rules of (only) parent in threads
* [threads] Update embed_requested to support threads
- Threads don't have their own embed settings and inherit from parent
* [threads] Update Red.message_eligible_as_command to support threads
* [threads] Properly handle invocation of [p](un)mutechannel in threads
Usage of a (un)mutechannel will mute/unmute user in the parent channel
if it's invoked in a thread.
* [threads] Update Filter cog to properly handle threads
- `[p]filter channel list` in a threads sends list for parent channel
- Checking for filter hits for a message in a thread checks its parent
channel's word list. There's no separate word list for threads.
* [threads] Support threads in Audio cog
- Handle threads being notify channels
- Update type hint for `is_query_allowed()`
* [threads] Update type hints and documentation to reflect thread support
- Documented that `{channel}` in CCs might be a thread
- Allowed (documented) usage of threads with `Config.channel()`
- Separate thread scope is still in the picture though
if it were to be done, it's going to be in separate in PR
- GuildContext.channel might be Thread
* Use less costy channel check in customcom's on_message_without_command
This isn't needed for d.py 2.0 but whatever...
* Update for in-place edits
* Embed's bool changed behavior, I'm hoping it doesn't affect us
* Address User.permissions_in() removal
* Swap VerificationLevel.extreme with VerificationLevel.highest
* Change to keyword-only parameters
* Change of `Guild.vanity_invite()` return type
* avatar -> display_avatar
* Fix metaclass shenanigans with Converter
* Update Red.add_cog() to be inline with `dpy_commands.Bot.add_cog()`
This means adding `override` keyword-only parameter and causing
small breakage by swapping RuntimeError with discord.ClientException.
* Address all DEP-WARNs
* Remove Context.clean_prefix and use upstream implementation instead
* Remove commands.Literal and use upstream implementation instead
Honestly, this was a rather bad implementation anyway...
Breaking but actually not really - it was provisional.
* Update Command.callback's setter
Support for functools.partial is now built into d.py
* Add new perms in HUMANIZED_PERM mapping (some from d.py 1.7 it seems)
BTW, that should really be in core instead of what we have now...
* Remove the part of do_conversion that has not worked for a long while
* Stop wrapping BadArgument in ConversionFailure
This is breaking but it's best to resolve it like this.
The functionality of ConversionFailure can be replicated with
Context.current_parameter and Context.current_argument.
* Add custom errors for int and float converters
* Remove Command.__call__ as it's now implemented in d.py
* Get rid of _dpy_reimplements
These were reimplemented for the purpose of typing
so it is no longer needed now that d.py is type hinted.
* Add return to Red.remove_cog
* Ensure we don't delete messages that differ only by used sticker
* discord.InvalidArgument->ValueError
* Move from raw <t:...> syntax to discord.utils.format_dt()
* Address AsyncIter removal
* Swap to pos-only for params that are pos-only in upstream
* Update for changes to Command.params
* [threads] Support threads in ignore checks and allow ignoring them
- Updated `[p](un)ignore channel` to accept threads
- Updated `[p]ignore list` to list ignored threads
- Updated logic in `Red.ignored_channel_or_guild()`
Ignores for guild channels now work as follows (only changes for threads):
- if channel is not a thread:
- check if user has manage channels perm in channel
and allow command usage if so
- check if channel is ignored and disallow command usage if so
- allow command usage if none of the conditions above happened
- if channel is a thread:
- check if user has manage channels perm in parent channel
and allow command usage if so
- check if parent channel is ignored and disallow command usage
if so
- check if user has manage thread perm in parent channel
and allow command usage if so
- check if thread is ignored and disallow command usage if so
- allow command usage if none of the conditions above happened
* [partial] Raise TypeError when channel is of PartialMessageable type
- Red.embed_requested
- Red.ignored_channel_or_guild
* [partial] Discard command messages when channel is PartialMessageable
* [threads] Add utilities for checking appropriate perms in both channels & threads
* [threads] Update code to use can_react_in() and @bot_can_react()
* [threads] Update code to use can_send_messages_in
* [threads] Add send_messages_in_threads perm to mute role and overrides
* [threads] Update code to use (bot/user)_can_manage_channel
* [threads] Update [p]diagnoseissues to work with threads
* Type hint fix
* [threads] Patch vendored discord.ext.menus to check proper perms in threads
I guess we've reached time when we have to patch the lib we vendor...
* Make docs generation work with non-final d.py releases
* Update discord.utils.oauth_url() usage
* Swap usage of discord.Embed.Empty/discord.embeds.EmptyEmbed to None
* Update usage of Guild.member_count to work with `None`
* Switch from Guild.vanity_invite() to Guild.vanity_url
* Update startup process to work with d.py's new asynchronous startup
* Use setup_hook() for pre-connect actions
* Update core's add_cog, remove_cog, and load_extension methods
* Update all setup functions to async and add awaits to bot.add_cog calls
* Modernize cogs by using async cog_load and cog_unload
* Address StoreChannel removal
* [partial] Disallow passing PartialMessageable to Case.channel
* [partial] Update cogs and utils to work better with PartialMessageable
- Ignore messages with PartialMessageable channel in CustomCommands cog
- In Filter cog, don't pass channel to modlog.create_case()
if it's PartialMessageable
- In Trivia cog, only compare channel IDs
- Make `.utils.menus.menu()` work for messages
with PartialMessageable channel
- Make checks in `.utils.tunnel.Tunnel.communicate()` more rigid
* Add few missing DEP-WARNs
295 lines
5.3 KiB
ReStructuredText
295 lines
5.3 KiB
ReStructuredText
.. _customcommands:
|
|
|
|
==============
|
|
CustomCommands
|
|
==============
|
|
|
|
This is the cog guide for the customcommands cog. You will
|
|
find detailed docs about usage and commands.
|
|
|
|
``[p]`` is considered as your prefix.
|
|
|
|
.. note:: To use this cog, load it by typing this::
|
|
|
|
[p]load customcom
|
|
|
|
.. _customcommands-usage:
|
|
|
|
-----
|
|
Usage
|
|
-----
|
|
|
|
This cog contains commands for creating and managing custom commands that display text.
|
|
|
|
These are useful for storing information members might need, like FAQ answers or invite links.
|
|
Custom commands can be used by anyone by default, so be careful with pings.
|
|
Commands can only be lowercase, and will not respond to any uppercase letters.
|
|
|
|
|
|
.. _customcommands-commands:
|
|
|
|
--------
|
|
Commands
|
|
--------
|
|
|
|
.. _customcommands-command-customcom:
|
|
|
|
^^^^^^^^^
|
|
customcom
|
|
^^^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom
|
|
|
|
.. tip:: Alias: ``cc``
|
|
|
|
**Description**
|
|
|
|
Base command for Custom Commands management.
|
|
|
|
.. _customcommands-command-customcom-cooldown:
|
|
|
|
""""""""""""""""""
|
|
customcom cooldown
|
|
""""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom cooldown <command> [cooldown] [per=member]
|
|
|
|
**Description**
|
|
|
|
Set, edit, or view the cooldown for a custom command.
|
|
|
|
You may set cooldowns per member, thread/channel, or guild. Multiple
|
|
cooldowns may be set. All cooldowns must be cooled to call the
|
|
custom command.
|
|
|
|
Examples:
|
|
- ``[p]customcom cooldown pingrole``
|
|
- ``[p]customcom cooldown yourcommand 30``
|
|
- ``[p]cc cooldown mycommand 30 guild``
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command>`` The custom command to check or set the cooldown.
|
|
- ``<cooldown>`` The number of seconds to wait before allowing the command to be invoked again. If omitted, will instead return the current cooldown settings.
|
|
- ``<per>`` The group to apply the cooldown on. Defaults to per member. Valid choices are server, guild, user, and member.
|
|
|
|
.. _customcommands-command-customcom-create:
|
|
|
|
""""""""""""""""
|
|
customcom create
|
|
""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom create <command> <text>
|
|
|
|
.. tip:: Alias: ``customcom add``
|
|
|
|
**Description**
|
|
|
|
Create custom commands.
|
|
|
|
If a type is not specified, a simple CC will be created.
|
|
CCs can be enhanced with arguments, see the guide
|
|
:ref:`here <cog_customcom>`.
|
|
|
|
.. _customcommands-command-customcom-create-random:
|
|
|
|
"""""""""""""""""""""""
|
|
customcom create random
|
|
"""""""""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom create random <command>
|
|
|
|
**Description**
|
|
|
|
Create a CC where it will randomly choose a response!
|
|
|
|
Note: This command is interactive.
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command>`` The command executed to return the text. Cast to lowercase.
|
|
|
|
.. _customcommands-command-customcom-create-simple:
|
|
|
|
"""""""""""""""""""""""
|
|
customcom create simple
|
|
"""""""""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom create simple <command> <text>
|
|
|
|
**Description**
|
|
|
|
Add a simple custom command.
|
|
|
|
Example:
|
|
- ``[p]customcom create simple yourcommand Text you want``
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command>`` The command executed to return the text. Cast to lowercase.
|
|
- ``<text>`` The text to return when executing the command. See guide for enhanced usage.
|
|
|
|
.. _customcommands-command-customcom-delete:
|
|
|
|
""""""""""""""""
|
|
customcom delete
|
|
""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom delete <command>
|
|
|
|
.. tip:: Aliases: ``customcom del``, ``customcom remove``
|
|
|
|
**Description**
|
|
|
|
Delete a custom command.
|
|
|
|
Example:
|
|
- ``[p]customcom delete yourcommand``
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command>`` The custom command to delete.
|
|
|
|
.. _customcommands-command-customcom-edit:
|
|
|
|
""""""""""""""
|
|
customcom edit
|
|
""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom edit <command> [text]
|
|
|
|
**Description**
|
|
|
|
Edit a custom command.
|
|
|
|
Example:
|
|
- ``[p]customcom edit yourcommand Text you want``
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command>`` The custom command to edit.
|
|
- ``<text>`` The new text to return when executing the command.
|
|
|
|
.. _customcommands-command-customcom-list:
|
|
|
|
""""""""""""""
|
|
customcom list
|
|
""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom list
|
|
|
|
**Description**
|
|
|
|
List all available custom commands.
|
|
|
|
The list displays a preview of each command's response, with
|
|
markdown escaped and newlines replaced with spaces.
|
|
|
|
.. _customcommands-command-customcom-raw:
|
|
|
|
"""""""""""""
|
|
customcom raw
|
|
"""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom raw <command>
|
|
|
|
**Description**
|
|
|
|
Get the raw response of a custom command, to get the proper markdown.
|
|
|
|
This is helpful for copy and pasting.
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command>`` The custom command to get the raw response of.
|
|
|
|
.. _customcommands-command-customcom-search:
|
|
|
|
""""""""""""""""
|
|
customcom search
|
|
""""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom search <query>
|
|
|
|
**Description**
|
|
|
|
Searches through custom commands, according to the query.
|
|
|
|
Uses fuzzywuzzy searching to find close matches.
|
|
|
|
**Arguments:**
|
|
|
|
- ``<query>`` The query to search for. Can be multiple words.
|
|
|
|
.. _customcommands-command-customcom-show:
|
|
|
|
""""""""""""""
|
|
customcom show
|
|
""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]customcom show <command_name>
|
|
|
|
**Description**
|
|
|
|
Shows a custom command's responses and its settings.
|
|
|
|
**Arguments:**
|
|
|
|
- ``<command_name>`` The custom command to show.
|