Treachery Bot

Using The Bot

Add the bot to your discord server and then use ~help.

Contributing

Using the correct Node version

nvm use

Install project dependencies

All dependencies can be installed via npm install.

Local Development

Local development requires a few environment variables to configure the bot. See environment.js for more details.

.env

BOT_TOKEN='...'
BOT_CLIENT_ID='...'
AWS_REGION='...'
DEBUG=true

npm start

Code Formatting

Code will automatically be linted when you run git commit and as a required status check for all PRs. You can lint the codebase yourself with

npm run lint

and you can automatically fix your code with

npm run lint:fix

Pull Requests

Please submit all contributions via pull requests where your branch matches the pattern <username>/<branch-name>.