.. _flags:

=====
Flags
=====

This is the cog guide for the 'Flags' 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.1.6. Ensure
    that you are up to date by running ``[p]cog update flags``.

    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
--------------

Get flags from country names.

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

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

+-------------------+----------------------------------------------------------+
| Command           | Help                                                     |
+===================+==========================================================+
| ``[p]flag``       | Get the flag for a country.                              |
|                   |                                                          |
|                   | Either the country name or alpha 2 code can be provided. |
|                   |                                                          |
|                   | **Examples:**                                            |
|                   |                                                          |
|                   |     - ``[p]flag russia``                                 |
|                   |     - ``[p]flag brazil``                                 |
|                   |     - ``[p]flag dk``                                     |
|                   |     - ``[p]flag se``                                     |
+-------------------+----------------------------------------------------------+
| ``[p]flagemojis`` | Get flag emojis for a list of countries.                 |
|                   |                                                          |
|                   | **Examples:**                                            |
|                   |                                                          |
|                   |     - ``[p]flagemojis qatar brazil mexico``              |
|                   |     - ``[p]flagemojis "solomon islands" germany``        |
+-------------------+----------------------------------------------------------+
| ``[p]flags``      | Get a list of all the flags and their alpha 2 codes.     |
+-------------------+----------------------------------------------------------+

------------
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 Flags.

.. code-block::

    [p]cog install kreusada-cogs flags

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

.. code-block::

    [p]load flags

---------------
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.