Document Overwatch and Overwatch Pug

This commit is contained in:
Tyler 2017-05-28 17:40:11 -04:00
parent aaf317cce9
commit 88154b2171
3 changed files with 106 additions and 0 deletions

View File

@ -0,0 +1,47 @@
Overwatch
=========
.. toctree::
:maxdepth: 2
:caption: Contents:
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]
Overwatch statistics
--------------------
|project| can query Overwatch using https://ow-api.com and show basic statistics.
Linking/Unlinking Battlenet
---------------------------
You may link your battlenet tag, region, and platform to quickly check your stats in the future.
Usage:
!!linkbnet <battletag> <region> <platform>
If you no longer want to have it linked, you may also unlink it.
Usage:
!!unlinkbnet
Looking up Quickplay stats
--------------------------
To lookup Quickplay stats, use the following command:
!!ow [battletag] [region] [platform]
Looking up Competitive stats
----------------------------
To lookup Competitive stats, use the following command:
!!owcomp [battletag] [region] [platform]

View File

@ -0,0 +1,56 @@
Overwatch Pugs
==============
.. toctree::
:maxdepth: 2
:caption: Contents:
Overwatch PUG
-------------
A PUG is a Pick-Up Game, a well-known term in many games. They may also be considered games that are played with friends after picking teams.
Prerequisites
-------------
|project| needs the "Manage Channels" permission, |project| and all other bots need the "Move Members" permission.
You will need at least one of the following bots also in the server, to allow us to move more people than the rate limit allows for.
OWPugBot: https://discordapp.com/oauth2/authorize?client_id=260230074064830466&scope=bot&permissions=16777216
Starting a lobby
----------------
A lobby is a group of players that wish to split into teams. You can define as many teams as you want/have players for.
To start a lobby with a specified number of leaders, and let people volunteer:
!!leaders <number of leaders>
To start a lobby with a specified list of leaders, use Discord's Mentions:
!!leaders @Leader1 @Leader2...
Volunteering for Captain
------------------------
To volunteer as a team captain, use the following command:
!!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
After all players are picked, the leaders will be moved to the respective team channels.
Teams are matched in order, so team one against team two, team three and team four, etc.
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.

View File

@ -22,6 +22,9 @@ Features
- Faster and more efficient than other bots
- :doc:`Media Playback <commands/media>`
- :doc:`Location, Time, and Weather <commands/location>`
- :doc:`Content Notifications (Twitch, YouTube) <features/content>`
- :doc:`Overwatch Statistics and Patch Notes <features/overwatch>`
- :doc:`Overwatch Pick-Up Games <features/overwatch_pug>`
Inviting to your server
-----------------------