``textual`` commands
====================

.. csv-table::
  :widths: auto

  "**Plugin**", :class:`~shellbot.plugins.textual.Textual`
  "**Brief**", "Textual commands."


`announce <../plugins/textual.html#shellbot.plugins.textual.Textual.announce>`_
-------------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Send a channel announce on a specific channel."
  "**Usage**", ``announce [destination] content``

.. code-block:: text

        positional arguments:
          destination  a channel @mention describing the target channel
          content      the content to send


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``announce Hi!``","Send ""Hi!"" on the default server channel."
    "``announce #general Hi!``","Send ""Hi!"" on the channel named <general>."

Details
~~~~~~~

Content with single quotation mark need to be quoted with double quotes.

`goodbye <../plugins/textual.html#shellbot.plugins.textual.Textual.goodbye>`_
-----------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Define the Goodbye message."
  "**Usage**", ``goodbye [+x | -x] [-r] [message]``

.. code-block:: text

        positional arguments:
          message      the Goodbye message

        optional arguments:
          +x           enable Goodbye messages
          -x           disable Goodbye messages
          --reset, -r  reset the Goodbye message to the default one


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``goodbye``","Shows the current Goodbye message."

Details
~~~~~~~

**Default welcome message**

``Goodbye $NAME``.

+--------------+-----------------------------------------------+
| Placeholder  | Description                                   |
+==============+===============================================+
| ``$NAME``    | The name of the user that just joined         |
+--------------+-----------------------------------------------+
| ``$SERVER``  | The server's name                             |
+--------------+-----------------------------------------------+


`say <../plugins/textual.html#shellbot.plugins.textual.Textual.say>`_
---------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Send a bot message on the current channel."
  "**Usage**", ``say content``

.. code-block:: text

        positional arguments:
          content  the content to send


Details
~~~~~~~

Content with single quotation mark need to be quoted with double quotes.

`welcome <../plugins/textual.html#shellbot.plugins.textual.Textual.welcome>`_
-----------------------------------------------------------------------------

.. csv-table::
  :widths: auto

  "**Aliases**", "No alias"
  "**Brief**", "Define the Welcome message."
  "**Usage**", ``welcome [+x | -x] [-r] [message]``

.. code-block:: text

        positional arguments:
          message      the Welcome message

        optional arguments:
          +x           enable Welcome messages
          -x           disable Welcome messages
          --reset, -r  reset the Welcome message to the default one


Examples
~~~~~~~~

.. csv-table::
    :widths: auto

    "``welcome``","Show the current Welcome message."

Details
~~~~~~~

**Default welcome message**

``Hi $MENTION! Welcome on $SERVER, may you enjoy your stay``

+--------------+-----------------------------------------------+
| Placeholder  | Description                                   |
+==============+===============================================+
| ``$NAME``    | The name of the user that just joined         |
+--------------+-----------------------------------------------+
| ``$MENTION`` | A mention to the user that just joined        |
+--------------+-----------------------------------------------+
| ``$SERVER``  | The server's name                             |
+--------------+-----------------------------------------------+