Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codewars/discord-bot
Codewars Discord Bot
https://github.com/codewars/discord-bot
discord discord-bot
Last synced: about 2 months ago
JSON representation
Codewars Discord Bot
- Host: GitHub
- URL: https://github.com/codewars/discord-bot
- Owner: codewars
- License: mit
- Created: 2021-06-17T08:56:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T00:57:55.000Z (about 1 year ago)
- Last Synced: 2024-04-14T11:04:39.275Z (9 months ago)
- Topics: discord, discord-bot
- Language: TypeScript
- Homepage:
- Size: 454 KB
- Stars: 21
- Watchers: 9
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Codewars Discord Bot
[](https://discord.gg/mSwJWRvkHA)
[](https://github.com/codewars/discord-bot/actions?query=workflow%3ACI)
[](./LICENSE)
[](https://github.com/prettier/prettier)
The official Discord bot for Codewars.
## Project Status
Early stage. Expect breaking changes.
Feedback is appreciated (Discord or GitHub issues/discussions).
## Configuration
The following environment variables are required:
- `BOT_TOKEN`: The token used to log in.
- `CLIENT_ID`: The ID of the application associated with the bot.
- `GUILD_ID`: The ID of the server where slash commands should be registered.
Use `.env.development` (gitignored) to configure these variables.
## Development Setup
> 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](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot) and [added it to your development server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html), with at least the following permissions:
- `applications.commands`: Enables the use of slash commands
- `bot`: Enables your application to join the server as a bot
- `SEND_MESSAGES`: Enables your bot to send messages to channels
- `MANAGE_MESSAGES`: Enables your bot to edit server messages and reactions
You also need to enable the `MESSAGE CONTENT INTENT` for your bot.
In order to mimic the Codewars Discord server in your development server, you may also wish to add appropriate roles such as `@admin`, `@mods` and `@power-users`, as well as common channels such as `#help-solve` and `#bot-playground`.
### Making Changes
1. Fork this repo
1. Clone the fork to your local development environment, assuming `GITHUB_USERNAME` is set to your GitHub username:
```bash
$ git clone [email protected]:"$GITHUB_USERNAME"/discord-bot.git
```
1. Make this project your working directory
1. Install dependencies and compile TypeScript
```bash
$ npm install
```
1. Start TypeScript compiler process to recompile on change:
```bash
$ npm run build:watch
```
1. In a new terminal session, copy `.env.example` to `.env.development`:
```bash
$ cp .env.example .env.development
```
1. In `.env.development`:
- Set `BOT_TOKEN` to your [bot token](https://discordjs.guide/preparations/setting-up-a-bot-application.html#your-token)
- Set `CLIENT_ID` and `GUILD_ID` to your [application ID and server ID](https://support-dev.discord.com/hc/en-us/articles/360028717192-Where-can-I-find-my-Application-Team-Server-ID-), respectively
1. Start the bot:
```bash
$ 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.
### Adding a new command
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.mjs` as appropriate to add your category and re-run `npx plop command`.
### Adding a new message handler
Run `npx plop message-handler` to generate boilerplate.
### Code Style
[Prettier](https://prettier.io/) 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](https://prettier.io/docs/en/editors.html) to format on save, and forget about formatting.
## License
[MIT](./LICENSE)