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
455 lines
8.0 KiB
ReStructuredText
455 lines
8.0 KiB
ReStructuredText
.. _admin:
|
|
|
|
=====
|
|
Admin
|
|
=====
|
|
|
|
This is the cog guide for the admin 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 admin
|
|
|
|
.. _admin-usage:
|
|
|
|
-----
|
|
Usage
|
|
-----
|
|
|
|
This cog will provide tools for server admins and bot owners.
|
|
|
|
It can add or remove a role to a member, edit one or make some available
|
|
for members so they can self-assign them as they wish.
|
|
|
|
It also provides tools for the bot owner such as server locking (once enabled,
|
|
the bot will instantly leave new servers it joins) and announcements, which
|
|
can send something in all the servers of the bot.
|
|
|
|
.. _admin-commands:
|
|
|
|
--------
|
|
Commands
|
|
--------
|
|
|
|
Here's a list of all commands available for this cog.
|
|
|
|
.. _admin-command-selfrole:
|
|
|
|
^^^^^^^^
|
|
selfrole
|
|
^^^^^^^^
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfrole <selfrole>
|
|
|
|
**Description**
|
|
|
|
Add or remove a role from yourself. It must have been configured as user settable
|
|
by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
|
|
|
|
**Arguments**
|
|
|
|
* ``<selfrole>``: The role you want to attribute or remove from yourself. |role-input|
|
|
|
|
.. _admin-command-selfrole-add:
|
|
|
|
""""""""""""
|
|
selfrole add
|
|
""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfrole add <selfrole>
|
|
|
|
**Description**
|
|
|
|
Add a role to yourself. It must have been configured as user settable
|
|
by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
|
|
|
|
**Arguments**
|
|
|
|
* ``<selfrole>``: The role you want to attribute to yourself. |role-input|
|
|
|
|
.. _admin-command-selfrole-remove:
|
|
|
|
"""""""""""""""
|
|
selfrole remove
|
|
"""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfrole remove <selfrole>
|
|
|
|
**Description**
|
|
|
|
Remove a role from yourself. It must have been configured as user settable
|
|
by admins using the :ref:`selfroleset command <admin-command-selfroleset>`.
|
|
|
|
**Arguments**
|
|
|
|
* ``<selfrole>``: The role you want to remove from yourself. |role-input|
|
|
|
|
|
|
.. _admin-command-selfrole-list:
|
|
|
|
"""""""""""""
|
|
selfrole list
|
|
"""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfrole list
|
|
|
|
**Description**
|
|
|
|
List all of the available roles you can assign to yourself.
|
|
|
|
.. _admin-command-selfroleset:
|
|
|
|
^^^^^^^^^^^
|
|
selfroleset
|
|
^^^^^^^^^^^
|
|
|
|
.. note:: |admin-lock| This is also usable by the members with the
|
|
``Manage roles`` permission.
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfroleset
|
|
|
|
**Description**
|
|
|
|
Define the list of user settable roles. Those roles will be available to any
|
|
member using the :ref:`selfrole command <admin-command-selfrole>`.
|
|
|
|
.. _admin-command-selfroleset-add:
|
|
|
|
"""""""""""""""
|
|
selfroleset add
|
|
"""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfroleset add <role>
|
|
|
|
**Description**
|
|
|
|
Add a role, or a selection of roles, to the list of available selfroles.
|
|
|
|
.. warning:: Members will be able to assign themselves the role.
|
|
Make sure it doesn't give extra perms or anything that can break
|
|
your server's security.
|
|
|
|
**Arguments**
|
|
|
|
* ``<role>``: The role to add to the list. |role-input|
|
|
|
|
.. _admin-command-selfroleset-clear:
|
|
|
|
"""""""""""""""""
|
|
selfroleset clear
|
|
"""""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfroleset clear
|
|
|
|
**Description**
|
|
|
|
Clear the list of available selfroles for this server.
|
|
|
|
.. _admin-command-selfroleset-remove:
|
|
|
|
""""""""""""""""""
|
|
selfroleset remove
|
|
""""""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]selfroleset remove <role>
|
|
|
|
**Description**
|
|
|
|
Remove a role, or a selection of roles, from the list of available selfroles.
|
|
|
|
**Arguments**
|
|
|
|
* ``<role>``: The role to remove from the list. |role-input|
|
|
|
|
.. _admin-command-addrole:
|
|
|
|
^^^^^^^
|
|
addrole
|
|
^^^^^^^
|
|
|
|
.. note:: |admin-lock| This is also usable by the members with the ``Manage
|
|
roles`` permission.
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]addrole <rolename> [user]
|
|
|
|
**Description**
|
|
|
|
Adds a role to a member. If ``user`` is not given, it will be considered
|
|
as yourself, the command author.
|
|
|
|
**Arguments**
|
|
|
|
* ``<role>``: The role to add to the member. |role-input-quotes|
|
|
|
|
* ``[user]``: The member you want to add the role to. Defaults to the
|
|
command author. |member-input|
|
|
|
|
.. _admin-command-removerole:
|
|
|
|
^^^^^^^^^^
|
|
removerole
|
|
^^^^^^^^^^
|
|
|
|
.. note:: |admin-lock| This is also usable by the members with the
|
|
``Manage roles`` permission.
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]removerole <rolename> [user]
|
|
|
|
**Description**
|
|
|
|
Removes a role from a member. If ``user`` is not given, it will be considered
|
|
as yourself, the command author.
|
|
|
|
**Arguments**
|
|
|
|
* ``<role>``: The role to remove. |role-input-quotes|
|
|
|
|
* ``[user]``: The member to remove the role from. |member-input| Defaults
|
|
to the command author.
|
|
|
|
.. _admin-command-editrole:
|
|
|
|
^^^^^^^^
|
|
editrole
|
|
^^^^^^^^
|
|
|
|
.. note:: |admin-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]editrole
|
|
|
|
**Description**
|
|
|
|
Edits the settings of a role.
|
|
|
|
.. _admin-command-editrole-name:
|
|
|
|
"""""""""""""
|
|
editrole name
|
|
"""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]editrole name <role> <name>
|
|
|
|
**Description**
|
|
|
|
Edits the name of a role.
|
|
|
|
**Arguments**
|
|
|
|
* ``<role>``: The role name to edit. |role-input-quotes|
|
|
|
|
* ``<name>``: The new role name. If it has spaces, you must use quotes.
|
|
|
|
.. _admin-command-editrole-color:
|
|
|
|
""""""""""""""
|
|
editrole color
|
|
""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]editrole color <role> <color>
|
|
|
|
**Description**
|
|
|
|
Edits the color of a role.
|
|
|
|
**Arguments**
|
|
|
|
* ``<role>``: The role name to edit. |role-input-quotes|
|
|
|
|
* ``<color>``: The new color to assign. |color-input|
|
|
|
|
**Examples**
|
|
|
|
* ``[p]editrole color "My role" #ff0000``
|
|
|
|
* ``[p]editrole color "My role" dark_blue``
|
|
|
|
.. _admin-command-announce:
|
|
|
|
^^^^^^^^
|
|
announce
|
|
^^^^^^^^
|
|
|
|
.. note:: |owner-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]announce <message>
|
|
|
|
**Description**
|
|
|
|
Announce your message to all of the servers the bot is in.
|
|
|
|
The bot will announce the message in the guild's announcements channel.
|
|
If this channel is not set, the message won't be announced.
|
|
|
|
**Arguments**
|
|
|
|
* ``<message>``: The message to send.
|
|
|
|
.. _admin-command-announce-cancel:
|
|
|
|
"""""""""""""""
|
|
announce cancel
|
|
"""""""""""""""
|
|
|
|
.. note:: |owner-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]announce cancel
|
|
|
|
**Description**
|
|
|
|
Cancels an active announcement.
|
|
|
|
.. _admin-command-announceset:
|
|
|
|
^^^^^^^^^^^
|
|
announceset
|
|
^^^^^^^^^^^
|
|
|
|
.. note:: |guildowner-lock|
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]announceset
|
|
|
|
**Description**
|
|
|
|
Change how announcements are received in this guild.
|
|
|
|
.. _admin-command-announceset-channel:
|
|
|
|
"""""""""""""""""""
|
|
announceset channel
|
|
"""""""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]announceset channel <channel>
|
|
|
|
**Description**
|
|
|
|
Sets the channel where the bot owner announcements will be sent.
|
|
|
|
**Arguments**
|
|
|
|
* ``<channel>``: The channel that will be used for bot announcements.
|
|
|channel-input|
|
|
|
|
.. _admin-command-announceset-clearchannel:
|
|
|
|
""""""""""""""""""""""""
|
|
announceset clearchannel
|
|
""""""""""""""""""""""""
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]announceset clearchannel
|
|
|
|
**Description**
|
|
|
|
Disables announcements on your server. To enable them again, you will have to
|
|
re-enter your announcements channel with the :ref:`announceset channel
|
|
<admin-command-announceset-channel>` command.
|
|
|
|
.. _admin-command-serverlock:
|
|
|
|
^^^^^^^^^^
|
|
serverlock
|
|
^^^^^^^^^^
|
|
|
|
.. note:: |owner-lock| This is also usable by the members with the
|
|
``Administrator`` permission.
|
|
|
|
**Syntax**
|
|
|
|
.. code-block:: none
|
|
|
|
[p]serverlock
|
|
|
|
**Description**
|
|
|
|
Lock a bot to its current servers only.
|
|
|
|
This means that, once you enable this, if someone invites the bot to a new
|
|
server, the bot will automatically leave the server.
|
|
|
|
.. tip:: Another way to prevent your bot from being invited on more servers is
|
|
making it private directly from the developer portal.
|
|
|
|
Once a bot is private, it can only be invited by its owner (or team
|
|
owners). Other users will get an error on Discord's webpage explaining that
|
|
the bot is private.
|
|
|
|
To do this, go to the `Discord developer portal
|
|
<https://discord.com/developers>`_, select your application, click "Bot" in
|
|
the sidebar, then untick "Public bot".
|
|
|
|
.. image:: ../.resources/admin/public_bot.png
|