Skip to content

Commit

Permalink
update cooldown/hours/discord/event directive options
Browse files Browse the repository at this point in the history
  • Loading branch information
otothea committed Feb 14, 2020
1 parent e3f267e commit 1670577
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 12 deletions.
31 changes: 30 additions & 1 deletion docs/directives/cooldown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,43 @@ Usage:
Arguments:
* ``seconds`` **<required>** - Number of seconds it should wait to cooldown

Options:
* ``-p, --public`` **[optional]** - If present then error message will be sent to public chat (instead of direct message)
* ``-s, --silent`` **[optional]** - If present then no error message will be sent
* ``-g, --global`` **[optional]** - If present then cooldown will apply to any user who tries to use the command
* ``--error-message <message>`` **[optional]** - URL encoded error message

Example Command:
**name**: !cool

**response**: $[cooldown 30] This response will be sent only if 30 seconds has passed
**response**: $[cooldown 30 \\--public] This response will be sent only if 30 seconds has passed

**output**::

user: !cool
botisimo: This response will be sent only if 30 seconds has passed
user: !cool
botisimo: You must wait 30 seconds between !cool commands

Example Command:
**name**: !cool

**response**: $[cooldown 30 \\--silent] This response will be sent only if 30 seconds has passed

**output**::

user: !cool
botisimo: This response will be sent only if 30 seconds has passed
user: !cool

Example Command:
**name**: !cool

**response**: $[cooldown 30 \\--error-message $(urlencode Cool it dude, you gotta wait 30 seconds to use this command again)] This response will be sent only if 30 seconds has passed

**output**::

user: !cool
botisimo: This response will be sent only if 30 seconds has passed
user: !cool
botisimo: Cool it dude, you gotta wait 30 seconds to use this command again
11 changes: 8 additions & 3 deletions docs/directives/discord.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Usage:
$[discord role add ``<role>`` ``[user]``]

Arguments:
* ``role`` **<required>** - URL encoded role name (ex: ``$(urlencode My Awesome Role)``)
* ``role`` **<required>** - URL encoded role name
* ``user`` **[optional]** - Discord user to add the role to

Example Command:
Expand All @@ -29,7 +29,12 @@ Usage:
$[discord role check ``<role>``]

Arguments:
* ``role`` **<required>** - URL encoded role name (ex: ``$(urlencode My Awesome Role)``)
* ``role`` **<required>** - URL encoded role name

Options:
* ``-p, --public`` **[optional]** - If present then error message will be sent to public chat (instead of direct message)
* ``-s, --silent`` **[optional]** - If present then no error message will be sent
* ``--error-message <message>`` **[optional]** - URL encoded error message

Example Command:
**name**: !expelliarmus
Expand All @@ -50,7 +55,7 @@ Usage:
$[discord role remove ``<role>`` ``[user]``]

Arguments:
* ``role`` **<required>** - URL encoded role name (ex: ``$(urlencode My Awesome Role)``)
* ``role`` **<required>** - URL encoded role name
* ``user`` **[optional]** - Discord user to remove the role from

Example Command:
Expand Down
16 changes: 8 additions & 8 deletions docs/directives/event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ $[event]
Sends a custom event to the `events overlay <https://botisimo.com/account/overlays>`_.

Usage:
$[event ``[text]`` | ``[subtext]`` | ``[milliseconds=3000]`` | ``[thumbnail]`` | ``[sound]``]
$[event]

Arguments:
* ``text`` **[optional]** - The main text to display for the event
* ``subtext`` **[optional]** - The secondary text to display for the event
* ``milliseconds`` **[optional]** - How long to display the event (3 seconds = 3000 milliseconds)
* ``thumbnail`` **[optional]** - The URL to the image to display for the event
* ``sound`` **[optional]** - The URL to the audio to play for the event
Options:
* ``-t, --text <text>`` **[optional]** - URL encoded primary text for the event
* ``-s, --secondary-text <text>`` **[optional]** - URL encoded secondary text for the event
* ``-d, --duration <milliseconds>`` **[optional]** - Duration in milliseconds to display event
* ``-i, --image <url>`` **[optional]** - URL for image to display for event
* ``-a, --audio <url>`` **[optional]** - URL to audio to play for event

Example Command:
**name**: !event

**response**: $[event This is the text | This is the subtext | 5000 | https://media2.giphy.com/media/KXtq8oYQrYMIF9Esi7/giphy.gif | http://soundbible.com/grab.php?id=1817&type=mp3] event sent
**response**: $[event -t $(urlencode This is the primary text) -s $(urlencode This is the secondary text) -d 5000 -i https://media2.giphy.com/media/KXtq8oYQrYMIF9Esi7/giphy.gif -a http://soundbible.com/grab.php?id=1817&type=mp3] event sent

**output**::

Expand Down
17 changes: 17 additions & 0 deletions docs/directives/hours.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Usage:
Arguments:
* ``hours`` **<required>** - The number of hours to require the user to have

Options:
* ``-p, --public`` **[optional]** - If present then error message will be sent to public chat (instead of direct message)
* ``-s, --silent`` **[optional]** - If present then no error message will be sent
* ``--error-message <message>`` **[optional]** - URL encoded error message

Example Command:
**name**: !special

Expand All @@ -20,3 +25,15 @@ Example Command:
botisimo: This response will be sent only if the user has watched the stream for 10 hours
newbie: !special
botisimo: You must watch the stream for 10 hours to unlock the !special command

Example Command:
**name**: !special

**response**: $[hours 1 \\--error-message $(urlencode Please enjoy the show a little longer before gaining access to this command)] This response will be sent only if the user has watched the stream for 10 hours

**output**::

user: !special
botisimo: This response will be sent only if the user has watched the stream for 1 hours
newbie: !special
botisimo: Please enjoy the show a little longer before gaining access to this command

0 comments on commit 1670577

Please sign in to comment.