From 28578b408ba0a80a87c3de3ed4dafbcd240bce1e Mon Sep 17 00:00:00 2001 From: Tyler Date: Tue, 29 Aug 2017 21:02:07 -0400 Subject: [PATCH] Update documentation for features, etc --- docs/commands/tempchannels.rst | 18 +++++++++++++++++ docs/commands/utils.rst | 9 ++++++++- docs/features/content.rst | 16 +++++++++++++++ docs/features/index.rst | 20 +++++++++++++++++++ docs/features/moderation.rst | 36 ++++++++++++++++++++++++++++++++++ docs/index.rst | 4 ++++ 6 files changed, 102 insertions(+), 1 deletion(-) create mode 100644 docs/commands/tempchannels.rst create mode 100644 docs/features/moderation.rst diff --git a/docs/commands/tempchannels.rst b/docs/commands/tempchannels.rst new file mode 100644 index 0000000..7e7fb4b --- /dev/null +++ b/docs/commands/tempchannels.rst @@ -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 [user limit] \ No newline at end of file diff --git a/docs/commands/utils.rst b/docs/commands/utils.rst index 6ed7115..4ad6e2e 100644 --- a/docs/commands/utils.rst +++ b/docs/commands/utils.rst @@ -31,4 +31,11 @@ Wolfram Alpha Query Wolfram Alpha for something. This is not quite perfect, yet. - !wa \ No newline at end of file + !wa + +Urban Dictionary +---------------- + +Query Urban Dictionary for something. + + !ud \ No newline at end of file diff --git a/docs/features/content.rst b/docs/features/content.rst index e2385e4..377981b 100644 --- a/docs/features/content.rst +++ b/docs/features/content.rst @@ -19,6 +19,13 @@ Usage: !channel content [#channel] +Viewing tracked channels +------------------------ + +To view tracked channels, use the `!tracked` text command. + + !tracked + Tracking channels ----------------- @@ -33,6 +40,15 @@ To untrack a channel, use the `!untrack` text command. !untrack +Setting a message on content updates +------------------------------------ + +To set a message to go along with content updates, use the message command. + + !message "" + +Variable replacement is available, with "{channel}" being universal for both YouTube and Twitch. + List tracked channels --------------------- diff --git a/docs/features/index.rst b/docs/features/index.rst index 639a51a..fbfde2d 100644 --- a/docs/features/index.rst +++ b/docs/features/index.rst @@ -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 \ No newline at end of file diff --git a/docs/features/moderation.rst b/docs/features/moderation.rst new file mode 100644 index 0000000..4d943dc --- /dev/null +++ b/docs/features/moderation.rst @@ -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 + +#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 \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 92a0c40..7e79062 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,8 +23,12 @@ Features - :doc:`Media Playback ` - :doc:`Location, Time, and Weather ` - :doc:`Content Notifications (Twitch, YouTube) ` +- :doc:`Moderation ` - :doc:`Overwatch Statistics and Patch Notes ` - :doc:`Overwatch Pick-Up Games ` +- :doc:`Temporary Channels ` + +For more information about features, see the :doc:`Features ` index Inviting to your server -----------------------