Kao.Geek bot

Discord bot for KaoGeek, built with TypeScript and discord.js

Workspace Setup

1. Make sure to use same node version as specified in .nvmrc by using nvm

   nvm use

   If not installed, use nvm install to install specified version in .nvmrc (at the time of writing lts/hydrogen)

2. Enable Corepack (if not yet), this will automatically install pnpm with the version specified in package.json#packageManager.

   corepack enable

   This will ensure all developers use the same version of pnpm. Corepack will automatically switch pnpm's version when you switch to different workspace.

3. Install dependencies

   pnpm install

Discord Bot & Server Setup (For Development)

• Open Discord app, create your own Discord server for bot development

  
• Right click at your server's icon, copy server ID (This will be GUILD_ID in your .env)

  
• Right clict at your text channel, copy channel ID (This will be MOD_CHANNEL_ID in your .env)

  
• Go to Discord Developer Portal and create a new application, name it whatever you want

  
• Go to your application's Bot tab get the bot's token by clicking Reset Token button, copy the token and keep it save, don't share this to anyone! (This will be BOT_TOKEN in your .env)

  
• In the same window under the Privileged Gateway Intents section, enable PRESENCE INTENT, SERVER MEMBERS INTENT, and MESSAGE CONTENT INTENT

  
• Go to OAuth2 -> URL Generator tab, select bot and applications.commands scopes, then select permissions under Bot Permissions section, copy the generated URL and paste it in your browser, then choose your server to add the bot.

  
  You can set to Administrator for ease of development, but it's not recommended for production.

Development

• Copy the .env.example to .env

  cp .env.example .env

• Then, set all variables in .env file

  ENV Variables

  • BOT_TOKEN Discord bot token
  • GUILD_ID Discord server ID
  • MESSAGE_COOLDOWN_SEC cooldown to push the sticky message to the bottom of channel
  • MESSAGE_MAX the maximum message before push sticky message to the bottom of channel
  • MOD_CHANNEL_ID Discord channel ID for bot to report moderation actions
  • DATABASE_URL Prisma database URL, you can use SQLite for development, set it to file:./dev.db

• To run the bot in development mode

  pnpm dev

• Or run the bot in watch mode with automatic rerun on changes

  pnpm dev:watch

Production deployment

The production instance of the Discord bot is hosted by Yue.sh. To deploy to production, trigger the Deployment workflow on GitHub Actions.

Log from the production bot is sent to Papertrail. If you have access to Papertrail, you can view the logs at https://my.papertrailapp.com/systems/kaogeek/events

Running

• Run with Docker

  docker build -t kaogeek-discord-bot .
  docker run -d --env-file=.env --name kaogeek-discord-bot kaogeek-discord-bot

• Run with Node

  pnpm install
  pnpm build
  pnpm start