/Guardian

Discord Moderation bot built in Discord.JS

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Guardian

Discord Moderation bot built in Discord.JS.

Information

Guardian was built in Discord.JS and utilises the FS module for both it's Command Handler and Events Handler. The Commands and Events are stored in their own separate folders for ease of management.

Guardian was originally intended to be a Private Discord Moderation bot for PhantomDEV however it has been released as an Open Source project for anyone who wants it to clone and build their own Discord bot out of.

Dependencies

Discord.js: 11.5.1

devDependencies

nodemon: 1.19.2

Installation

These instructions are for use with the AWS Webservers via WinSCP and PuTTy. If you wish to use them without these, you will need to manually install screens onto your Ubuntu 18.04 server along with the rest of the dependencies.

  • Install Node.JS and NPM on a server running Ubuntu 18.04
sudo apt-get update
sudo apt-get upgrade -y
sudo apt-get install nodejs
sudo apt-get install npm
  • Clone the bot onto your server via the following command
git clone "https://github.com/phantomdev-github/Guardian.git"
  • CD to the bot directory
cd ~/Guardian
  • Install the base dependencies
npm -i
  • Install the devDeependencies
npm -i nodemon --run-dev

[If you are not still in the bot directory, CD into it before progressing any further]

  • Launch a screens window
screen -S Guardian
  • now run the bot
npm run start
  • to run the bot in dev mode use
npm run dev

If all went well the bot should but up and running.

You can now close the screens window with

ctrl+a+d

and finally exit the terminal with

exit

The bot will continue to run in screens without needing the user to keep it active.

If you ever need to get back int the screen window, you can do so with

screen -R Guardian

If you have issues with screens you can use the following command to kill the PhantomGuard screen process

screen -S -X Guardian quit

Support