.. _presencechart:
=============
PresenceChart
=============

This is the cog guide for the 'PresenceChart' 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 presencechart``.
    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 auto-generated everytime this cog receives an update.

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

A cog to make a chart with the different Discord statuses (presence) of a Discord member, in the previous x days (last 100 days maximum)!

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

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

* ``[p]presencechart [days_number=30] [frame_mode=True] [member=<you>]``
 Make a chart with the different Discord statuses (presence) of a Discord member, in the previous x days (last 100 days maximum).

* ``[p]presencechart guild [frame_mode=True]``
 Make a chart with the different Discord statuses (presence) of all members of the guild/server.

* ``[p]presencechart ignoreme``
 Asking PresenceChart to ignore your statuses (presence).

* ``[p]presencechart member [days_number=30] [frame_mode=True] [member=<you>]``
 Make a chart with the different Discord statuses (presence) of a Discord member, in the previous x days (last 100 days maximum).

* ``[p]presencechart role [frame_mode=True] <role>``
 Make a chart with the different Discord statuses (presence) of all members of the specfied role.

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

.. code-block:: ini

    [p]cog install AAA3A-cogs presencechart

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

.. code-block:: ini

    [p]load presencechart

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

------
Credit
------

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