Skip to content

Whitelisting discord bot written in TS. Creates a form with questions that can be accepted, or rejected using the buttons

License

Notifications You must be signed in to change notification settings

papersaccul/paperwhitelist

Repository files navigation

WhiteList Discord Bot

This bot adds a request form for whitelists on the server. When the form is filled out, it goes to moderation with the possibility to accept or reject it.

install

git clone https://github.com/papersaccul/paperwhitelist
cd paperwhitelist
npm i

Start

U need create an .env.production or .env.development file, to store the BOT_TOKEN, LOCALE, GUILD_ID variable

BOT_TOKEN=YOUBOTTOKEN
LOCALE=ua
GUILD_ID=111111111111111111

u can run it through npm

npm start

or through docker, u can also pass variables

docker-compose up -d 

U can use dev mode, which will autorestart the bot when files are changed

npm run dev

uses variables from env.development, also the GUILD_ID variable of the test server is required

How do I use it?

  • Create FormWhiteList.json in ./cfg.
    There u can customize the form fields

  • via /set responsechannel set the channel to which the completed form will be sent to

  • via /setupform create a button for filling out the form

  • via /set acceptrole role: and /set rejectrole role: set the roles that will be issued when this form is accepted or rejected (not required)

When accepted or rejected - a message is sent to the author of the form, which is specified in the localization file.

showcase1

showcase2

showcase3

About

Whitelisting discord bot written in TS. Creates a form with questions that can be accepted, or rejected using the buttons

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published