vue-land-bot

This is the official bot for the Vue Land Discord server.

It's written in JS and built on Discord.js and Commando.

Changelog

You will find the changelog here

Table of Contents

• Requirements
• Set up the bot
  • Necessary steps
    • Install dependencies
    • Create Discord app and bot
    • Create the .env file
    • Add Discord token to .env file
  • Optional steps
    • Configure role and user IDs
• Run the bot
• FAQ
• Contributors

Requirements

• Node 10+ is required for the experimental promise-based file system API.

Setup

Necessary steps

Install dependencies

As always:

npm install

Create Discord application and bot user

Before you can run vue-land-bot, you'll need to setup a Discord Application and attach a bot user to it.

Once you're done, copy the bot token to your clipboard.

If you're not sure what to do you can follow this guide.

Create the .env file

You'll need to copy .env.example to .env.

On *nix/bsd you can run this command:

cp .env.example .env

Add Discord token to .env file

Next you need to add the bot token to the .env file (as DISCORD_TOKEN).

IMPORTANT: You should treate the Discord bot token like a password - keep it safe! Especially if you plan on giving it permissions like ADMINISTRATOR!

Back to top

Optional steps

Configure role and user IDs

While not necessary per se, it's recommended to check out src/constants/development.js and src/constants/production.js.

The relevant file is included based on the NODE_ENV environmental variable.

These files contain various Snowflakes (basically IDs) for users and roles.

Back to top

Running

To run the bot simply run:

npm run serve

Back to top

FAQ

When I run npm run serve I get an error

"The environmental variable BOT_TOKEN is required but was not present!"

Please read the necessary steps section of the README.

Error: Incorrect login details were provided.

Ensure you copy-pasted the token correctly. Perhaps you accidentally added a space, for instance?

Back to top

Contributors

• Lead Developer / Maintainer
  • Elfayer, Hong Kong
• Contributors
  • sustained, United Kingdom
• Ideas, Feedback & Testing
  • gusto, Poland
  • laquasicinque United Kingdom

Back to top