guardian-bot

Special Thanks

This bot is based on the Komada framework. A special thanks to York and Evie for the help and the amazing work on this framework.

YorkAARGH

<evie.codes>

Installation

After you clone the repository, you can install your dependencies like this:

npm install

After your repositories are installed:

cp lib/config.json.example lib/config.json

Now set up your config.json file as you see fit.

Command usage

admin Command

This command allows you to promote/demote a user from your Admin role (specified in your config.json)

// This is to promote the user to admin
{prefix}admin @user true

// This is to demote the user from admin
{prefix}admin @user false

ban Command

This command allows you to ban a specific user.

{prefix}ban @user put your reason here

case Command

This command allows you to check the details of a specific case #

{prefix}case case#

check Command

This command allows you to call a report that will check a user for specific infractions.

// Checks for Warning|Ban|Unmute|Mute|Kick|Unban [ CASE SENSITIVE ]
{prefix}case @user infraction

kick Command

This command allows you to kick a specific user

{prefix}kick @user put your reason here

moderator Command

This command allows you to promote/demote a specific user from your Moderator status (defined in config.json)

// To promote the user
{prefix}moderator @user true

// To demote the user
{prefix}moderator @user false

mute Command

This command allows you to mute a specific user. The muted role defined in your guild configs MUST exist.

{prefix}mute @user put reason here

nick Command

This allows you to quickly change a user's nickname. (leave blank to remove any nicknames).

{prefix}nick @user nickname

purge Command

This allows you to quickly purge X amount of messages from a given channel.

{prefix}purge numberMessages(2-100)

unban Command

This allows you to unban a user. Requires a user resolvable object (userID).

{prefix}unban userID put reason here

unmute Command

This allows you to remove the Muted role from a given user.

{prefix}unmute @user put reason here

warn Command

This allows you to Warn a user for a given reason.

{prefix}warn @user put reason here

webster5361 / guardian-bot