The official Discord bot for Codewars.
Early stage. Expect breaking changes.
Feedback is appreciated (Discord or GitHub issues/discussions).
The following environment variables are used:
BOT_TOKEN(required): The token used to log in.COMMAND_PREFIX: The prefix used to identify commands. Defaults to?.
NOTE: Please discuss with us first before adding new features to avoid wasting your time.
Before working on this repo, you should already have set up a bot account and added it to your development server. In order to mimic the Codewars Discord server in your development server, you may also wish to add appropriate roles such as @admin and @mods, as well as common channels such as #help-solve.
After forking this repo and cloning your fork to your local development environment:
- Change directory to the root of this repo:
$ cd /path/to/your/discord-bot - Install dependencies and compile TypeScript:
$ npm install - Start TypeScript compiler process to recompile on change:
$ npm run build:watch - In a new terminal session, run the bot with your token:
$ BOT_TOKEN=... npm start
After confirming that the bot works as expected, make changes to the local copy of your fork as appropriate and test your changes by restarting the bot.
Run npx plop command to generate boilerplate. You will be asked to enter the name of the command (lowercase English letters only) which should be a verb and select an associated category.
If your command belongs to a category that does not exist yet, stop the command generation by pressing Ctrl-C, then modify plopfile.ts as appropriate to add your category and re-run npx plop command.
Run npx plop message-handler to generate boilerplate.
Prettier is used to ensure consistent style. We use the defaults except for printWidth: 100 because 80 is often too narrow with types.
pre-commit hook to format staged changes is installed automatically when you run npm install, so you don't need to do anything. However, it's recommended to configure your editor to format on save, and forget about formatting.