Skip to content

Commit

Permalink
updates docs from .md to .rst
Browse files Browse the repository at this point in the history
  • Loading branch information
otothea committed Jan 26, 2020
1 parent 78edabc commit f1d221f
Show file tree
Hide file tree
Showing 213 changed files with 2,418 additions and 2,073 deletions.
13 changes: 6 additions & 7 deletions docs/commands/amazon.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
!amazon
=======
Search Amazon products. Returns top 10 results in Discord and top result in Twitch, Mixer, & Youtube

Search Amazon products. Returns top 10 results in Discord and top result in Twitch, Mixer, & YouTube.

Usage
-----
!amazon `<search>`
!amazon ``<search>``

Example
-------
::
::

!amazon dr. seuss
!amazon dr. seuss

Searches amazon for "dr. seuss" and returns top result(s)
Searches amazon for ``dr. seuss`` and returns top result(s)

.. note::

Expand Down
45 changes: 17 additions & 28 deletions docs/commands/bridge.rst
Original file line number Diff line number Diff line change
@@ -1,65 +1,54 @@
!bridge (Discord only)
======================

A Discord bridge is a way to send messages between multiple Discord servers running Botisimo. The `!bridge` command is used to create/join/leave/delete Discord bridges via chat.

* `delete` - Delete or leave a bridge `view docs <#delete>`_
* `join` - Join a bridge `view docs <#join>`_
* `new` - Create a new bridge to host `view docs <#new>`_
- ``delete`` - Delete or leave a bridge `view docs <#delete>`_
- ``join`` - Join a bridge `view docs <#join>`_
- ``new`` - Create a new bridge to host `view docs <#new>`_

.. note::

If a command argument is required it will be wrapped in `< >` and if the argument is optional it will be wrapped in `[ ]`.
If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.

delete
^^^^^^
Delete a bridge

Usage
-----
!bridge delete
!bridge delete

Example
-------
::

!bridge delete
Delete the entire bridge if you are the host. Disconnect from the bridge if you are not the host::

Deletes the entire bridge if you are the host. Disconnects from the bridge if you are not the host.
!bridge delete

`!bridge delete` -> `Bridge deleted`
``!bridge delete`` -> ``Bridge deleted``

join
^^^^
Join a bridge using a token

Usage
-----
!bridge `<token>`
!bridge ``<token>``

Example
-------
::
Join the bridge with token ``ggh4jd7f``::

!bridge ggh4jd7f
!bridge ggh4jd7f

Joins the bridge with token `ggh4jd7f`

`!bridge ggh4jd7f` -> `You have been connected to the bridge`
``!bridge ggh4jd7f`` -> ``You have been connected to the bridge``

new
^^^
Create a new bridge

Usage
-----
!bridge
!bridge

Example
-------
::

!bridge
Create a new bridge and get a token for other channels to join the bridge::

Creates a new bridge and returns a token for other channels to join the bridge
!bridge

`!bridge` -> `This channel is now hosting a bridge. Add other channels to this bridge by typing '!bridge ggh4jd7f' in those channels.`
``!bridge`` -> ``This channel is now hosting a bridge. Add other channels to this bridge by typing '!bridge ggh4jd7f' in those channels.``
12 changes: 5 additions & 7 deletions docs/commands/buy.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
!buy
====
Purchase an item from the shop using currency

Purchase an item from the shop using currency.

Usage
-----
!buy `<key>`
!buy ``<key>``

Example
-------
::
Purchase item 1 from the shop using currency::

!buy 1
!buy 1

Purchase item 1 from the shop using currency
13 changes: 5 additions & 8 deletions docs/commands/clear.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
!clear (Discord only)
=====================
Clear a number of messages from the chat (max: 99)

Clear a number of messages from the chat (max: 99).

Usage
-----
!clear `<number>`
!clear ``<number>``

Example
-------
::

!clear 50
Remove last 50 messages from chat::

Remove last 50 messages from chat
!clear 50
13 changes: 5 additions & 8 deletions docs/commands/clip.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
!clip
=====
Responds with the top Twitch clip for the current user or the `username` (must be a twitch username)

Responds with the top Twitch clip for the current user or the ``username`` (must be a Twitch username).

Usage
-----
!clip `[username]`
!clip ``[username]``

Example
-------
::

!clip botisimo
Gets the URL to the top clip for Twitch user "botisimo"::

Gets the URL to the top clip for Twitch user "botisimo"
!clip botisimo
103 changes: 0 additions & 103 deletions docs/commands/command.md

This file was deleted.

117 changes: 117 additions & 0 deletions docs/commands/command.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
!command
========

The ``!command`` command is used to create/edit/delete/enable/disable `custom commands <https://botisimo.com/account/commands>`_ via chat.

- ``delete`` - Delete command `view docs <#delete>`_
- ``disable`` - Disable command `view docs <#disable>`_
- ``edit`` - Edit command response `view docs <#edit>`_
- ``enable`` - Enable command `view docs <#enable>`_
- ``info`` - View command info `view docs <#info>`_
- ``list`` - List commands `view docs <#list>`_
- ``new`` - Create a new command `view docs <#new>`_
- ``permission`` - Edit command minimum permission `view docs <#permission>`_

.. note::

If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.

.. note::

Commands are enabled and disabled based on the platform (Twitch, Mixer, YouTube, etc.) the command was issued from. Commands will respond to the channel they are called from.

delete
^^^^^^
Delete command

Usage
!command delete ``<name>``

Example
Delete the command named ``!social``::

!command delete !social

disable
^^^^^^^
Disable command

Usage
!command disable ``<name>``

Example
Disable the command named ``social`` but does not delete it::

!command disable !social

edit
^^^^
Edit command response

Usage
!command edit ``<name>`` ``<response>``

Example
Edit the command named ``!social`` to respond with ``You can follow me on twitter and instagram @botisimo``::

!command edit !social You can follow me on twitter and instagram @botisimo

enable
^^^^^^
Enable command

Usage
!command enable ``<name>``

Example
Enable the command named ``social``::

!command enable !social

info
^^^^
Get info for a command

Usage
!command info ``<name>``

Example
Output the details for the ``!social`` command::

!command info !social

list
^^^^
List commands

Usage
!command list

Example
List commands available in Botisimo::

!command list

new
^^^
Create a new command

Usage
!command new ``<name>`` ``<response>``

Example
Create a new command named ``!social`` that responds with ``You can follow me on twitter @botisimo``::

!command new !social You can follow me on twitter @botisimo

permission
^^^^^^^^^^
Edit command minimum permission

Usage
!command permission ``<name>`` ``<permission=everyone|regs|subs|mods|admin>``

Example
Edit the minimum permission for the command named ``!social`` to allow ``everyone`` to use it::

!command permission !social everyone

0 comments on commit f1d221f

Please sign in to comment.