realQuartzi / White-Eye

WhiteEye. A Discord Whitelisting Bot.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WhiteEye

WhiteEye is a Discord Whitelisting bot.
Its functionality is to remove users from the server when they first join if they are not whitelisted.

How does the whitelisting work?
How the bot does this whitelisting is through a json file which collects the Unique IDs of the user into a list which the bot will read and compare with the user that just joined. If the UserID does not match up with any ID in the json file then the user will simply be kicked from the server.

How is the bot able to differentiate from different servers?
The bots json file name is named after the server's unique ID and therefore can easily be specifically targeted.


WhiteEye-CS

The bot uses the Discord.Net package.

To run the bot just compile the csproj into an executable and run it.
If a token file is not available the bot will create a token file and ask you to fill the file with your bot token.´ The data directory will automatically be created, as aswell the whitelist files.

Only users with these permissions are able to use the upcoming commands:

  • Kick Members
  • Ban Members

[Commands] (argument) || Context

!wl-add (userID) || This will add the given userID into the json file for that server.

!wl-remove (userID) || This will remove the given userID from the json file for that server.

Registered Events

UserJoin || When a User Joins the server the bot will check if the user is whitelisted and remove them accordingly.

UserKick || When a User is kicked they will automatically be removed from the whitelist.

UserBan || When a User is banned they will automatically be removed from the whitelist.


WhiteEye-JS

For the Bot Token you require a .env file which contains your bot Token... Example: WHITEEYE_BOT_TOKEN=YOUR-BOT-TOKEN-HERE
The bot uses the Discord.js package and runs through node.js.

To run the bot just use the run.bat file that is available.

Only users with these permissions are able to use the upcoming commands:

  • Kick Members
  • Ban Members

[Commands] (argument) || Context

!wl-add (userID) || This will add the given userID into the json file for that server.

!wl-remove (userID) || This will remove the given userID from the json file for that server.

Registered Events

UserJoin || When a User Joins the server the bot will check if the user is whitelisted and remove them accordingly.

About

WhiteEye. A Discord Whitelisting Bot.

License:GNU General Public License v3.0


Languages

Language:C# 75.5%Language:JavaScript 24.1%Language:Shell 0.3%Language:Batchfile 0.1%