Update documentation for features, etc

This commit is contained in:
Tyler 2017-08-29 21:02:07 -04:00
parent fdf1ad529b
commit 28578b408b
6 changed files with 102 additions and 1 deletions

View File

@ -0,0 +1,18 @@
Temporary Channels
==================
.. toctree::
:maxdepth: 2
:caption: Contents:
Overview
--------
Temporary channels work just like Mumble Temp Channels. Join a voice channel, then use the command to create a channel that exists as long as someone is in it.
Create a temporary channel
--------------------------
Temporary channels can be named whatever you want, and have a user limit. To use names with spaces, enclose the first argument in quotes.
!tempchannel <name> [user limit]

View File

@ -31,4 +31,11 @@ Wolfram Alpha
Query Wolfram Alpha for something. This is not quite perfect, yet. Query Wolfram Alpha for something. This is not quite perfect, yet.
!wa <query> !wa <query>
Urban Dictionary
----------------
Query Urban Dictionary for something.
!ud <query>

View File

@ -19,6 +19,13 @@ Usage:
!channel content [#channel] !channel content [#channel]
Viewing tracked channels
------------------------
To view tracked channels, use the `!tracked` text command.
!tracked
Tracking channels Tracking channels
----------------- -----------------
@ -33,6 +40,15 @@ To untrack a channel, use the `!untrack` text command.
!untrack <twitch/youtube> <channel name> !untrack <twitch/youtube> <channel name>
Setting a message on content updates
------------------------------------
To set a message to go along with content updates, use the message command.
!message <twitch/youtube> "<some text>"
Variable replacement is available, with "{channel}" being universal for both YouTube and Twitch.
List tracked channels List tracked channels
--------------------- ---------------------

View File

@ -8,3 +8,23 @@ Features
* *
Enabling/Disabling features
---------------------------
The feature command lets you check, enable, and disable features. As more work is done, more features will be toggleable.
!feature check urbandictionary
!feature enable urbandictionary
!feature disable urbandictionary
Available Features
------------------
Below are the features you can toggle. Some disable a single command, while others disable a whole module.
- compliment
- insult
- media
- moderation
- tempchannel
- urbandictionary

View File

@ -0,0 +1,36 @@
Moderation
==========
.. toctree::
:maxdepth: 2
:caption: Contents:
Module Information
------------------
This module is currently being developed. Don't expect it to be stable.
Set the logging channel
-----------------------
!channel moderation #channel
Toggle link removal for a channel
---------------------------------
Retrieve information about the user querying the bot, such as discord age, how long they've been in the server, and roles.
!moderation channel #channel remove_links <enable/disable>
#channel can also be "global" to remove links server wide.
Filter attachments
------------------
Attachments can be filtered, only allowing images, videos, etc. Filters are based on mime types, so you can allow only png images if you wish. It uses a string compare on the type specified vs actual type.
!moderation channel #channel limit_attachments [any number of attachment types...]
Example:
!moderation channel #channel limit_attachments image video

View File

@ -23,8 +23,12 @@ Features
- :doc:`Media Playback <commands/media>` - :doc:`Media Playback <commands/media>`
- :doc:`Location, Time, and Weather <commands/location>` - :doc:`Location, Time, and Weather <commands/location>`
- :doc:`Content Notifications (Twitch, YouTube) <features/content>` - :doc:`Content Notifications (Twitch, YouTube) <features/content>`
- :doc:`Moderation <features/moderation>`
- :doc:`Overwatch Statistics and Patch Notes <features/overwatch>` - :doc:`Overwatch Statistics and Patch Notes <features/overwatch>`
- :doc:`Overwatch Pick-Up Games <features/overwatch_pug>` - :doc:`Overwatch Pick-Up Games <features/overwatch_pug>`
- :doc:`Temporary Channels <features/tempchannels>`
For more information about features, see the :doc:`Features <features/index>` index
Inviting to your server Inviting to your server
----------------------- -----------------------