anti-phish-implementation
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

Anti-Phish Implementation

This library is an anti-phishing implementation that is easy to implement in your bot. This library was made to flatten the curve on the growing rate of phishing attempts on discord.

Important

This library does not support discord.js@v12, so please use the advanced version if you wish to use discord.js@v12!

Installation

npm i anti-phish-implementation

Usage

Default

const { Fish } = require("anti-phish-implementation"); //import fish client
const { Client } = require("discord.js"); //import disc client

const bot = new Client({ intents: ["GUILD_MESSAGES", "GUILDS"] }); //create disc client
const fish = new Fish(bot, { enabled: true }); //create fish client

fish.init(); //initialize the anti-phishing feature

Kick / Ban

const { Fish } = require("anti-phish-implementation"); //import fish client
const { Client } = require("discord.js"); //import disc client

const bot = new Client({ intents: ["GUILD_MESSAGES", "GUILDS"] }); //create disc client
const fish = new Fish(bot, { enabled: true, kick: false, ban: false }); //create fish client

fish.init(); //initialize the anti-phishing feature

Custom Embed / Ban & Kick Reason

const { Fish } = require("anti-phish-implementation"); //import fish client
const { Client, MessageEmbed } = require("discord.js"); //import disc client

const bot = new Client({ intents: ["GUILD_MESSAGES", "GUILDS"] }); //create disc client
const tstEm = new MessageEmbed().setColor("RED").setTitle("Test Embed").setDescription("{member} hey");
const fish = new Fish(bot, { enabled: true, kick: false, ban: false, reason: "Test Reason", embed: tstEm }); //create fish client

fish.init(); //initialize the anti-phishing feature

Info

MessageEmbed Description Params

Parameter Description
{member} Phiser's Tag
{mention} Mentions phiser
{kick} Kick boolean
{ban} Ban boolean
{link} Phishing link
{type} Link type

Extra

This library of this project was made to be very easy to use. Keeping that in mind, there is an advanced of this project, which can be found at SakiyaDev/anti-phish-advanced on Github, and anti-phish-advanced on NPM.

Contributing

Contributes are welcomed, please create a pull request to make any changes. But for major changes, please open an issue first to let us know what you would like to change.

Make sure to update tests appropriately, depending on changes. Thanks!

Bugs

Please report any bugs in issues with the bug tag! Thank you!

License

APGL-3.0

Package Sidebar

Install

npm i anti-phish-implementation

Weekly Downloads

1

Version

1.0.2

License

AGPL-3.0-or-later

Unpacked Size

45.3 kB

Total Files

9

Last publish

Collaborators

  • sakiyadev