Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamt20054/djscaptcha
A NPM module for Discord.js made to easily create CAPTCHAs to present to your Discord servers members.
https://github.com/adamt20054/djscaptcha
bot captcha discord discord-js discord-verification discord-verification-bot djs djscaptcha djsv14 security verification
Last synced: about 1 month ago
JSON representation
A NPM module for Discord.js made to easily create CAPTCHAs to present to your Discord servers members.
- Host: GitHub
- URL: https://github.com/adamt20054/djscaptcha
- Owner: AdamT20054
- License: gpl-3.0
- Created: 2022-08-02T20:27:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T04:15:41.000Z (6 months ago)
- Last Synced: 2024-10-12T03:01:26.943Z (about 1 month ago)
- Topics: bot, captcha, discord, discord-js, discord-verification, discord-verification-bot, djs, djscaptcha, djsv14, security, verification
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/djscaptcha
- Size: 2.09 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
    
[](https://github.com/AdamT20054/DJSCaptcha/actions/workflows/dependency-review.yml) [](https://github.com/AdamT20054/DJSCaptcha/actions/workflows/codeql-analysis.yml) [](https://github.com/AdamT20054/DJSCaptcha/actions/workflows/devskim.yml) [](https://github.com/AdamT20054/DJSCaptcha/actions/workflows/njsscan.yml)
# DJS Captcha
## Table of Contents
- [Description](#description)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Example Code](#example-code)
- [Presenting a CAPTCHA to a Member With Built-In CAPTCHA Creation](#presenting-a-captcha-to-a-member-with-built-in-captcha-creation)
- [Presenting a CAPTCHA to a Member With Custom CAPTCHA Image Data](#presenting-a-captcha-to-a-member-with-custom-captcha-image-data)
- [Manually Creating a CAPTCHA](#manually-creating-a-captcha)
- [Captcha Events](#captcha-events)
- [Screenshots](#screenshots)
- [License](#license)
- [Acknowledgements](#acknowledgements)
- [Contacts](#contacts)
# Description
DJSCaptcha sets out to generate on-the-fly CAPTCHAs based off your desired inputs to present to members of your server. The module both creates the CAPTCHA, listens for a result and then acts on the result by removing and/or adding roles to users in your server.
The module was designed to primarily be used as a welcome CAPTCHA verification system.
# Getting Started
This bot is designed for DiscordJS@V14, you may run into issues using it in earlier versions as DiscordJS switched to EmbedBuilder().
## Prerequisites
DiscordJS@V14 requires [email protected] or higher to run.
If you are using an Ubuntu and other Debian based systems, you may need to install some Prerequisites for Canvas to run. You can install these by running the following in the CLI:
```bash
sudo apt-get update
```
```bash
sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
```
For more information on installing see [the Canvas Ubuntu and other Debian based systems installation page](https://github.com/Automattic/node-canvas/wiki/Installation%3A-Ubuntu-and-other-Debian-based-systems)
## Installation
To install this module, type the command shown below into your Terminal.
```bash
npm i djscaptcha
```
# Example Code
```javascript
const { EmbedBuilder, Collection, PermissionsBitField, Embed, Colors } = require('discord.js');
const { Captcha } = require("djscaptcha");
const client = (`..`) // Import client here
// Triggered by the guildMemberAdd event.
client.on('guildMemberAdd', async (member) => {
const captcha = new Captcha(client, {
roleAddID: "803853753357959189", // [Optional if addRoleOnSuccess = false] The ID of the role to add to the user.
roleRemoveID: "807093688466800712", // [Optional if removeRoleOnSuccess = false] The ID of the role to remove from the user.
channelID: "803763753429762100", // [Optional if sendToTextChannel = false] The ID of the channel to send the CAPTCHA to.
sendToTextChannel: false, // [Optional | defaults to false] Whether to send the CAPTCHA to a text channel.
addRoleOnSuccess: true, // [Optional | defaults to true] Whether you want the bot to add the role to the user if the captcha is solved.
removeRoleOnSuccess: true, // [Optional | defaults to false] Whether you want the bot to remove the role from the user if the captcha is solved.
kickOnFailure: true, // [Optional | defaults to false] Whether you want the bot to kick the user if the captcha is failed. Kicks happen 7.5seconds after the captcha has timedout/failed.
kickIfRoleAdded: false, // [Optional | defaults to false | kickOnFailure must be true] Whether to kick the user if they have the role added to them without the captcha being completed.
kickIfRoleRemoved: false, // [Optional | defaults to false | kickOnFailure must be true] Whether to kick the user if they have the role removed from them without the captcha being completed
caseSensitive: true, // [Optional | defaults to true] Whether you want the captcha responses to be case-sensitive.
attempts: 3, // [Optional | defaults to 3] The number of attempts before captcha is considered to be failed.
timeout: 300000, // [Optional | defaults to 60000] The time the user has to solve the captcha on each attempt in milliseconds.
showAttemptCount: true, // [Optional | defaults to true] Whether to show the number of attempts left in embed footer.
customPromptEmbed: new EmbedBuilder() // [Optional] Customise the embed that will be sent
.setTitle(`Welcome to ${member.guild.name}!`)
.addFields({
name: "I'm Not a Robot",
value: `${member.user}, to gain access to **${member.guild.name}**, please solve the CAPTCHA below!\n\nThis is done to protect the server from raids consisting of spam bots.`
})
.setColor('#0099ff') // Set a custom color for the Prompt Embed
.setThumbnail(member.guild.iconURL({dynamic: true})),
customSuccessEmbed: new EmbedBuilder() // [Optional] Customise the embed that will be sent
.setTitle("✅ CAPTCHA Solved!")
.setDescription(`${member.user}, you completed the CAPTCHA successfully, and you have been given access to **${member.guild.name}**!`)
.setTimestamp()
.setColor('#29ff00')
.setColor(Colors.Aqua)
.setThumbnail(member.guild.iconURL({dynamic: true})),
customFailureEmbed: new EmbedBuilder() // [Optional] Customise the embed that will be sent
.setTitle("❌ You Failed to Complete the CAPTCHA!")
.setDescription(`${member.user}, you failed to solve the CAPTCHA!`)
.setTimestamp()
.setColor('#c71515')
.setThumbnail(member.guild.iconURL({dynamic: true})),
});
captcha.present(member);
});
```
## To use the default embeds, simply use the following code:
```javascript
customPromptEmbed: new EmbedBuilder(),
customSuccessEmbed: new EmbedBuilder(),
customFailureEmbed: new EmbedBuilder()
```
### To learn more about creating your own embeds, refer to the [Discord.js EmbedBuilder](https://discordjs.guide/popular-topics/embeds) documentation.
## **`channelID`** Option Explained
The `channelID` option is the ID of the Discord Text Channel to Send the CAPTCHA to if the user's Direct Messages are locked. If no ID is provided then the CAPTCHA will not be sent at all if the users DMs are locked.
Use the option `sendToTextChannel`, and set it to `true` to always send the CAPTCHA to the Text Channel.
## **`sendToTextChannel`** Option Explained
The `sendToTextChannel` option determines whether you want the CAPTCHA to be sent to a specified Text Channel instead of Direct Messages, regardless of whether the user's DMs are locked.
Use the option `channelID` to specify the Text Channel.
## **`kickIfRoleAdded`** Option Explained
The `kickIfRoleAdded` option determines whether you want the bot to kick the user if they have the role added to them without the captcha being completed. If this option is set to `true`, the bot will kick the user if they have the role added to them without the captcha being completed. `kickOnFailure` must be set to `true` for this option to work.
If you are using this bot alongside other verification methods, or you want to manually verify some people, keep this option as `false`
Use the option `false` to not kick the user if they have the role added to them without the captcha being completed.
## **`kickIfRoleRemoved`** Option Explained
The `kickIfRoleRemoved` option determines whether you want the bot to kick the user if they have the role removed from them without the captcha being completed. If this option is set to `true`, the bot will kick the user if they have the role removed them without the captcha being completed. `kickOnFailure` must be set to `true` for this option to work.
If you are using this bot alongside other verification methods, or you want to manually verify some people, keep this option as `false`
Use the option `false` to not kick the user if they have the role added to them without the captcha being completed.
## Presenting a CAPTCHA to a Member With Built-In CAPTCHA Creation
---
Discord.js Captcha can automatically create a CAPTCHA for you, if you don't want to create one yourself.
**Note:** Built-In CAPTCHA Creation requires you to install the `canvas` package which should be preinstalled as part of the prerequisites. If `canvas` is not installed, you can install it with
```bash
npm i canvas
```
```js
client.on("guildMemberAdd", async member => {
//in your bot application in the dev portal, make sure you have intents turned on!
captcha.present(member); //captcha is created by the package, and sent to the member
});
```
## Presenting a CAPTCHA to a Member With Custom CAPTCHA Image Data
---
Don't like how the automatically created CAPTCHA looks? Simply pass in your own `CaptchaImageData` to the `present` method!
```js
// noinspection JSAnnotator
client.on("guildMemberAdd", async member => {
//in your bot application in the dev portal, make sure you have intents turned on!
const captchaImageBuffer = //custom image as buffer
const captchaImageText = //answer to the captcha as string
captcha.present(member, {image: captchaImageBuffer, text: captchaImageText});
});
```
**Note:** When displaying a CAPTCHA to the user, the CAPTCHA image will automatically be attached to the `customPromptEmbed` for you.
In addition, if you have the `showAttemptCount` option enabled, any embed footer text on the `customPromptEmbed` will be overwritten with the number of attempts left.
## Manually Creating a CAPTCHA
---
You can use the `createCaptcha` method to easily create your own CAPTCHA using Discord.js Catch's Built-In CAPTCHA Creation. It also comes with broader control over the length of the CAPTCHA, and the characters you would like to use by using a blacklist.
**Note:** Built-In CAPTCHA Creation uses `A-Z`, `a-z` and `0-9`.
```js
const { createCaptcha } = require("discord.js-captcha");
(async () => {
//creating a CAPTCHA with 4 characters, and EXCLUDING numbers
const myCaptcha = await createCaptcha(4, "0123456789");
console.log(myCaptcha);
// => { image: Buffer, text: "aBCd" }
})();
```
# CAPTCHA Events
There are five events that you can use to log CAPTCHA actions, responses, and other details. They are:
- `prompt` - Emitted when a CAPTCHA is presented to a user.
- `answer` - Emitted when a user responds to a CAPTCHA.
- `success` - Emitted when a CAPTCHA is successfully solved.
- `failure` - Emitted when a CAPTCHA is failed to be solved.
- `timeout` - Emitted when a user does not solve the CAPTCHA in time.
All of these events are emitted by the `Captcha` class. Here's an example of how to use them:
```js
captcha.on("success", data => {
console.log(`A Member has Solved a CAPTCHA!`);
console.log(data);
});
```
**Note:** These events are used alongside the options passed in. For example, if `kickOnFailure` is set to `true`, the bot will kick the user on the `timeout` (or `failure` if the user has no attempts left), as well as what your manual event contains.
# Screenshots
## License
## Acknowledgements
This is a modification from [discord.js-captcha](https://www.npmjs.com/package/discord.js-captcha) for DJS@v14 with modifications and additions suited towards personal projects.
## Contact me
- Need Help? [Join our Discord Server](https://discord.gg/YbtckEktmn)
- Found a Bug? [Open an Issue](https://github.com/AdamT20054/DJSCaptcha/issues), or Fork and [Submit a Pull Request](https://github.com/AdamT20054/DJSCaptcha/pulls) on our [GitHub Repository](https://github.com/AdamT20054/DJSCaptcha)!
GNU GPLv3 License