-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
213 changed files
with
2,418 additions
and
2,073 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Oops, something went wrong.