update directive arguments

botisimo · Feb 11, 2020 · a0c32de · a0c32de
1 parent 8faddbc
commit a0c32de
Show file tree

Hide file tree

Showing 57 changed files with 232 additions and 14 deletions.
diff --git a/docs/commands/amazon.rst b/docs/commands/amazon.rst
@@ -1,6 +1,8 @@
 !amazon
 =======
 
+**Default Permission:** Everyone
+
 Search Amazon products. Returns top 10 results in Discord and top result in Twitch, Mixer, & YouTube.
 
 Usage:

diff --git a/docs/commands/bridge.rst b/docs/commands/bridge.rst
@@ -1,6 +1,8 @@
 !bridge (Discord only)
 ======================
 
+**Default Permission:** Moderator
+
 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`__

diff --git a/docs/commands/buy.rst b/docs/commands/buy.rst
@@ -1,6 +1,8 @@
 !buy
 ====
 
+**Default Permission:** Everyone
+
 Purchase an item from the shop using currency.
 
 Usage:

diff --git a/docs/commands/clear.rst b/docs/commands/clear.rst
@@ -1,6 +1,8 @@
 !clear (Discord only)
 =====================
 
+**Default Permission:** Moderator
+
 Clear a number of messages from the chat (max: 99).
 
 Usage:

diff --git a/docs/commands/clip.rst b/docs/commands/clip.rst
@@ -1,6 +1,8 @@
 !clip
 =====
 
+**Default Permission:** Everyone
+
 Responds with the top Twitch clip for the current user or the ``username`` (must be a Twitch username).
 
 Usage:

diff --git a/docs/commands/command.rst b/docs/commands/command.rst
@@ -1,6 +1,8 @@
 !command
 ========
 
+**Default Permission:** Moderator
+
 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`__

diff --git a/docs/commands/commands.rst b/docs/commands/commands.rst
@@ -1,6 +1,8 @@
 !commands
 =========
 
+**Default Permission:** Everyone
+
 Receive list of custom commands available to you via whisper.
 
 Usage:

diff --git a/docs/commands/currency.rst b/docs/commands/currency.rst
@@ -0,0 +1,15 @@
+!currency
+=========
+
+**Default Permission:** Everyone
+
+Receive a DM telling your how much currency you have
+
+Usage:
+    !currency
+
+Example:
+    ::
+
+        user:     !currency
+        botisimo: Currency: 850
diff --git a/docs/commands/enter.rst b/docs/commands/enter.rst
@@ -1,6 +1,8 @@
 !enter
 ======
 
+**Default Permission:** Everyone
+
 The ``!enter`` command is used to enter `giveaways <https://botisimo.com/account/giveaways>`_ via chat.
 
 Usage:

diff --git a/docs/commands/game.rst b/docs/commands/game.rst
@@ -1,6 +1,8 @@
 !game
 =====
 
+**Default Permission:** Moderator
+
 Get or set the game for the stream.
 
 Usage:

diff --git a/docs/commands/gameall.rst b/docs/commands/gameall.rst
@@ -1,6 +1,8 @@
 !gameall
 ========
 
+**Default Permission:** Moderator
+
 Set the game on all connections on the account.
 
 Usage:

diff --git a/docs/commands/give.rst b/docs/commands/give.rst
@@ -1,6 +1,8 @@
 !give
 =====
 
+**Default Permission:** Moderator
+
 Give to users by username
 
 Usage:

diff --git a/docs/commands/giveaway.rst b/docs/commands/giveaway.rst
@@ -1,6 +1,8 @@
 !giveaway
 =========
 
+**Default Permission:** Moderator
+
 The ``!giveaway`` command is used to create/view/close/end `giveaways <https://botisimo.com/account/giveaways>`_ via chat.
 
     - ``close`` - Close entry for the current giveaway `view docs`__

diff --git a/docs/commands/help.rst b/docs/commands/help.rst
@@ -1,6 +1,8 @@
 !help
 =====
 
+**Default Permission:** Everyone
+
 Link to Botisimo docs.
 
 Usage:

diff --git a/docs/commands/index.rst b/docs/commands/index.rst
@@ -22,6 +22,7 @@ Commands are used to allow you and your moderators/users to interact with the bo
    clip
    command
    commands
+   currency
    enter
    game
    gameall
@@ -33,9 +34,11 @@ Commands are used to allow you and your moderators/users to interact with the bo
    leave
    link
    live
+   music
    nextsong
    optin
    optout
+   permit
    ping
    poll
    prefix

diff --git a/docs/commands/irregular.rst b/docs/commands/irregular.rst
@@ -1,6 +1,8 @@
 !irregular
 ==========
 
+**Default Permission:** Moderator
+
 Remove user from regulars.
 
 Usage:

diff --git a/docs/commands/leaderboard.rst b/docs/commands/leaderboard.rst
@@ -1,6 +1,8 @@
 !leaderboard
 ============
 
+**Default Permission:** Everyone
+
 Display link to the leaderboard.
 
 Usage:

diff --git a/docs/commands/leave.rst b/docs/commands/leave.rst
@@ -1,6 +1,8 @@
 !leave
 ======
 
+**Default Permission:** Admin
+
 Disable Botisimo for your channel (can be reenabled on the `connections page <https://botisimo.com/account/connections>`_ of your account).
 
 Usage:

diff --git a/docs/commands/link.rst b/docs/commands/link.rst
@@ -1,6 +1,8 @@
 !link
 =====
 
+**Default Permission:** Everyone
+
 The ``!link`` command is used to link users from different platforms together to share currency and XP. Each group of linked users can have 1 user from each platform linked (Twitch, Mixer, YouTube, and Discord). You must have login access to the user account on each platform to be able to link them.
 
     - `Link Users`_

diff --git a/docs/commands/live.rst b/docs/commands/live.rst
@@ -1,6 +1,8 @@
 !live
 =====
 
+**Default Permission:** Moderator
+
 Force a stream up announcement in Discord (useful in case the automatic announcement fails).
 
 Usage:

diff --git a/docs/commands/login.rst b/docs/commands/login.rst
@@ -3,6 +3,8 @@
 !login (Discord only)
 =====================
 
+**Default Permission:** Everyone
+
 Receive a link to authorize chat mirroring for your Discord user (platform can be ``twitch`` or ``mixer``).
 
 Usage:

diff --git a/docs/commands/logout.rst b/docs/commands/logout.rst
@@ -3,6 +3,8 @@
 !logout (Discord only)
 ======================
 
+**Default Permission:** Everyone
+
 Disable chat mirroring for your Discord user (platform can be ``twitch`` or ``mixer``).
 
 Usage:

diff --git a/docs/commands/music.rst b/docs/commands/music.rst
@@ -0,0 +1,53 @@
+!music
+======
+
+**Default Permission:** Moderator
+
+The ``!music`` command is used to manage the `music player <https://botisimo.com/account/music>`_ via chat.
+
+    - ``next`` - Skip to the next song `view docs`__
+    - ``play`` - Enable music player `view docs`__
+    - ``stop`` - Disable music player `view docs`__
+
+__ #next
+__ #play
+__ #stop
+
+next
+^^^^
+Skip to the next song
+
+Usage:
+    !music next
+
+Example:
+    ::
+
+        user:     !music next
+        botisimo: Song skipped
+
+play
+^^^^
+Start the music player
+
+Usage:
+    !music play
+
+Example:
+    ::
+
+        user:     !music play
+        botisimo: Music player started
+
+stop
+^^^^
+Stop the music player
+
+Usage:
+    !music stop
+
+Example:
+    ::
+
+        user:     !music stop
+        botisimo: Music player stopped
diff --git a/docs/commands/nextsong.rst b/docs/commands/nextsong.rst
@@ -1,6 +1,8 @@
 !nextsong
 =========
 
+**Default Permission:** Moderator
+
 Skip the current song (works with the `music player <https://botisimo.com/account/music>`_).
 
 Usage:

diff --git a/docs/commands/optin.rst b/docs/commands/optin.rst
@@ -1,6 +1,8 @@
 !optin
 ======
 
+**Default Permission:** Everyone
+
 Opt in to Level Up and DyneOps announcements for your user.
 
 Usage:

diff --git a/docs/commands/optout.rst b/docs/commands/optout.rst
@@ -1,6 +1,8 @@
 !optout
 =======
 
+**Default Permission:** Everyone
+
 Opt out of Level Up and DyneOps announcements for your user.
 
 Usage:

diff --git a/docs/commands/permit.rst b/docs/commands/permit.rst
@@ -0,0 +1,15 @@
+!permit
+=======
+
+**Default Permission:** Moderator
+
+Permit a user to bypass the whitelist domain spam filter for 1 minute.
+
+Usage:
+    !permit ``<username>``
+
+Example:
+    ::
+
+        user:     !permit @bob
+        botisimo: @bob has been permitted to send links for 1 minute
diff --git a/docs/commands/ping.rst b/docs/commands/ping.rst
@@ -1,6 +1,8 @@
 !ping
 =====
 
+**Default Permission:** Moderator
+
 Responds with ``pong`` in chat (quick way to check if Botisimo is responding in your channel).
 
 Usage:

diff --git a/docs/commands/playlists.rst b/docs/commands/playlists.rst
@@ -3,6 +3,8 @@
 !playlists (Discord only)
 =========================
 
+**Default Permission:** Everyone
+
 List Youtube playlists from connected account (must have `connected YouTube channel <https://botisimo.com/account/connections>`_).
 
 Usage:

diff --git a/docs/commands/poll.rst b/docs/commands/poll.rst
@@ -1,6 +1,8 @@
 !poll
 =====
 
+**Default Permission:** Moderator
+
 The ``!poll`` command is used to create/view/close/end `polls <https://botisimo.com/account/polls>`_ via chat.
 
     - ``close`` - Close voting for a poll `view docs`__

diff --git a/docs/commands/prefix.rst b/docs/commands/prefix.rst
@@ -1,6 +1,8 @@
 !prefix
 =======
 
+**Default Permission:** Admin
+
 Get or set the Botisimo command prefix (only affects Botisimo's built-in commands).
 
 Usage:

diff --git a/docs/commands/queue.rst b/docs/commands/queue.rst
@@ -1,5 +1,8 @@
 !queue
 ======
+
+**Default Permission:** Moderator
+
 The ``!queue`` command is used to join/leave/list users in the queue via chat
 
     - ``clear`` - Clear the queue `view docs`__

diff --git a/docs/commands/rank.rst b/docs/commands/rank.rst
@@ -1,6 +1,8 @@
 !rank
 =====
 
+**Default Permission:** Everyone
+
 Display rank information for the current user or the ``username``.
 
 Usage:

diff --git a/docs/commands/reddit.rst b/docs/commands/reddit.rst
@@ -1,6 +1,8 @@
 !reddit
 =======
 
+**Default Permission:** Everyone
+
 Get the latest post(s) for a subreddit. Returns top 10 results in Discord and top result in Twitch & Mixer.
 
 Usage:

diff --git a/docs/commands/regular.rst b/docs/commands/regular.rst
@@ -1,6 +1,8 @@
 !regular
 ========
 
+**Default Permission:** Moderator
+
 Add this user to regulars.
 
 Usage:

diff --git a/docs/commands/shop.rst b/docs/commands/shop.rst
@@ -1,6 +1,8 @@
 !shop
 =====
 
+**Default Permission:** Everyone
+
 Display available shop items for channel in chat.
 
 Usage: