v1.0.0

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: DJj123dj

.github/SECURITY.md

@@ -0,0 +1,38 @@
+# Security Policy
+
+## Supported Versions
+Below, you can find a list with the status of every Discord Alt Detector version. This list will change every update!
+
+- ✅ Supported **(bugs, errors, discord support, documentation)**
+- 🟧 Deprecated / Partially Supported **(discord support, documentation)**
+- ❌ Fully Deprecated / Not Supported **(sometimes documentation)**
+
+| Version   | Supported | Until                       |
+|-----------|-----------|-----------------------------|
+| 1.0.0     | ✅        | Next Version                |
+
+## Reporting a Vulnerability
+
+You can report Vulnerabilities, Errors & Bugs using one of the methods below:
+- Create an issue on github
+- Create a ticket in our [discord server](https://discord.dj-dj.be)
+- Report the bug in DM on discord (djj123dj)
+- Email [[email protected]](mailto:[email protected])
+
+While reporting your problem, please be clear about what the problem is.
+We would like to know the issue in as much detail as possible.
+If possible, try to provide screenshots or evidence!<br>
+**Always specify the version of discord alt detector that you are working with!**
+
+## Contributing
+1. (optional) First create an issue explaining what you are going to add/edit.
+2. Fork the repo & make your changes.
+3. Open a pull request & explain all changes (again).
+4. Wait for approval
+
+<br>
+SECURITY POLICY - Last updated: 14/5/2024<br>
+© DJdj Development<br><br>
+Website: https://www.dj-dj.be <br>
+Discord: https://discord.dj-dj.be <br>
+Email: [email protected]

.gitignore

@@ -128,3 +128,5 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+package-lock.json

README.md

@@ -1,2 +1,129 @@
-# discord-truster
- A small library for discord.js to detect the trust level of a user.
+<img src="https://apis.dj-dj.be/cdn/discord-alt-detector/logo.png" alt="Alt Detector" width="600px">
+
+[![discord](https://img.shields.io/badge/discord-join%20our%20server-5865F2.svg?style=flat-square&logo=discord)](https://discord.com/invite/26vT9wt3n3)  [![version](https://img.shields.io/badge/version-1.0.0-brightgreen.svg?style=flat-square)](https://github.com/DJj123dj/discord-alt-detector/releases/tag/v1.0.0)  [![discord.js](https://img.shields.io/badge/discord.js-v14-CB3837.svg?style=flat-square&logo=npm)]()  [![license](https://img.shields.io/badge/license-MIT-important.svg?style=flat-square)](https://github.com/DJj123dj/discord-alt-detector/blob/main/LICENSE) [![stars](https://img.shields.io/github/stars/djj123dj/discord-alt-detector?color=yellow&label=stars&logo=github&style=flat-square)](https://https://www.github.com/DJj123dj/discord-alt-detector)
+
+### Discord Alt Detector
+Discord Alt Detector is a small [npm package](https://www.npmjs.com/package/discord-alt-detector) to catch alt accounts based on a first glimpse. It will check for badges, username, pfp, status & more just to detect alt & scam accounts! If you're having trouble setting the bot up, feel free to join our support server and we will help you further! 
+
+**⚠️ The system isn't perfect, so be aware that there could be `false-positives` between the results! ⚠️**
+
+### [Install it using npm!](https://www.npmjs.com/package/discord-alt-detector)
+```
+npm i discord-alt-detector
+```
+
+## 📌 Features
+- 📊 75% detection success rate
+- 📦 lightweight
+- ✅ made with typescript
+- ⚙️ advanced configuration using weights
+- 📄 support for custom functions
+- 🖥️ discord.js v14
+- ⭐️ [check more than just the age](#checked-properties)
+
+### Checked Properties
+- account age
+- pfp & banner
+- has nitro / serverbooster
+- profile badges
+- username & displayname
+- status & activity
+
+## 🛠️ Usage
+### Dependencies
+- `node.js` v18 or higher
+- `discord.js` v14 or higher
+
+### Settings
+In the settings, you can configure the **weight of each detector**.
+- If you want a checker to stand out from the rest, you can increase the weight (e.g. `2`).
+- If you don't want something to affect the score, you can set the value to `0`.
+```js
+const detector = new AltDetector({
+    ageWeight:1, //account age
+    statusWeight:1, //user status (online, invisible, idle, dnd)
+    activityWeight:1, //user activity (playing/listening ...)
+    usernameWordsWeight:1, //suspicious words in username
+    usernameSymbolsWeight:1, //special characters in username
+    displaynameWordsWeight:1, //suspicious words in displayname
+
+    displaynameCapsWeight:1, //caps characters in displayname
+    //the more, the better => scammers & alts usually don't have many caps
+
+    displaynameSymbolsWeight:1, //special characters in displayname
+    flagsWeight:1, //profile badges (hypesquad, active dev, early supporter, ...)
+    boosterWeight:1, //is server booster
+    pfpWeight:1, //has non-default avatar
+    bannerWeight:1, //has nitro banner
+    customWeight:1 //weight for custom function
+}
+```
+
+### Result
+The result is an object with the `total` score & `categories` object.
+In the `categories`, you can find the individual score per-category!
+
+**Weights are applied to all numbers in the result!**
+
+### Category
+When using the `AltDetector.getCategory(result)` function, you get one of the following categories:
+
+|Category                 |Notes                      |
+|-------------------------|-------------------------------|
+|✅ `"highly-trusted"`    |You can trust this person in all cases! (they could even apply for staff) |
+|✅ `"trusted"`           |You can trust this person very good!                                      |
+|✅ `"normal"`            |A normal user, nothing to worry about!                                    |
+|🟠 `"newbie"`            |A new user on discord, you might inspect him/her a little more!           |
+|🟠 `"suspicious"`        |Be careful with this user, this might be an alt/spy account!              |
+|❌ `"highly-suspicious"` |Be really careful with this user, it's almost certainly an alt/scammer!   |
+|❌ `"mega-suspicious"`   |This account meets all the requirements to be an alt/scam account!        |
+
+### Example Code
+```js
+const discord = require("discord.js")
+const { AltDetector } = require("discord-alt-detector")
+const client = new discord.Client({
+    //these intents are required for the bot to work!
+    intents:[
+        discord.GatewayIntentBits.Guilds,
+        discord.GatewayIntentBits.GuildMembers,
+        discord.GatewayIntentBits.GuildMessages,
+        discord.GatewayIntentBits.MessageContent,
+        discord.GatewayIntentBits.GuildPresences
+    ]
+})
+
+const detector = new AltDetector({
+    //settings
+    //change weights here
+},(member,user) => {
+    //custom function (for extra score)
+    return 1
+})
+
+client.on("guildMemberAdd",(member) => {
+    const result = altdetect.check(member)
+    const category = altdetect.getCategory(result)
+    console.log(member.user.displayName,result.total) //total score
+    console.log(category) //the level of trust based in categories (trusted,normal,suspicious,...)
+})
+```
+
+## 🩷 Sponsors
+We don't have any sponsors yet! Would you like to sponsor?
+
+## 🛠️ Contributors
+### Official Team
+|Role             |User (discord name)|
+|-----------------|-------------------|
+|Developer        |djj123dj           |
+
+### Community
+We don't have any community contributors yet!
+
+## 📎 Links
+current version: _v1.0.0_
+</br>changelog: [click here](https://www.github.com/DJj123dj/discord-alt-detector/releases)
+</br>support: [click here](https://discord.dj-dj.be/)
+
+© 2024 - DJdj Development | [website](https://www.dj-dj.be) | [discord](https://discord.dj-dj.be) | [terms of service](https://www.dj-dj.be/terms)

package.json

@@ -0,0 +1,40 @@
+{
+    "name": "discord-alt-detector",
+    "author": "DJj123dj",
+    "version": "1.0.0",
+    "description": "A small library for discord.js to detect the suspiciousness of level of a user.",
+
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+
+    "directories": {
+        "test": "test"
+    },
+    "scripts": {
+        "build": "node ./tools/cleanup.js && tsc -p ./tsconfig.json"
+    },
+    "keywords": [
+        "discord",
+        "discord-moderation",
+        "moderation",
+        "discord.js",
+        "djs",
+        "verification",
+        "discord-verification",
+        "checker",
+        "anti-alt",
+        "account",
+        "discord-anti-alt",
+        "nodejs",
+        "node.js"
+    ],
+
+    "license": "MIT",
+    "dependencies": {
+        "discord.js": "^14.15.2"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/DJj123dj/discord-alt-detector.git"
+    }
+}