.. _higherorlower:

=============
HigherOrLower
=============

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

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

Play Higher Or Lower, win big!

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

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

+-----------------------------+----------------------------------------------------------------------+
| Command                     | Help                                                                 |
+=============================+======================================================================+
| ``[p]higherorlower``        | Play Higher Or Lower!                                                |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset``               | Configuration commands for Higher Or Lower.                          |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset acehigh``       | Mods only - Set whether ace is considered high (14).                 |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset equalsurvives`` | Mods only - Set whether players survive on an equal card.            |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset payout``        | Mods only - Set the win payout for this guild.                       |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset rotatedstyle``  | Mods only - Set whether placed cards on the table use rotated style. |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset showsettings``  | Mods only - See the current settings for Higher Or Lower.            |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset size``          | Mods only - Set the grid size.                                       |
+-----------------------------+----------------------------------------------------------------------+
| ``[p]holset tablecolour``   | Set the colour of your table used in games.                          |
+-----------------------------+----------------------------------------------------------------------+

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

.. code-block::

    [p]cog install kreusada-cogs higherorlower

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

.. code-block::

    [p]load higherorlower

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