@johndaniels/protomolecule

Protomolecule

General purpose bot for The Expanse Discord server.

Initial Setup

Copy the example config files over to a usable config.

cp .\config.example.json5 config.json5

Update Configs

View the files and identify the values that you need to supply.

npm install npm run dev

• Edit config.json with the appropriate values.
  • token - Discord bot token.
  • owner - The Discord ID of the bot owner.
  • commandPrefix - Specify the command prefix.
  • statusType - What status is the bot?
  • statusText - Accompanying text for the bot status.
  • welcomeChannels - A mapping of guild IDs to welcome channels. Protomolecule will use these to automatically create a welcome message and messages to react to.

After running these, you will also need to set up any guilds in welcomeChannels with the appropriate emoji and roles.

You can set up emoji with appropriate images and names matching those in the Emoji.ts file under src/Infrastructure/Enums/Role Assignment. You'll also have to set up roles with the same names (although spaces are allowed in the roles).

Lint

npm run code:lint

Correct any lint errors you might have.

Build

npm run code:build

Run Development Build

npm run dev

Debugging

Run the VSCode launch task to spin up a temporary instance for debugging.