Overview

Repository for our bot for discords hackathon week.

Allows catering for exporting and importing server configuration files so that you can set up duplicate servers
and share configurations. This bot also provides a verification system similar to a captcha.
As well as some basic administration commands.

Note: we do plan on improving this bot in the future. However the state the bot is in now, is what it will be for the submission
for Discord's hackathon.

Developers

• Cryosis
• Phob
• PotatoMaster101
• tobyTomassen
• Xiao Nai

Language

JavaScript
Python 3

Environment

NodeJS
Virtual Python Environment

For calculating a permissions bitwise value use this link

Permissions calculate

How to use

Afer cloning the repo,

1. From the root folder configure ./res/config.json to contain the right information.
   
2. Run the command from the folder that contains package.json:
   

npm start  

This will start the bot.
Wait for the console messages that say that bot has logged in.

Available commands:

• ping (nothing to special, repsons with "Pong!")
  
• export (will export a configuration file of the server - see below)
  
• import (will read an attached configuration file the server and set the server up according to it - see below)
  
• ban <member>
• kick <member>
• warn <member>
• metrics pop OR metrics population (Will display a graph of the population over time for the server)

EXPORT Command

Will export the current state of the server, in terms of categories, channels and roles. There are issues there because the
discord.js API only provides so much functionality. And in such short time with little resources we haven't been able to
fully cater to all channel types.
The configuration will retain WebHooks as well except the link will be dead on the other end.
However the webhook object will be persistent in export.

IMPORT Command

To see an example of a valid import file run the !export command and refer to the file that it gives you.
Keep in mind that it does not assign roles to members upon importing, that still needs to be done by you or
another bot (We do plan on - in future providing a role self-assigning ability to members using our bot).
Any imported WebHooks will have a fresh URL which will need to be given to the other end of the pipe.