.. _roleboards:

==========
RoleBoards
==========

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

    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 'leaderboards' about guild roles, such as the users with the most roles
and the roles with the most users.

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

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

+-----------------------------+-------------------------------------------------------------+
| Command                     | Help                                                        |
+=============================+=============================================================+
| ``[p]roleboard``            | Get roleboards for this server..                            |
+-----------------------------+-------------------------------------------------------------+
| ``[p]roleboard topmembers`` | Get the members with the most roles.                        |
|                             |                                                             |
|                             | **Arguments**                                               |
|                             |                                                             |
|                             |                                                             |
|                             | -   ``<index>``: The number of members to get the data for. |
+-----------------------------+-------------------------------------------------------------+
| ``[p]roleboard toproles``   | Get the roles with the most members.                        |
|                             |                                                             |
|                             | **Arguments**                                               |
|                             |                                                             |
|                             |                                                             |
|                             | -   ``<index>``: The number of roles to get the data for.   |
+-----------------------------+-------------------------------------------------------------+

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

.. code-block::

    [p]cog install kreusada-cogs roleboards

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

.. code-block::

    [p]load roleboards

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