add docs

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/alexa.md

@@ -0,0 +1,67 @@
+# Alexa Skill
+
+Welcome to the Botisimo skill for Amazon Alexa. If you are new to Amazon Alexa you can learn more about it [on Amazon's website](https://www.amazon.com/b?node=17934671011).
+
+## Install
+
+To install the Botisimo skill for Amazon Alexa you should open the Alexa app on your device. Open the main menu and select the "Skills & Games" option. Search for "Botisimo" and install the Botisimo skill.
+
+## Account Linking
+
+The Botisimo skill for Amazon Alexa requires a linked Botisimo account to use many of the features. You can link your account by asking Alexa:
+
+```
+Alexa, ask Botisimo to link my account.
+```
+
+Alexa will respond with instructions to link your Botisimo account.
+
+## Skills
+
+You can use the Botisimo skill for Amazon Alexa to control some features within your Botisimo account.
+
+**NOTE:** It may take up to a few seconds for any [overlays](https://botisimo.com/account/overlays) to sync after using a voice command
+
+### Music Player
+
+You can control the music player using the following voice commands:
+
+```
+Alexa, ask Botisimo to start the music player.
+Alexa, ask Botisimo to stop the music player.
+Alexa, ask Botisimo to mute the music player.
+Alexa, ask Botisimo to unmute the music player.
+Alexa, ask Botisimo to skip the current song.
+```
+
+### Giveaways
+
+You can control the active giveaway using the following voice commands:
+
+```
+Alexa, ask Botisimo to read the active giveaway.
+Alexa, ask Botisimo to open the active giveaway.
+Alexa, ask Botisimo to close the active giveaway.
+Alexa, ask Botisimo to end the active giveaway.
+```
+
+### Polls
+
+You can control the active poll using the following voice commands:
+
+```
+Alexa, ask Botisimo to read the active poll.
+Alexa, ask Botisimo to open the active poll.
+Alexa, ask Botisimo to close the active poll.
+Alexa, ask Botisimo to end the active poll.
+```
+
+### Currency
+
+You can give currency to users in chat
+
+```
+Alexa, ask Botisimo to give five hundred currency to chat
+Alexa, ask Botisimo to give five hundred currency to followers
+Alexa, ask Botisimo to give one thousand currency to subscribers
+```

docs/bridge.md

@@ -0,0 +1,49 @@
+# !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)
+
+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
+
+#### Example
+    !bridge delete
+
+Deletes the entire bridge if you are the host. Disconnects from the bridge if you are not the host.
+
+`!bridge delete` -> `Bridge deleted`
+
+## join
+Join a bridge using a token
+
+#### Usage
+!bridge `<token>`
+
+#### Example
+    !bridge ggh4jd7f
+
+Joins the bridge with token `ggh4jd7f`
+
+`!bridge ggh4jd7f` -> `You have been connected to the bridge`
+
+## new
+Create a new bridge
+
+#### Usage
+!bridge
+
+#### Example
+    !bridge
+
+Creates a new bridge and returns a token for other channels to join the bridge
+
+`!bridge` -> `This channel is now hosting a bridge. Add other channels to this bridge by typing '!bridge ggh4jd7f' in those channels.`

docs/command.md

@@ -0,0 +1,103 @@
+# !command
+The `!command` command is used to create/edit/delete/enable/disable [custom commands](/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)
+
+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
+    !command delete !social
+
+Deletes the command named `!social`
+
+## disable
+Disable command
+
+#### Usage
+!command disable `<name>`
+
+#### Example
+    !command disable !social
+
+Disables the command named `social` but does not delete it
+
+## edit
+Edit command response
+
+#### Usage
+!command edit `<name>` `<response>`
+
+#### Example
+    !command edit !social You can follow me on twitter and instagram @botisimo
+
+Edits the command named `!social` to respond with `You can follow me on twitter and instagram @botisimo`
+
+## enable
+Enable command
+
+#### Usage
+!command enable `<name>`
+
+#### Example
+    !command enable !social
+
+Enables the command named `social`
+
+## info
+Get info for a command
+
+#### Usage
+!command info `<name>`
+
+#### Example
+    !command info !social
+
+Outputs the details for the `!social` command
+
+## list
+List commands
+
+#### Usage
+!command list
+
+#### Example
+    !command list
+
+Lists commands available in Botisimo
+
+## new
+Create a new command
+
+#### Usage
+!command new `<name>` `<response>`
+
+#### Example
+    !command new !social You can follow me on twitter @botisimo
+
+Creates a new command named `!social` that responds with `You can follow me on twitter @botisimo`
+
+## permission
+Edit command minimum permission
+
+#### Usage
+!command permission `<name>` `<permission=everyone|regs|subs|mods|admin>`
+
+#### Example
+    !command permission !social everyone
+
+Edits the minimum permission for the command named `!social` to allow `everyone` to use it

docs/commands.md

@@ -0,0 +1,80 @@
+# Available Commands
+Commands are used to allow you and your moderators/users to interact with the bot via chat
+
+Below is a list of the default commands available with Botisimo. They are grouped according to the default permission settings but the settings may differ per account. If a command argument is required it will be wrapped in `< >` and if the argument is optional it will be wrapped in `[ ]`.
+
+**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](/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](/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](/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](/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](/account/connections))
+
+## Mod Commands
+
+#### All platforms
+
+  - `!command` - Manage custom commands [view docs](/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](/docs/giveaway)
+  - `!irregular <username>` - Remove this user from regulars
+  - `!nextsong` or `!ns` - Skip the current song (works with the [music player](/account/music))
+  - `!ping` - Responds with `pong` in chat (quick way to check if Botisimo is responding in your channel)
+  - `!poll` - Manage polls [view docs](/docs/poll)
+  - `!regular <username>` - Add this user to regulars
+  - `!timer` - Manage custom timers [view docs](/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](/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](/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.

docs/conf.py

@@ -0,0 +1,53 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Botisimo'
+copyright = '2020, Botisimo'
+author = 'Botisimo'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'classic'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+source_suffix = ['.rst', '.md']