<center><h1>InCaptcha</h1></center>
<center><p><b>InCaptcha</b>, a captcha-based Discord bot helps to secure your servers from raiders and automated users who targeted to harm servers.</p></center>
<br>
<center><h3>Bot's Info</h3></center>
<center>Bot's Library: <b><a href="https://github.com/abalabahaha/eris">Eris</a></b><br>Bot's Prefix: <code><b>!</b></code></center>

<br>
<hr>

<center><blockquote><h2>Setting Up The Bot</h2>To get full detailed setup, scroll down to the <b>Configuration Setup</b> section and follow its instructions.</blockquote></center>

<br>

<center>
<blockquote><h3>Commands</h3></blockquote>
Since this bot is mainly used by Server Admins, there aren't many general commands provided.
<table>
<thead>
<tr>
<th style="text-align:center"><strong>Category</strong></th>
<th style="text-align:center"><strong><code>Commands</code></strong></th>
<th style="text-align:center"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">User</td>
<td style="text-align:center"><code>!verify</code></td>
<td style="text-align:center">Sends a new Captcha incase users failed to attempt, DMs are locked,  or errors occur</td>
</tr>
<tr>
<td style="text-align:center">General</td>
<td style="text-align:center"><code>!help</code></td>
<td style="text-align:center">Gives the help message</td>
</tr>
<tr>
<td style="text-align:center">General</td>
<td style="text-align:center"><code>!stats</code></td>
<td style="text-align:center">Gives the stats of the bot. Currently showing the total servers and users count</td>
</tr>
<tr>
<td style="text-align:center">Admin</td>
<td style="text-align:center"><code>!setuplist</code></td>
<td style="text-align:center">Give the list of the remaining required actions to configure</td>
</tr>
<tr>
<td style="text-align:center">Admin</td>
<td style="text-align:center"><code>!config</code></td>
<td style="text-align:center">Configure the bot and display the current configuration</td>
</tr>
</tbody>
</table>
<br>
<blockquote><h2>Configuration Setup</h2></blockquote>
We've provided 2 instructions for you and feel free to choose which to follow. Both works the same.
<br>
<h3>Quick Configuration Setup</h3>
<b>1st.</b> Invite <a href="https://bit.ly/InviteInCaptcha">InCaptcha</a>
<br>
<b>2nd.</b> Run <code>!setuplist</code> and check the remaining actions to completely configure the bot.
<br>
<b>3rd.</b> Run <code>!config</code> and configure the appropriate field such as <code>waitingRoom</code> and <code>verifiedRole</code> within the command.
<br>
<b>4th.</b> Edit each channels Permissions to denying the <code>@everyone</code> role or the <code>unverifiedRole</code>, if you had configured one and allowing the <code>verifiedRole</code> to view and send messages in the channels. You can also do the same thing but instead on the category and sync all channels based on the category.
<br><br>
<li>Configuration Completed</li>
<br>
<hr>
<h3>Detailed Configuration Setup</h3>
<p><b>Firstly</b>, <a href="https://bit.ly/InviteInCaptcha">Invite InCaptcha</a> to your server.</p>
<li>When inviting the bot, it'll opened up a Discord OAuth.</li>
<li>Make sure to invite the bot with the <code>Send Messages</code>, <code>View Channels</code>, <code>Manage Roles</code>, <code>Kick Members</code>, and <code>Ban Members</code> permissions.</li>
<li>Select which server you want the bot to join and click <code>Continue</code> and <code>Authorize</code>.</li>
<br>
<img src="https://i.imgur.com/Xq8rcDp.png">
<br><br>
<p><b>Secondly</b>, after inviting the bot with the correct permissions, run <code>!setuplist</code>.</p>
<li>When you invited the bot for the first time, it should look something like this when running <code>!setuplist</code></li>
<br>
<img src="https://i.imgur.com/JV4Z0q4.png">
<br>
<p>This will display the necessary actions need to be done before the bot can completely working. You'll need to configure the bot using <code>!config</code> command and provide the <code>waitingRoom</code> and <code>verifiedRole</code> field as shown above image. Note that the bot also supports additional features for you to use and these are optional.</p>
<br>
<p><b>Thirdly</b>, configure the bot.</p>
<li>Configuration are always done within the <code>!config</code> command. See below for features which are available.</li>
<br>
<table>
<thead>
<tr>
<th style="text-align:center"><code>!config</code></th>
<th style="text-align:center">Optional</th>
<th style="text-align:center">Display The Current Configuration</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center"><code>!config waitingRoom [Channel | None]</code></td>
<td></td>
<td style="text-align:center">The waiting room/verification channel</td>
</tr>
<tr>
<td style="text-align:center"><code>!config verifiedRole [Role| None]</code></td>
<td></td>
<td style="text-align:center">Given the role when user successfully completed a Captcha</td>
</tr>
<tr>
<td style="text-align:center"><code>!config unverifiedRole [Role| None]</code></td>
<td>✔</td>
<td style="text-align:center">Given the role when user have not completed a Captcha yet</td>
</tr>
<tr>
<td style="text-align:center"><code>!config logsRoom [Channel | None]</code></td>
<td>✔</td>
<td style="text-align:center">The Captcha logs channel</td>
</tr>
<tr>
<td style="text-align:center"><code>!config captchaOnDM [True | False]</code></td>
<td>✔</td>
<td style="text-align:center">Whether the bot will send the Captcha to user's DM automatically or not. If <code>False</code>, user need to verify manually by running <code>!verify</code> in <code>waitingRoom</code></td>
</tr>
<tr>
<td style="text-align:center"><code>!config captchaFail [Kick | Ban | None]</code></td>
<td>✔</td>
<td style="text-align:center">Action for the bot to do to users who failed the Captcha (ran out of time)</td>
</tr>
</tbody>
</table>
<br>
<p>To ensure you configured everything correctly, run <code>!setuplist</code> again to confirm.</p>
<br>
<p><b>Lastly</b>, editing the permissions.</p>
<br>
<li>Remember when editing channels permissions, always allow <code>verifiedRole</code> to view and send messages and disallow for <code>@everyone</code> or <code>unverifiedRole</code> if configured.</li>
<br>
<p>For a proper and efficient permissions setup, see below for our most recommended method when editing channels permissions.</p>
<li><code>waitingRoom</code> -> <code>@everyone | unverifiedRole</code> -> <code>View Channels & Send Messages</code> -> <code>True</code></li>
<li><code>waitingRoom</code> -> <code>verifiedRole</code> -> <code>View Channels & Send Messages</code> -> <code>False</code></li>
<li><code>Categories</code> -> <code>@everyone | unverifiedRole</code> -> <code>View Channels & Send Messages</code> -> <code>False</code></li>
<li><code>Categories</code> -> <code>verifiedRole</code> -> <code>View Channels & Send Messages</code> -> <code>True</code></li>
<li><b>Sync all channels with the category</b></li>
<br>
<blockquote><b>Congratulations! Your Configuration Is Done.</b></blockquote>
<br>
<hr>
<h2>F.A.Q</h2>
<blockquote><h3>How Does This Work?</h3></blockquote>
<p>Whenever a user joins a server, they'll see nothing except the <code>waitingRoom</code> channel used for verification. The bot will then send a Captcha in user's DM for them to solve before entering the server. When the user successfully completed the Captcha given, they'll received the <code>verfiedRole</code> and are able to see the rest of the channels.</p>
<br>
<p><img src="https://imgur.com/067aEKW.png" style="width:350px;height:450px"><img src="https://imgur.com/8AxYvRq.png" style="width:350px;height:450px"></p>
<br>
<p>Below are the example of how users solving their Captcha. They need to type out the code what they saw and that's it! These verification actions are only done in the user's DMs and the <code>waitingRoom</code></p>
<img src="https://i.imgur.com/kF6iwuC.png">
<br>
<p>Simple, isn't it? This is not required any Server admins to interact with the unverified users.</p>
<br>
<blockquote><h3>What If The User DMs Are Locked?</h3></blockquote>
<p>When a user DMs is disabled, the bot will ping them on the <code>waitingRoom</code> channel to enable the DMs in order to solve the Captcha. They also need to run <code>!verify</code> manually for a new Captcha.</p>
<br>
<img src="https://i.imgur.com/erMhb07.png">
<br>
<blockquote><h3>What If Users Failed The Captcha?</h3></blockquote>
<p>Whenever a user failed a Captcha, they'll be told to gain a new Captcha in the <code>waitingRoom</code> channel and run <code>!verify</code>.</p>
<br>
<img src="https://i.imgur.com/dG2gX5Z.png">
<br>
<blockquote><h3>Do Users Get The Same Captcha?</h3></blockquote>
<p>Nope. All Captchas are generated randomly. Using the same Captcha would ruined the Security.</p>
<hr>
</center>

InCaptcha

Require New Joined Users To Filled Out A Captcha Before Entering The Server

Abstimmung für InCaptcha

Möchtest du uns unterstützen?