Vulcan is a multi-purpose discord bot built with discord.js. Vulcan's goal is to enhance the environment within our discord server. Note that its design and features are exclusively tailored to our needs.

This project is maintained only by a few people, but you are welcome to join!

Vulcan's features are disabled by default on new guilds; they must be activated by one of the bot owners.

Note that this is intended. Once Vulcan is invited to a new server, an automatic request to enable its features on the new guild is sent to the bot owners. You may also use the authorise command to manually send a request.

To invite Vulcan to your discord server simply click the image link below:

There is no bundle/executable at this moment in time.
To self host, you must make sure you are on a compatible platform and follow these steps:

1. Download and install python (v2.x).
2. Download and install node & npm (stable).
   • We recommend using NVM.
3. Clone repository using git OR Download and extract the zipped repository code.
4. Open a shell in the location of directory of the downloaded source code.
5. Run the following command: npm ci && npm run exec:components.
6. Navigate to the new 'settings' folder and fill in the required configuration & credentials details.

If you want, you may ignore the steps above and just run the following command:

./shell/boot.sh

*admin shell required

Please make sure you have bash installed and run the command from the root of the project.

This bot has been tested to work on:

• Ubuntu 18.04.4 LTS (Bionic Beaver)
• Windows 10 (x64)

*if you have a problem... its probably not our fault

In most cases, only friends are allowed to contribute.
For contributions please read the contribution guideline.

May I use code in this repository?

• Yes. Follow the license.

May I host this program publicly?

• Yes. Credit this repository and follow the license.

May I invite the bot?

• Yes. However there is a good chance of your guild being denied. The bot is mostly for personal use.