README.md

disCOD

Source for hosting your own discord bot for your public server.
disCOD B3 Plugin is needed to be setup after you've launched the bot for first time. disCOD can run perfectly fine without it, but comes with lesser features without the b3 plugin.

TO-DO: Need to internally standardize the bot so plugin development is easier, and need to update docs.

Features

• Extremely light weight (runs perfectly fine in my singlecore 1GB RAM VPS along with Cod4x server and B3)
• Tested for months
• Supports custom plugins
• Easy to understand and edit config
• Players can !link their b3 id to disCOD and can have most commands operated via Discord
• Players need to link their account to have auto kill-based promotion
• Preinstalled plugin includes Screenshot Uploading Plugin

Commands

• Type !help to get a complete list of commands.
  
• Type !help <command> to know how to use a command

Screenshots

See it in action at [v.F] Discord Server

How to Install

Steps:

• Creating a bot client in Discord Dev Portal
  • Be sure to give it application.commands permission before inviting to the discord server
  • Be sure to give it Administrator Permission (Under Bot Permissions)
• Installing disCOD locally
  • Linux
  • Windows
• Installing disCOD B3 Plugin
• Configuring disCOD

Linux

• Make sure Git and latest NodeJS v16 are installed. Paste these one by one in terminal.

  sudo apt update && sudo apt upgrade
  sudo apt install curl
  curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
  sudo apt-get install git nodejs
  

• Clone repository and enter the folder

  git clone https://github.com/Zoro-6191/disCOD.git
  cd disCOD
  npm install -g typescript pm2
  npm run prebuild
  npm run build
  

• After configuring, run disCOD using:

  node .
  

Windows

• Install Git and NodeJS v16
• Go to directory where you want to install disCOD
• Right click and open Git Bash
• Paste this in git bash:

  git clone https://github.com/Zoro-6191/disCOD.git
  cd disCOD
  npm install -g typescript pm2
  npm run prebuild
  npm run build
  

• After configuring, run disCOD using:

  node .
  

Configuring disCOD

• Go to build/conf, edit config.json(main config)
• All of the configs are explainatory, but be sure to stick to JSON or JSON5 syntax