## Welcome to Coffee Bot

> #### Coffee Bot is an open source, verified Discord bot with some handy features:
> - A *simple* yet **effective** reporting system which uses context menus to handle user and message reports (detailed examples with images below). Staff can then mark reports as either 'Actioned' or as a 'False Positive'.
> - A Discord server invite filter, link filter and chat filter - all with an optional log channel.
> - Detailed message edit and message delete logs showing _who deleted_ a message. Also see _all messages_ deleted in a bulk delete.
> - Member nickname, timeout and member role update logs showing _who_ did what. Additionally, you can view _all members_ that had a role when it gets deleted.

(Please note: the images in this description are currently broken)

### Page Contents
**Click a heading to jump to that section!**
- <a href="#commands">Commands</a>
- <a href="#setup">Setup</a>
- <a href="#examples">Examples</a>
    - <a href="#report1">Reporting a Message via a context menu</a>
    - <a href="#report2">Reporting a User via a context menu</a>
    - <a href="#report3">Reporting a User via a Slash Command</a>
    - <a href="#report4">Setting a report's state</a>
    - <a href="#deletelogs">Message Delete Logs</a>
    - <a href="#rolelogs">Role Update Logs</a>
    - <a href="#aboutcmd">About Command</a>

<h3 id="commands">Commands</h3>
<table>
<thead>
<tr>
<th><strong>Command</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Report User</code></td>
<td>Easily report a user with a reason. This is a context menu command.</td>
</tr>
<tr>
<td><code>Report Message </code></td>
<td>Easily report a message with a reason. This is a context menu command.</td>
</tr>
<tr>
<td><code>Reset Report</code></td>
<td>Reset a report's state. This is a context menu command.</td>
</tr>
<tr>
<td><code>/report</code></td>
<td>Easily report a user with an optional image attached. This is a slash command.</td>
</tr>
<tr>
<td><code>/about</code></td>
<td>Shows stats about the bot and commit history. This is a slash command.</td>
</tr>
<tr>
<td><code>/help</code></td>
<td>Shows a list of commands. This is a slash command.</td>
</tr>
<tr>
<td><code>/vote</code></td>
<td>Information and statistics on voting. This is a slash command.</td>
</tr>
<tr>
<td><code>/settings</code></td>
<td>Configure how the bot works in your server. This is a slash command.</td>
</tr>
</tbody>
</table>

<h3 id="setup">Setup</h3>

**To set the bot up simply use the intuitive /settings command! There are multiple categories for you to hop between with a dropdown select menu. This command requires the 'Manage Server' permission.**

![Alt Text](https://cdn.discordapp.com/attachments/767356269873987615/968970955500179526/unknown.png)
**Here are examples of the Reports, Moderation and Log pages:**
![Alt Text](https://cdn.discordapp.com/attachments/767356269873987615/968971013255749652/unknown.png)
![Alt Text](https://cdn.discordapp.com/attachments/767356269873987615/968971192398655568/unknown.png)
![Alt Text](https://cdn.discordapp.com/attachments/953399867575791647/976204466523078656/unknown.png)

<h2 id="examples">Examples</h2>

**Below are some detailed examples with pictures to demonstrate features of Coffee Bot!**

<h3 id="report1">Reporting a Message via a context menu</h3>

**Right click on a message, scroll to 'Apps' and select 'Report Message'.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953401939641630791/unknown.png)
**Enter a reason for your report.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953402232026566697/unknown.png)
**View your report.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953402384778919966/unknown.png)
**This is what the staff receive.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981965079929045012/unknown.png)


<h3 id="report2">Reporting a User via a context menu</h3>

**Right click on a message, scroll to 'Apps' and select 'Report User'.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953399932306477056/unknown.png)
**Enter a reason for your report.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953400056470446080/unknown.png)
**View your report.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953400315279966278/unknown.png)
**This is what the staff receive.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981965851169280000/unknown.png)

<h3 id="report3">Reporting a User via a Slash Command</h3>

**Write /report and choose a member to report. You can optionally include an image for staff.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953400875945181224/unknown.png)
**Enter a reason for your report.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953401093323390976/unknown.png)
**View your report.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/953401387339894784/unknown.png)
**This is what the staff receive.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981966522786414592/unknown.png)

<h3 id="report4">Setting a report's state</h3>

**You can click the green 'Actioned' button to let your staff team know that a report has been handled.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981968780257276004/unknown.png)

**Alternatively, if a false report has been made you can mark it as a 'False Positive'.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981968899086123028/unknown.png)

**To reset a report's state, any member with the 'Manage Server' permission can simply use the 'Reset Report' context menu command.**
![Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981968499238916136/unknown.png)

<h3 id="deletelogs">Message Delete Logs</h3>

**Here is an example channel.**
![About Command Preview](https://cdn.discordapp.com/attachments/767356269873987615/969339492869759097/unknown.png)
**If I now delete the message from Coffee Bot, the log will show it was me!**
![About Command Preview](https://cdn.discordapp.com/attachments/767356269873987615/969340046371090462/unknown.png)
**Now I will clear the rest of the chat using a bulk delete command. You can see all the deleted messages!**
![About Command Preview](https://cdn.discordapp.com/attachments/767356269873987615/969340594482741248/unknown.png)

<h3 id="rolelogs">Role Update Logs</h3>

**When a member gains or loses a role, you can get notified and see who did it!**
![About Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/976205615145836554/unknown.png)

**If a role gets deleted, you can see all the members which had the role!**
![About Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/976180411514363954/unknown.png)

<h3 id="aboutcmd">About Command</h3>

**Here is the /about command which shows some (hopefully) interesting statistics!**
![About Command Preview](https://cdn.discordapp.com/attachments/953399867575791647/981987694144008242/unknown.png)

---

#### Please Note
 - Members must have the 'Use Application Commands' permission to use slash/context menu commands.

Coffee Bot

Easily handle reports in your Discord server using context menus & text input modals. 
Featuring advanced audit logs showing who did what.

Voting for Coffee Bot