# Brief Description
Sherlock is a dynamic autonmous moderation bot.  We have many supported features with still many to come!  Our primary goal is to provide a high quality moderation bot that can automously handle a server and its members with ease.  (More on the autonomous part later)  

Sherlock has a default prefix of ! however this can be changed to whatever you like.

## Getting Started
It is best to read the official documentation that is kept up to date with the latest changes here:  [Github Wiki - Setup and Config](https://github.com/Blade2021/Sherlock/wiki/Setup-and-Configuration)  

Typing `!settings` (or whatever you set the bot prefix too) will provide you a link to this documentation.

** Please note that all guild settings for the BoT, MUST be set by a server administrator! **

## Highlighted Features
* Self roles - Allow users to toggle roles on themselves using a defined trigger
* Timed muting
* Guild Independant blacklisting (You choose what words aren't allowed)
* Automatic embed surpressing (Keep embed walls from limiting your conversation)
* Channel cooldowns (Automatically set roles back to normal afterward)
* Advanced Moderator Permissions - Set what commands you want your mods to have access too.  
* Autonomous - Sherlock will notify you when you delete a role that is connected to a self role or *1 automatically apply the mute role to new channels you create.
* Welcome Message system

*1 - For this event to work, Sherlock needs the ability to see and manage the channel upon creation.  All channels that are not visible to Sherlock will not have the mute role automatically applied.

# BoT Setup and configuration:
Please read through the following document as there are a few key settings that need to be set to get the most out of Sherlock.  These settings MUST be set by a server administrator.  This is intentional to prevent abuse and or authorized access.

[Github Wiki](https://github.com/Blade2021/Sherlock/wiki/Setup-and-Configuration)

# BoT Commands:
We keep the latest information and commands uploaded to the github wiki.  Please do refer there for the most up to date information.  Any other sources should be considered uncontrolled and possibly invalid.  Link below...

[BoT Commands Page](https://github.com/Blade2021/Sherlock/wiki/Commands)

# Inviting ADMIN vs Non-Admin
We provide both cases of Sherlock however we advise the Administrator permission be included IF you would like Sherlock to automatically handle NEW private channels.  What does this mean?  Sherlock automatically applies the Mute role to channels as they are added.  This DOES require that Sherlock is able to see the channel being created at the time of creation.  This is 100% optional and if you do not need this feature for private channels, then you are 100% covered without the administrator permission.  

Sherlock

A dynamic moderation bot designed to handle certain situations autonomously.  

Bots Discord

Sherlock