mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
[Docs] General Cog Guide (#4797)
* [Docs] General Cog Guide * Doc Style Fixes * Requested Changes * Additional grammar fix that was missed Co-authored-by: kreusada <67752638+kreus7@users.noreply.github.com>
This commit is contained in:
parent
ae2bae058c
commit
92ea92b617
214
docs/cog_guides/general.rst
Normal file
214
docs/cog_guides/general.rst
Normal file
@ -0,0 +1,214 @@
|
|||||||
|
.. _general:
|
||||||
|
|
||||||
|
=======
|
||||||
|
General
|
||||||
|
=======
|
||||||
|
|
||||||
|
This is the cog guide for the general cog. You will
|
||||||
|
find detailed docs about usage and commands.
|
||||||
|
|
||||||
|
``[p]`` is considered as your prefix.
|
||||||
|
|
||||||
|
.. note:: To use this cog, load it by typing this::
|
||||||
|
|
||||||
|
[p]load general
|
||||||
|
|
||||||
|
.. _general-usage:
|
||||||
|
|
||||||
|
-----
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
This cog includes a miscellaneous group of games, useful
|
||||||
|
tools, and informative commands such as ``serverinfo`` or ``urban``.
|
||||||
|
|
||||||
|
.. _general-commands:
|
||||||
|
|
||||||
|
--------
|
||||||
|
Commands
|
||||||
|
--------
|
||||||
|
|
||||||
|
Here's a list of all commands available for this cog.
|
||||||
|
|
||||||
|
.. _general-command-8:
|
||||||
|
|
||||||
|
^^^^^^^^^
|
||||||
|
8 (8ball)
|
||||||
|
^^^^^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]8 <question>
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Ask 8 ball a question.
|
||||||
|
|
||||||
|
.. note:: Your question must end with a question mark.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``<question>``: The question you would like to ask 8 ball.
|
||||||
|
|
||||||
|
.. _general-command-choose:
|
||||||
|
|
||||||
|
^^^^^^
|
||||||
|
choose
|
||||||
|
^^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]choose [choices...]
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Choose between multiple options.
|
||||||
|
|
||||||
|
.. note:: To denote options which include whitespace, you should use
|
||||||
|
double quotes.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``[choices...]``: The arguments for Red to randomly choose from.
|
||||||
|
|
||||||
|
.. _general-command-flip:
|
||||||
|
|
||||||
|
^^^^
|
||||||
|
flip
|
||||||
|
^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]flip [user]
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Flip a coin... or a user.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``[user]``: The user to flip. Defaults to flipping a coin if no user is provided.
|
||||||
|
|
||||||
|
.. _general-command-lmgtfy:
|
||||||
|
|
||||||
|
^^^^^^
|
||||||
|
lmgtfy
|
||||||
|
^^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]lmgtfy <search_terms>
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Create a lmgtfy link.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``<search_terms>``: The terms used to generate the lmgtfy link.
|
||||||
|
|
||||||
|
.. _general-command-roll:
|
||||||
|
|
||||||
|
^^^^
|
||||||
|
roll
|
||||||
|
^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]roll [number=100]
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Roll a random number. The result will be between 1 and ``<number>``.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``[number]``: The maximum number that can be rolled. Defaults to 100.
|
||||||
|
|
||||||
|
.. _general-command-rps:
|
||||||
|
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
rps (Rock Paper Scissors)
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]rps <your_choice>
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Play Rock Paper Scissors.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``<your_choice>``: The choice that you choose.
|
||||||
|
|
||||||
|
.. note:: Choices **must** be between ``rock``, ``paper``, or ``scissors``.
|
||||||
|
|
||||||
|
.. _general-commands-serverinfo:
|
||||||
|
|
||||||
|
^^^^^^^^^^
|
||||||
|
serverinfo
|
||||||
|
^^^^^^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]serverinfo [details=False]
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Show server information.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``[details]``: Show extra details about the server when set to True. Defaults to False.
|
||||||
|
|
||||||
|
.. _general-commands-stopwatch:
|
||||||
|
|
||||||
|
^^^^^^^^^
|
||||||
|
stopwatch
|
||||||
|
^^^^^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]stopwatch
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Start or stop the stopwatch.
|
||||||
|
|
||||||
|
.. _general-commands-urban:
|
||||||
|
|
||||||
|
^^^^^
|
||||||
|
urban
|
||||||
|
^^^^^
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
.. code-block:: none
|
||||||
|
|
||||||
|
[p]urban <word>
|
||||||
|
|
||||||
|
**Description**
|
||||||
|
|
||||||
|
Search the Urban Dictionary.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
* ``<word>``: The term to search for.
|
||||||
@ -41,6 +41,7 @@ Welcome to Red - Discord Bot's documentation!
|
|||||||
cog_guides/downloader
|
cog_guides/downloader
|
||||||
cog_guides/economy
|
cog_guides/economy
|
||||||
cog_guides/filter
|
cog_guides/filter
|
||||||
|
cog_guides/general
|
||||||
cog_guides/streams
|
cog_guides/streams
|
||||||
cog_guides/trivia
|
cog_guides/trivia
|
||||||
red_core_data_statement
|
red_core_data_statement
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user