mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-05 18:58:53 -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
410 lines
6.8 KiB
ReStructuredText
410 lines
6.8 KiB
ReStructuredText
.. _mutes:
|
|
|
|
=====
|
|
Mutes
|
|
=====
|
|
|
|
This is the cog guide for the mutes 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 mutes
|
|
|
|
.. _mutes-usage:
|
|
|
|
-----
|
|
Usage
|
|
-----
|
|
|
|
Mute users temporarily or indefinitely.
|
|
|
|
.. _mutes-commands:
|
|
|
|
--------
|
|
Commands
|
|
--------
|
|
|
|
.. _mutes-command-activemutes:
|
|
|
|
^^^^^^^^^^^
|
|
activemutes
|
|
^^^^^^^^^^^
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]activemutes
|
|
|
|
**Description**
|
|
|
|
Displays active mutes on this server.
|
|
|
|
.. _mutes-command-mute:
|
|
|
|
^^^^
|
|
mute
|
|
^^^^
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]mute <users...> [time_and_reason]
|
|
|
|
**Description**
|
|
|
|
Mute users.
|
|
|
|
Examples:
|
|
|
|
* ``[p]mute @member1 @member2 spam 5 hours``
|
|
* ``[p]mute @member1 3 days``
|
|
|
|
**Arguments**
|
|
|
|
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
|
* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or indefinite if this hasn't been configured.
|
|
|
|
.. _mutes-command-mutechannel:
|
|
|
|
^^^^^^^^^^^
|
|
mutechannel
|
|
^^^^^^^^^^^
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]mutechannel <users...> [time_and_reason]
|
|
|
|
.. tip:: Alias: ``channelmute``
|
|
|
|
**Description**
|
|
|
|
Mute a user in the current text channel (or in the parent of the current thread).
|
|
|
|
Examples:
|
|
|
|
* ``[p]mutechannel @member1 @member2 spam 5 hours``
|
|
* ``[p]mutechannel @member1 3 days``
|
|
|
|
**Arguments**
|
|
|
|
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
|
* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or indefinite if this hasn't been configured.
|
|
|
|
.. _mutes-command-muteset:
|
|
|
|
^^^^^^^
|
|
muteset
|
|
^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset
|
|
|
|
**Description**
|
|
|
|
Mute settings.
|
|
|
|
.. _mutes-command-muteset-defaulttime:
|
|
|
|
"""""""""""""""""""
|
|
muteset defaulttime
|
|
"""""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset defaulttime [time]
|
|
|
|
.. tip:: Alias: ``muteset time``
|
|
|
|
**Description**
|
|
|
|
Set the default mute time for the mute command.
|
|
|
|
If no time interval is provided this will be cleared.
|
|
|
|
**Arguments**
|
|
|
|
* ``[time]``: The length of time for a default mute.
|
|
|
|
.. _mutes-command-muteset-forcerole:
|
|
|
|
"""""""""""""""""
|
|
muteset forcerole
|
|
"""""""""""""""""
|
|
|
|
.. note:: |owner-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset forcerole <true_or_false>
|
|
|
|
**Description**
|
|
|
|
Whether or not to force role only mutes on the bot.
|
|
|
|
**Arguments**
|
|
|
|
* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
|
|
|
|
.. _mutes-command-muteset-makerole:
|
|
|
|
""""""""""""""""
|
|
muteset makerole
|
|
""""""""""""""""
|
|
|
|
.. note:: |admin-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset makerole <name>
|
|
|
|
**Description**
|
|
|
|
Create a Muted role.
|
|
|
|
This will create a role and apply overwrites to all available channels
|
|
to more easily setup muting a user.
|
|
|
|
If you already have a muted role created on the server use
|
|
``[p]muteset role ROLE_NAME_HERE``
|
|
|
|
**Arguments**
|
|
|
|
* ``<name>``: The name of the muted role to create.
|
|
|
|
.. _mutes-command-muteset-notification:
|
|
|
|
""""""""""""""""""""
|
|
muteset notification
|
|
""""""""""""""""""""
|
|
|
|
.. note:: |admin-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset notification [channel]
|
|
|
|
**Description**
|
|
|
|
Set the notification channel for automatic unmute issues.
|
|
|
|
If no channel is provided this will be cleared and notifications
|
|
about issues when unmuting users will not be sent anywhere.
|
|
|
|
**Arguments**
|
|
|
|
* ``[channel]``: The channel to receive unmute issue updates. |channel-input|
|
|
|
|
.. _mutes-command-muteset-role:
|
|
|
|
""""""""""""
|
|
muteset role
|
|
""""""""""""
|
|
|
|
.. note:: |admin-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset role [role]
|
|
|
|
**Description**
|
|
|
|
Sets the role to be applied when muting a user.
|
|
|
|
If no role is setup the bot will attempt to mute a user by setting
|
|
channel overwrites in all channels to prevent the user from sending messages.
|
|
|
|
.. Note::
|
|
|
|
If no role is setup a user may be able to leave the server
|
|
and rejoin no longer being muted.
|
|
|
|
**Arguments**
|
|
|
|
* ``[role]``: The role for muted users to receive. |role-input|
|
|
|
|
.. _mutes-command-muteset-senddm:
|
|
|
|
""""""""""""""
|
|
muteset senddm
|
|
""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset senddm <true_or_false>
|
|
|
|
**Description**
|
|
|
|
Set whether mute notifications should be sent to users in DMs.
|
|
|
|
**Arguments**
|
|
|
|
* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
|
|
|
|
.. _mutes-command-muteset-settings:
|
|
|
|
""""""""""""""""
|
|
muteset settings
|
|
""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset settings
|
|
|
|
.. tip:: Alias: ``muteset showsettings``
|
|
|
|
**Description**
|
|
|
|
Shows the current mute settings for this guild.
|
|
|
|
.. _mutes-command-muteset-showmoderator:
|
|
|
|
"""""""""""""""""""""
|
|
muteset showmoderator
|
|
"""""""""""""""""""""
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]muteset showmoderator <true_or_false>
|
|
|
|
**Description**
|
|
|
|
Decide whether the name of the moderator muting a user should be included in the DM to that user.
|
|
|
|
**Arguments**
|
|
|
|
* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
|
|
|
|
.. _mutes-command-unmute:
|
|
|
|
^^^^^^
|
|
unmute
|
|
^^^^^^
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]unmute <users...> [reason]
|
|
|
|
**Description**
|
|
|
|
Unmute users.
|
|
|
|
**Arguments**
|
|
|
|
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
|
* ``[reason]``: The reason for the unmute.
|
|
|
|
.. _mutes-command-unmutechannel:
|
|
|
|
^^^^^^^^^^^^^
|
|
unmutechannel
|
|
^^^^^^^^^^^^^
|
|
|
|
.. note:: |mod-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]unmutechannel <users...> [reason]
|
|
|
|
.. tip:: Alias: ``channelunmute``
|
|
|
|
**Description**
|
|
|
|
Unmute a user in this channel (or in the parent of this thread).
|
|
|
|
**Arguments**
|
|
|
|
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
|
* ``[reason]``: The reason for the unmute.
|
|
|
|
.. _mutes-command-voicemute:
|
|
|
|
^^^^^^^^^
|
|
voicemute
|
|
^^^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]voicemute <users...> [reason]
|
|
|
|
**Description**
|
|
|
|
Mute a user in their current voice channel.
|
|
|
|
Examples:
|
|
|
|
* ``[p]voicemute @member1 @member2 spam 5 hours``
|
|
* ``[p]voicemute @member1 3 days``
|
|
|
|
**Arguments**
|
|
|
|
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
|
* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or indefinite if this hasn't been configured.
|
|
|
|
.. _mutes-command-voiceunmute:
|
|
|
|
^^^^^^^^^^^
|
|
voiceunmute
|
|
^^^^^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]voiceunmute <users...> [reason]
|
|
|
|
**Description**
|
|
|
|
Unmute a user in their current voice channel.
|
|
|
|
**Arguments**
|
|
|
|
* ``<users...>``: A space separated list of usernames, ID's, or mentions.
|
|
* ``[reason]``: The reason for the unmute. |