Update documentation

This commit is contained in:
Tyler 2017-06-11 01:10:19 -04:00
parent 6cb22c11bd
commit fdf1ad529b
11 changed files with 115 additions and 29 deletions

View File

@ -16,4 +16,4 @@ Voice Commands are matched by full words/blocks of text, such as holding down th
Text Commands
-------------
Text Commands can be done in any channel with the prefix `!!` (two exclamation points).
Text Commands can be done in any channel with the prefix `!` (one exclamation point).

View File

@ -8,9 +8,9 @@ Setting your location can provide responses to many commands that are tailored t
To set your location, use the following text command:
!!location city/state/country
!location city/state/country
We use Google's Location API to resolve this to a Latitude/Longitude, which you can get by using `!!location` without any arguments after setting it.
We use Google's Location API to resolve this to a Latitude/Longitude, which you can get by using `!location` without any arguments after setting it.
Time

View File

@ -14,16 +14,16 @@ Playing media can be done using the voice command
You can also add YouTube videos directly using the text command:
!!play <url or query>
!play <url or query>
Controlling the queue
---------------------
Queue items can be skipped by saying `skip` or using the text command `!!skip`.
Queue items can be skipped by saying `skip` or using the text command `!skip`.
The queue can be cleared by using the text command `!!clear`. This will not skip the current song.
The queue can be cleared by using the text command `!clear`. This will not skip the current song.
To stop playback and clear the queue, say `stop` or use the text command `!!stop`.
To stop playback and clear the queue, say `stop` or use the text command `!stop`.
Adjusting the volume
--------------------
@ -34,7 +34,7 @@ Adjusting the volume can be done using the voice command:
Or the text command:
!!volume 0-100
!volume 0-100
You can also say `louder` or `softer` to raise/lower the volume by 10% each time.
@ -43,4 +43,4 @@ Setting the default volume
|project|'s default volume can be set for voice and media. The sane values of 100% for voice, and 20% for audio are used. When the command is used without arguments, it will show the current values.
!!defaultvolume <voice/media> 0-100
!defaultvolume <voice/media> 0-100

38
docs/commands/poll.rst Normal file
View File

@ -0,0 +1,38 @@
Poll Commands
=============
.. toctree::
:maxdepth: 2
:caption: Contents:
Starting a poll
---------------
To start a standard poll, use the following command:
!poll "<question>" "option1" "option2"...
There can be as many options as you want.
Starting a timed poll
---------------------
A timed poll will automatically end after the specified time limit (in minutes)
To start a timed poll, use the following command:
!tpoll "question" <time in minutes> "option1" "option2"...
Voting in a poll
----------------
To vote in a poll, use the command `!vote` along with the option number (starting at 1), like so:
!vote 1
Ending a poll
-------------
To end a poll, use the following command:
!endpoll

View File

@ -0,0 +1,14 @@
Sysadmin/Computer Utility Commands
==================================
.. toctree::
:maxdepth: 2
:caption: Contents:
GeoIP Lookup
------------
Performs a GeoIP lookup with ip-api.
!geo <ip address/hostname>

34
docs/commands/utils.rst Normal file
View File

@ -0,0 +1,34 @@
Utility Commands
================
.. toctree::
:maxdepth: 2
:caption: Contents:
Server Information
------------------
Retrieve server information, such as server age, users, etc.
!serverinfo
User Information
----------------
Retrieve information about the user querying the bot, such as discord age, how long they've been in the server, and roles.
!userinfo
Calculator
----------
Retrieve the result of a standard numeric problem
!c 2 + 3 + 5 / 2
Wolfram Alpha
-------------
Query Wolfram Alpha for something. This is not quite perfect, yet.
!wa <query>

View File

@ -17,26 +17,26 @@ The Content Channel will be used every time |project| detects a channel change (
Usage:
!!channel content [#channel]
!channel content [#channel]
Tracking channels
-----------------
To track a channel, use the `!!track` text command.
To track a channel, use the `!track` text command.
!!track <twitch/youtube> <channel name>
!track <twitch/youtube> <channel name>
Untracking channels
-------------------
To untrack a channel, use the `!!untrack` text command.
To untrack a channel, use the `!untrack` text command.
!!untrack <twitch/youtube> <channel name>
!untrack <twitch/youtube> <channel name>
List tracked channels
---------------------
To list all channels monitored by the bot, use `!!tracked`. It will return a list of channels for Twitch and YouTube.
To list all channels monitored by the bot, use `!tracked`. It will return a list of channels for Twitch and YouTube.
Detection delay
---------------

View File

@ -17,13 +17,13 @@ The message channel will be used to send messages when people join or leave the
Usage:
!!channel message [#channel]
!channel message [#channel]
Setting the join or leave messages
----------------------------------
To change the join/leave message, use the `!!message` text command.
To change the join/leave message, use the `!message` text command.
!!message <join/leave> "Message enclosed in quotes"
!message <join/leave> "Message enclosed in quotes"
You can use the replacement variables `{highlight}` and `{username}` to replace the text with a highlight/mention, or their username.

View File

@ -10,7 +10,7 @@ Overwatch patch notes
|project| will notify you when a new Overwatch patch note is added. Set the "overwatch" channel type, like shown below to enable.
!!channel overwatch [#channel]
!channel overwatch [#channel]
Overwatch statistics
--------------------
@ -24,24 +24,24 @@ You may link your battlenet tag, region, and platform to quickly check your stat
Usage:
!!linkbnet <battletag> <region> <platform>
!linkbnet <battletag> <region> <platform>
If you no longer want to have it linked, you may also unlink it.
Usage:
!!unlinkbnet
!unlinkbnet
Looking up Quickplay stats
--------------------------
To lookup Quickplay stats, use the following command:
!!ow [battletag] [region] [platform]
!ow [battletag] [region] [platform]
Looking up Competitive stats
----------------------------
To lookup Competitive stats, use the following command:
!!owcomp [battletag] [region] [platform]
!owcomp [battletag] [region] [platform]

View File

@ -29,7 +29,7 @@ A lobby is a group of players that wish to split into teams. You can define as m
To start a lobby with a specified number of leaders, and let people volunteer:
!!lobby <number of leaders> [players per team] [pick method]
!lobby <number of leaders> [players per team] [pick method]
Pick method can be one of the following:
@ -38,21 +38,21 @@ Pick method can be one of the following:
To start a lobby with a specified list of leaders, use Discord's Mentions:
!!lobby @Leader1 @Leader2...
!lobby @Leader1 @Leader2...
Volunteering for Captain
------------------------
To volunteer as a team captain, use the following command:
!!volunteer
!volunteer
Picking players
---------------
When it is your turn, the bot will mention you and tell you it's your pick. To pick a player, use Discord mentions with the following command.
!!pick @Player
!pick @Player
After all players are picked, the leaders will be moved to the respective team channels.
@ -61,4 +61,4 @@ Teams are matched in order, so team one against team two, team three and team fo
Ending your pug
---------------
When your game has finished and you wish to return to the lobby, a player in the specific pug can use the `!!end` command. This will return everyone to the lobby and remove the team channels.
When your game has finished and you wish to return to the lobby, a player in the specific pug can use the `!end` command. This will return everyone to the lobby and remove the team channels.

View File

@ -16,4 +16,4 @@ Message will be used for Join/Leave messages, and possibly something else in the
Usage:
!!channel <text/content/message> [#channel]
!channel <text/content/message> [#channel]