Skip to content

Commit

Permalink
add music player
Browse files Browse the repository at this point in the history
  • Loading branch information
otothea committed Aug 21, 2020
1 parent c9f9f51 commit fcba9ac
Show file tree
Hide file tree
Showing 15 changed files with 52 additions and 30 deletions.
4 changes: 2 additions & 2 deletions docs/commands/default/login.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

**Default Permission:** Everyone

Receive a link to authorize chat mirroring for your Discord user (platform can be ``twitch`` or ``mixer``).
Receive a link to authorize chat mirroring for your Discord user (platform can be ``twitch``).

Usage:
!login ``<platform>``

Arguments:
* ``platform`` **<required>** - The platform to authorize (valid values: ``twitch``, ``mixer``)
* ``platform`` **<required>** - The platform to authorize (valid values: ``twitch``)

Example:
::
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/default/logout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@

**Default Permission:** Everyone

Disable chat mirroring for your Discord user (platform can be ``twitch`` or ``mixer``).
Disable chat mirroring for your Discord user (platform can be ``twitch``).

Usage:
!logout ``<platform>``

Arguments:
* ``platform`` **<required>** - The platform to deauthorize (valid values: ``twitch``, ``mixer``)
* ``platform`` **<required>** - The platform to deauthorize (valid values: ``twitch``)

Example:
::
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/default/subscribe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

**Default Permission:** Moderator

Subscribe to other Botisimo users' stream up announcements (platform should be ``twitch`` or ``mixer``).
Subscribe to other Botisimo users' stream up announcements (platform should be ``twitch``, ``youtube``).

Usage:
!subscribe ``<platform>`` ``<username>``

Arguments:
* ``platform`` **<required>** - The platform of the user to subscribe to (valid values: ``twitch``, ``mixer``)
* ``platform`` **<required>** - The platform of the user to subscribe to (valid values: ``twitch``, ``youtube``)
* ``username`` **<required>** - The username of the user to subscribe to

Example:
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/default/unsubscribe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

**Default Permission:** Moderator

Unsubscribe from other Botisimo users' stream up announcements (platform should be ``twitch`` or ``mixer``).
Unsubscribe from other Botisimo users' stream up announcements (platform should be ``twitch``, ``youtube``).

Usage:
!unsubscribe ``<platform>`` ``<username>``

Arguments:
* ``platform`` **<required>** - The platform of the user to subscribe to (valid values: ``twitch``, ``mixer``)
* ``platform`` **<required>** - The platform of the user to subscribe to (valid values: ``twitch``, ``youtube``)
* ``username`` **<required>** - The username of the user to subscribe to

Example:
Expand Down
16 changes: 15 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Giveaways are used to reward your viewers. This is a great way to give back to y
Shop
^^^^

The shop is used to incentivize your viewers to watch and participate in your stream regularly. When viewers watch your stream they gets currency that they can spend in your shop. The shop often includes items like a personal shout out or maybe you have to do something silly like the ice bucket challenge, be creative.
The shop is used to incentivize your viewers to watch and participate in your stream regularly. When viewers watch your stream they get currency that they can spend in your shop. The shop often includes items like a personal shout out or maybe you have to do something silly like the ice bucket challenge, be creative.

:doc:`Learn About Shop → <shop/index>`

Expand All @@ -96,6 +96,20 @@ The shop is used to incentivize your viewers to watch and participate in your st

shop/index

Music Player
^^^^^^^^^^^^

The music player is a great way to add music to your stream. You can also let viewers participate by requesting songs via chat!

:doc:`Learn About Music Player → <music/index>`

.. toctree::
:maxdepth: 1
:name: sec-music
:hidden:

music/index

Response Variables
^^^^^^^^^^^^^^^^^^

Expand Down
11 changes: 0 additions & 11 deletions docs/moderator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,6 @@ Twitch will respond with this if it worked::

You have added botisimo as a moderator of this channel.

Mixer
^^^^^

If you want to make Botisimo a moderator in your Mixer channel then go to your channel on Mixer and type this in your chat::

/mod Botisimo

Mixer will respond with this if it worked::

Botisimo is now a moderator!

YouTube
^^^^^^^

Expand Down
20 changes: 20 additions & 0 deletions docs/music/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Music Player
============

The music player is a great way to add music to your stream. You can also let viewers participate by requesting songs via chat!

You can configure your music player settings by visiting the `music player page <https://botisimo.com/account/music>`_ and clicking on **"+ Add to Queue"**, **"Edit Song Requests"**, and **"Edit Overlay"**.

.. toctree::
:maxdepth: 1
:name: toc-music
:caption: Related Commands

../commands/default/music
../commands/default/nextsong
../commands/default/songrequest

Related Videos
^^^^^^^^^^^^^^

.. youtube:: eLFW915_gcA
2 changes: 1 addition & 1 deletion docs/variables/discord.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Example Command:
user: !example
botisimo: You are a super awesome and cool dude!

**twitch/mixer/youtube output**::
**twitch/youtube output**::

user: !example
botisimo: You are a cool dude
1 change: 0 additions & 1 deletion docs/variables/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Response variables are used to make dynamic `custom command <https://botisimo.co
lastfm
level
minutes
mixer
pick
query
rank
Expand Down
4 changes: 2 additions & 2 deletions docs/variables/stripchar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Arguments:
Example Command:
**name**: !shoutout

**response**: $(1) is one cool streamer, check them out at https://mixer.com/$(stripchar @ $(1))
**response**: $(1) is one cool streamer, check them out at https://twitch.tv/$(stripchar @ $(1))

**output**::

user: !shoutout @username
botisimo: @username is one cool streamer, check them out at https://mixer.com/username
botisimo: @username is one cool streamer, check them out at https://twitch.tv/username
4 changes: 2 additions & 2 deletions docs/variables/targetplain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Usage:
Example Command:
**name**: !follow

**response**: Go to mixer.com/$(targetplain) and drop a follow!
**response**: Go to twitch.tv/$(targetplain) and drop a follow!

**output**::

user: !follow @bob
botisimo: Go to mixer.com/bob and drop a follow!
botisimo: Go to twitch.tv/bob and drop a follow!
2 changes: 1 addition & 1 deletion docs/variables/twitch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Example Command:
user: !example
botisimo: You are a super awesome and cool dude!

**mixer/youtube/discord output**::
**youtube/discord output**::

user: !example
botisimo: You are a cool dude
2 changes: 1 addition & 1 deletion docs/variables/username.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Example Command:

**response**: Hi, $(username)!

**twitch/mixer/youtube output**::
**twitch/youtube output**::

user: !hi
botisimo: Hi, @bob!
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/usernameplain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Example Command:

**response**: Hi, $(usernameplain)!

**twitch/mixer/youtube output**::
**twitch/youtube output**::

user: !hi
botisimo: Hi, bob!
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/youtube.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Example Command:
user: !example
botisimo: You are a super awesome and cool dude!

**twitch/mixer/discord output**::
**twitch/discord output**::

user: !example
botisimo: You are a cool dude

0 comments on commit fcba9ac

Please sign in to comment.