This is the Discord bot for Creation Asylum.
- Requires NodeJS, recommend at least the latest LTS version.
- Requires Yarn, recommend latest stable 1.x
- Run
yarnto install dependencies
For VSCode install the following plugins;
You wil also want to use the below configuration in .vscode/settings.json to have Prettier auto-format code for you.
{
"eslint.packageManager": "yarn",
"javascript.format.enable": false,
"editor.formatOnSave": true
}At a minimum you need to provide the Discord bots Token (which can be found on the Bot tab of a Discord application), MONGODB_URI and MONGODB_DB_NAME values. See table below for possible values.
| key | description | example |
|---|---|---|
| BOT_TRIGGER | Prefix of message to let bot know you are speaking to it | |
| DISCORD_BOT_TOKEN | Discord bots Token | |
| NODE_ENV | What environment the bot is running in | production, development or test |
| LOG_LEVEL | What level of logs should be displayed in console | error, warn, info, verbose, debug or silly |
| MONGODB_URI | Full connection string for MongoDB database, include db_name if user is scoped to single database | mongodb://user:password@localhost:27017/venom_db |
| MONGODB_DB_NAME | The name of the database to use for this project | venom_db |
| DATABASE_URL | Full connection string for Postgres database | postgres://user:password@localhost:5432/db_name |
To add a command you create a Typescript file in src/bot/commands/[filename].ts and ensure it implements the src/bot/commands/ICommand.ts interface. You can see the other files in this directory for implementation examples. Also ensure you export this file in src/bot/commands/index.ts.