.. _dropdownstexts:
==============
DropdownsTexts
==============

This is the cog guide for the ``DropdownsTexts`` 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::

    Ensure that you are up to date by running ``[p]cog update dropdownstexts``.
    If there is something missing, or something that needs improving in this documentation, feel free to create an issue `here <https://github.com/AAA3A-AAA3A/AAA3A-cogs/issues>`_.
    This documentation is generated everytime this cog receives an update.

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

A cog to have dropdowns-texts!

---------
Commands:
---------

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

* ``[p]dropdownstexts``
 Group of commands to use DropdownsTexts.

* ``[p]dropdownstexts add <message> [emoji] <label> <text_or_message>``
 Add a dropdown-text for a message.

* ``[p]dropdownstexts bulk <message> [dropdown_texts]...``
 Add dropdown-texts for a message.

* ``[p]dropdownstexts clear <message>``
 Clear a dropdown-texts for a message.

* ``[p]dropdownstexts list [message]``
 List all dropdowns-texts of this server or display the settings for a specific one.

* ``[p]dropdownstexts purge``
 Clear all dropdowns-texts for a guild.

* ``[p]dropdownstexts remove <message> <config_identifier>``
 Remove a dropdown-text for a message.

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

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

.. code-block:: ini

    [p]repo add AAA3A-cogs https://github.com/AAA3A-AAA3A/AAA3A-cogs

Now, we can install DropdownsTexts.

.. code-block:: ini

    [p]cog install AAA3A-cogs dropdownstexts

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

.. code-block:: ini

    [p]load dropdownstexts

----------------
Further Support:
----------------

Check out my docs `here <https://aaa3a-cogs.readthedocs.io/en/latest/>`_.
Mention me in the #support_other-cogs in the `cog support server <https://discord.gg/GET4DVk>`_ if you need any help.
Additionally, feel free to open an issue or pull request to this repo.

--------
Credits:
--------

Thanks to Kreusada for the Python code to automatically generate this documentation!