.. _messagedeleter:

==============
MessageDeleter
==============

This is the cog guide for the 'MessageDeleter' cog. This guide
contains the collection of commands which you can use in the cog.

Through this guide, ``[p]`` will always represent your prefix. Replace
``[p]`` with your own prefix when you use these commands in Discord.

.. note::

    This guide was last updated for version 1.0.0. Ensure
    that you are up to date by running ``[p]cog update messagedeleter``.

    If there is something missing, or something that needs improving
    in this documentation, feel free to create an issue `here <https://github.com/Kreusada/Kreusada-Cogs/issues>`_.

    This documentation is auto-generated everytime this cog receives an update.

--------------
About this cog
--------------

Delete messages from users and bots, inclusively or exclusively, in text channels.

--------
Commands
--------

Here are all the commands included in this cog (9):

+----------------------------------+--------------------------------------------------------------+
| Command                          | Help                                                         |
+==================================+==============================================================+
| ``[p]msgdeleter``                | Commands to configure MessageDeleter.                        |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter bots``           | Enable or disable deletion of bot messages.                  |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter bots disable``   | Disable deletion of bot messages in a text channel.          |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter bots enable``    | Enable deletion of bot messages in a text channel.           |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter humans``         | Enable or disable deletion of human messages.                |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter humans disable`` | Disable deletion of human messages in a text channel.        |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter humans enable``  | Enable deletion of human messages in a text channel.         |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter reset``          | Reset MessageDeleter in this guild.                          |
+----------------------------------+--------------------------------------------------------------+
| ``[p]msgdeleter settings``       | Shows the current settings for MessageDeleter in this guild. |
+----------------------------------+--------------------------------------------------------------+

------------
Installation
------------

If you haven't added my repo before, lets add it first. We'll call it
"kreusada-cogs" here.

.. code-block::

    [p]repo add kreusada-cogs https://github.com/Kreusada/Kreusada-Cogs

Now, we can install MessageDeleter.

.. code-block::

    [p]cog install kreusada-cogs messagedeleter

Once it's installed, it is not loaded by default. Load it by running the following
command:

.. code-block::

    [p]load messagedeleter

---------------
Further Support
---------------

For more support, head over to the `cog support server <https://discord.gg/GET4DVk>`_,
I have my own channel over there at #support_kreusada-cogs. Feel free to join my
`personal server <https://discord.gg/JmCFyq7>`_ whilst you're here.