update docs

botisimo · Jan 26, 2020 · b6ab2d6 · b6ab2d6
1 parent 415a63b
commit b6ab2d6
Show file tree

Hide file tree

Showing 112 changed files with 1,133 additions and 914 deletions.
diff --git a/docs/commands.md b/docs/commands.md
@@ -5,76 +5,6 @@ Below is a list of the default commands available with Botisimo. They are groupe
 
 **NOTE:** If users are **NOT** receiving whispers from Botisimo in Twitch, they may need to send it a whisper first to get it working for their account.
 
-## Public Commands
-
-#### All platforms
-
-  - `!amazon <query>` - Search Amazon products*. Returns top 10 results in Discord and top result in Twitch, Mixer, & Youtube
-  - `!buy <key>` - Purchase an item from the shop using currency
-  - `!clip [username]` - Responds with the top Twitch clip for the current user or the `username` (must be a twitch username)
-  - `!commands` - Receive list of custom commands available to you via whisper
-  - `!enter` - Enter the giveaway [view docs](</enter>)
-  - `!help` - Link to Botisimo docs
-  - `!leaderboard` - Display link to the leaderboard
-  - `!optin` - Opt in to Level Up and DyneOps announcements for your user
-  - `!optout` - Opt out of Level Up and DyneOps announcements for your user
-  - `!queue` - Join or leave player queue [view docs](</queue>)
-  - `!rank [username]` - Display rank information for the current user or the `username`
-  - `!reddit <subreddit>` - Get the latest post(s) for a subreddit. Returns top 10 results in Discord and top result in Twitch & Mixer
-  - `!shop` - Display available shop items for channel in chat
-  - `!songrequest <youtube_video_url>` or `!sr <youtube_video_url>` - Request a song (works with the [music player](https://botisimo.com/account/music))
-  - `!stackoverflow <query>` - Search Stackoverflow questions. Returns top 10 results in Discord and top result in Twitch & Mixer
-  - `!twit <username>` or `!twitter <username>` - Responds with the latest tweet from the given `username` (must be a twitter username)
-  - `!vote` - Vote in poll [view docs](</vote>)
-  - `!wikipedia <topic>` or `!wiki <topic>` - Search Wikipedia topics. Returns top 10 results in Discord and top result in Twitch & Mixer
-
-#### Twitch, Mixer, & Youtube only
-
-  - `!live` - Force a stream up announcement in Discord (useful in case the automatic announcement fails)
-  - `!uptime` - Display time the stream started in chat
-
-#### Discord only
-
   - `!login [platform=twitch]` - Receive a link to authorize chat mirroring for your Discord user (platform can be `twitch` or `mixer`)
   - `!logout [platform=twitch]` - Disable chat mirroring for your Discord user (platform can be `twitch` or `mixer`)
   - `!playlists` - List Youtube playlists from connected account (must have [linked youtube account](https://botisimo.com/account/connections))
-
-## Mod Commands
-
-#### All platforms
-
-  - `!command` - Manage custom commands [view docs](</command>)
-  - `!gameall <game>` - Set the game on all connections on the account
-  - `!give <amount> <username> [username] [username] ...` - Give currency to 1 or more users
-  - `!give <amount> all` - Give currency to everyone
-  - `!give <amount> chat` - Give currency to everyone currently in chat
-  - `!giveaway` - Manage giveaways [view docs](</giveaway>)
-  - `!irregular <username>` - Remove this user from regulars
-  - `!nextsong` or `!ns` - Skip the current song (works with the [music player](https://botisimo.com/account/music))
-  - `!ping` - Responds with `pong` in chat (quick way to check if Botisimo is responding in your channel)
-  - `!poll` - Manage polls [view docs](</poll>)
-  - `!regular <username>` - Add this user to regulars
-  - `!timer` - Manage custom timers [view docs](</timer>)
-  - `!titleall <title>` - Set the title on all connections on the account
-  - `!winner [message] [|minutes]` - Pick a random winner from chat who sent a message in last 10 minutes. Optionally, use the `message` to filter users who typed a specific message (default: any message). You can also alter the minutes by using the `|` character followed by a number (example: `!winner enter|30`)
-
-#### Twitch, Mixer, & YouTube only
-
-  - `!game [game=]` - Get or set the game for the stream
-  - `!title [title=]` - Get or set the title for the stream
-
-#### Discord only
-
-  - `!bridge` - Manage Discord bridges [view docs](</bridge>)
-  - `!clear <number>` - Clear a number of messages from the chat (max: 99)
-  - `!subscribe <platform> <username>` - Subscribe to other Botisimo users' stream up announcements (platform should be `twitch` or `mixer`)
-  - `!unsubscribe <platform> <username>` - Unsubscribe from other Botisimo users' stream up announcements (platform should be `twitch` or `mixer`)
-
-## Admin Commands
-
-#### All platforms
-
-  - `!leave` - Disable Botisimo for your channel (can be reenabled on the [connections page](https://botisimo.com/account/connections) of your account)
-  - `!prefix [prefix=]` - Get or set the Botisimo command prefix (only affects Botisimo's built-in commands)
-
-###### * We are a participant in the Amazon Services LLC Associates Program, an affiliate advertising program designed to provide a means for us to earn fees by linking to Amazon.com and affiliated sites.
diff --git a/docs/commands/amazon.md b/docs/commands/amazon.md
@@ -0,0 +1,12 @@
+# !amazon
+Search Amazon products*. Returns top 10 results in Discord and top result in Twitch, Mixer, & Youtube
+
+#### Usage
+!amazon `<search>`
+
+#### Example
+    !amazon dr. seuss
+
+Searches amazon for "dr. seuss" and returns top result(s)
+
+###### * We are a participant in the Amazon Services LLC Associates Program, an affiliate advertising program designed to provide a means for us to earn fees by linking to Amazon.com and affiliated sites.
diff --git a/docs/bridge.md → docs/commands/bridge.md b/docs/bridge.md → docs/commands/bridge.md
diff --git a/docs/commands/buy.md b/docs/commands/buy.md
@@ -0,0 +1,10 @@
+# !buy
+Purchase an item from the shop using currency
+
+#### Usage
+!buy `<key>`
+
+#### Example
+    !buy 1
+
+Purchase item 1 from the shop using currency
diff --git a/docs/commands/clear.md b/docs/commands/clear.md
@@ -0,0 +1,10 @@
+# !clear (Discord only)
+Clear a number of messages from the chat (max: 99)
+
+#### Usage
+!clear `<number>`
+
+#### Example
+    !clear 50
+
+Remove last 50 messages from chat
diff --git a/docs/commands/clip.md b/docs/commands/clip.md
@@ -0,0 +1,10 @@
+# !clip
+Responds with the top Twitch clip for the current user or the `username` (must be a twitch username)
+
+#### Usage
+!clip `[username]`
+
+#### Example
+    !clip botisimo
+
+Gets the URL to the top clip for Twitch user "botisimo"
diff --git a/docs/command.md → docs/commands/command.md b/docs/command.md → docs/commands/command.md
diff --git a/docs/commands/commands.md b/docs/commands/commands.md
@@ -0,0 +1,8 @@
+# !commands
+Receive list of custom commands available to you via whisper
+
+#### Usage
+!commands
+
+#### Example
+    !commands
diff --git a/docs/enter.md → docs/commands/enter.md b/docs/enter.md → docs/commands/enter.md
diff --git a/docs/commands/game.md b/docs/commands/game.md
@@ -0,0 +1,10 @@
+# !game
+Get or set the game for the stream
+
+#### Usage
+!game `[game]`
+
+#### Example
+    !game Pickle Wars
+
+Sets the game to "Pickle Wars"
diff --git a/docs/commands/gameall.md b/docs/commands/gameall.md
@@ -0,0 +1,10 @@
+# !gameall
+Set the game on all connections on the account
+
+#### Usage
+!gameall `<game>`
+
+#### Example
+    !gameall Pickle Wars
+
+Sets the game to "Pickle Wars"
diff --git a/docs/commands/give.md b/docs/commands/give.md
@@ -0,0 +1,24 @@
+# !give
+Give currency to 1 or more users
+
+#### Usage
+!give `<amount>` `<username>` `[username]` `[username]` ...
+
+#### Example
+    !give 500 @username1 @username2
+
+Give currency to everyone
+
+#### Usage
+!give `<amount>` all
+
+#### Example
+    !give 500 all
+
+Give currency to everyone currently in chat
+
+#### Usage
+!give `<amount>` chat
+
+#### Example
+    !give 500 chat
diff --git a/docs/giveaway.md → docs/commands/giveaway.md b/docs/giveaway.md → docs/commands/giveaway.md
diff --git a/docs/commands/help.md b/docs/commands/help.md
@@ -0,0 +1,8 @@
+# !help
+Link to Botisimo docs
+
+#### Usage
+!help
+
+#### Example
+    !help
diff --git a/docs/commands/irregular.md b/docs/commands/irregular.md
@@ -0,0 +1,10 @@
+# !irregular
+Remove this user from regulars
+
+#### Usage
+!irregular `<username>`
+
+#### Example
+    !irregular botismo
+
+Removes user "botisimo" from the regulars
diff --git a/docs/commands/leaderboard.md b/docs/commands/leaderboard.md
@@ -0,0 +1,8 @@
+# !leaderboard
+Display link to the leaderboard
+
+#### Usage
+!leaderboard
+
+#### Example
+    !leaderboard
diff --git a/docs/commands/leave.md b/docs/commands/leave.md
@@ -0,0 +1,8 @@
+# !leave
+Disable Botisimo for your channel (can be reenabled on the [connections page](https://botisimo.com/account/connections) of your account)
+
+#### Usage
+!leave
+
+#### Example
+    !leave
diff --git a/docs/link.md → docs/commands/link.md b/docs/link.md → docs/commands/link.md
diff --git a/docs/commands/live.md b/docs/commands/live.md
@@ -0,0 +1,8 @@
+# !live
+Force a stream up announcement in Discord (useful in case the automatic announcement fails)
+
+#### Usage
+!live
+
+#### Example
+    !live
diff --git a/docs/commands/nextsong.md b/docs/commands/nextsong.md
@@ -0,0 +1,8 @@
+# !nextsong
+Skip the current song (works with the [music player](https://botisimo.com/account/music))
+
+#### Usage
+!nextsong
+
+#### Example
+    !nextsong
diff --git a/docs/commands/optin.md b/docs/commands/optin.md
@@ -0,0 +1,8 @@
+# !optin
+Opt in to Level Up and DyneOps announcements for your user
+
+#### Usage
+!optin
+
+#### Example
+    !optin
diff --git a/docs/commands/optout.md b/docs/commands/optout.md
@@ -0,0 +1,8 @@
+# !optout
+Opt out of Level Up and DyneOps announcements for your user
+
+#### Usage
+!optout
+
+#### Example
+    !optout
diff --git a/docs/commands/ping.md b/docs/commands/ping.md
@@ -0,0 +1,8 @@
+# !ping
+Responds with `pong` in chat (quick way to check if Botisimo is responding in your channel)
+
+#### Usage
+!ping
+
+#### Example
+    !ping
diff --git a/docs/poll.md → docs/commands/poll.md b/docs/poll.md → docs/commands/poll.md
diff --git a/docs/commands/prefix.md b/docs/commands/prefix.md
@@ -0,0 +1,10 @@
+# !prefix
+Get or set the Botisimo command prefix (only affects Botisimo's built-in commands)
+
+#### Usage
+!prefix `[prefix]`
+
+#### Example
+    !prefix !
+
+Sets the command prefix on the account to "!"
diff --git a/docs/queue.md → docs/commands/queue.md b/docs/queue.md → docs/commands/queue.md
diff --git a/docs/commands/rank.md b/docs/commands/rank.md
@@ -0,0 +1,10 @@
+# !rank
+Display rank information for the current user or the `username`
+
+#### Usage
+!rank `[username]`
+
+#### Example
+    !rank botisimo
+
+Gets rank info for user "botisimo"
diff --git a/docs/commands/reddit.md b/docs/commands/reddit.md
@@ -0,0 +1,10 @@
+# !reddit
+Get the latest post(s) for a subreddit. Returns top 10 results in Discord and top result in Twitch & Mixer
+
+#### Usage
+!reddit `<subreddit>`
+
+#### Example
+    !reddit FoodPorn
+
+Get the latest post(s) for subreddit "FoodPorn"
diff --git a/docs/commands/regular.md b/docs/commands/regular.md
@@ -0,0 +1,10 @@
+# !regular
+Add this user to regulars
+
+#### Usage
+!regular `<username>`
+
+#### Example
+    !regular botisimo
+
+Adds user "botisimo" to the regulars
diff --git a/docs/commands/shop.md b/docs/commands/shop.md
@@ -0,0 +1,8 @@
+# !shop
+Display available shop items for channel in chat
+
+#### Usage
+!shop
+
+#### Example
+    !shop
diff --git a/docs/commands/songrequest.md b/docs/commands/songrequest.md
@@ -0,0 +1,8 @@
+# !songrequest
+Request a song (works with the [music player](https://botisimo.com/account/music))
+
+#### Usage
+!songrequest `<youtube_video_url>`
+
+#### Example
+    !songrequest
diff --git a/docs/commands/stackoverflow.md b/docs/commands/stackoverflow.md
@@ -0,0 +1,8 @@
+# !stackoverflow
+Search Stackoverflow questions. Returns top 10 results in Discord and top result in Twitch & Mixer
+
+#### Usage
+!stackoverflow `<search>`
+
+#### Example
+    !stackoverflow
diff --git a/docs/commands/subscribe.md b/docs/commands/subscribe.md
@@ -0,0 +1,10 @@
+# !subscribe (Discord only)
+Subscribe to other Botisimo users' stream up announcements (platform should be `twitch` or `mixer`)
+
+#### Usage
+!subscribe `<platform>` `<username>`
+
+#### Example
+    !subscribe twitch botisimo
+
+Subscribes to stream up announcements for user "botisimo" on Twitch
diff --git a/docs/timer.md → docs/commands/timer.md b/docs/timer.md → docs/commands/timer.md
diff --git a/docs/commands/title.md b/docs/commands/title.md
@@ -0,0 +1,10 @@
+# !title
+Get or set the title for the stream
+
+#### Usage
+!title `[title]`
+
+#### Example
+    !title Streamin like a demon! Let's GOOO!!!!
+
+Sets the title to "Streamin like a demon! Let's GOOO!!!!"
diff --git a/docs/commands/titleall.md b/docs/commands/titleall.md
@@ -0,0 +1,10 @@
+# !titleall
+Set the title on all connections on the account
+
+#### Usage
+!titleall `<title>`
+
+#### Example
+    !titleall Streamin like a demon! Let's GOOO!!!!
+
+Sets the title to "Streamin like a demon! Let's GOOO!!!!"
diff --git a/docs/commands/twitter.md b/docs/commands/twitter.md
@@ -0,0 +1,10 @@
+# !twitter
+Responds with the latest tweet from the given `username` (must be a twitter username)
+
+#### Usage
+!twitter `<username>`
+
+#### Example
+    !twitter botisimo
+
+Gets the latest tweet from Twitter user "botisimo"
diff --git a/docs/commands/unsubscribe.md b/docs/commands/unsubscribe.md
@@ -0,0 +1,10 @@
+# !unsubscribe (Discord only)
+Unsubscribe from other Botisimo users' stream up announcements (platform should be `twitch` or `mixer`)
+
+#### Usage
+!unsubscribe `<platform>` `<username>`
+
+#### Example
+    !unsubscribe twitch botisimo
+
+Unsubscribes from stream up announcements for user "botisimo" on Twitch
diff --git a/docs/commands/uptime.md b/docs/commands/uptime.md
@@ -0,0 +1,8 @@
+# !uptime
+Display time the stream started in chat
+
+#### Usage
+!uptime
+
+#### Example
+    !uptime
diff --git a/docs/vote.md → docs/commands/vote.md b/docs/vote.md → docs/commands/vote.md