This is a Discord bot written in Typescript, using Discord Commando.
After installing the requirements listed above, run either
yarn install
npm installOnce all the dependencies are installed, compile the project using one of the following commands ,
and a lib directory will be generated.
yarn build
npm buildCreate a copy of the config.default.yml and name it config.yml
and configure the bot the way you see fit. (See Options)
If you use pm2, you can either call the ./lib/index.js or run one of the
following commands to use the included ecosystem file.
Note: any other process manager will require you to use ./lib/index.js directly
yarn pm2
npm run pm2| Key | Default | Description |
|---|---|---|
| token | None | The oauth bot token provided by Discord |
| prefix | ! |
The string the bot looks for to indicate a command is fired |
| owners | [] |
An array of owner snowflakes |
| blockTimeout | 10 |
The delay in minutes to stop blocking pings if a blocked user has spoken |
| block | [] |
The user IDs that the bot will listen for and block mentions of |
| notifyTimeout | 10 |
The delay in minutes until notifyRoles are notified that a blocked user is no longer active |
| notifyRoles | [] |
The role IDs that will get notified when a blocked user becomes active |
| notifyChannels | [] |
The channel IDs that a message will be sent to notify notifyRoles |
| excludedChannels | [] |
The channel IDs that the bot will completely ignore |
| Key | Default | Description |
|---|---|---|
| host | localhost |
The database server location |
| port | 5432 |
The port the database uses |
| user | None | The database user to use |
| pass | None | The database user's password |
| schema | ping_pewds |
The schema in the database that is used |
| database | floorgang |
The database used |
| connections | 10 |
The maximum allowed connections created by the database |