NovaLynxie / CoraBot_Main

CoraBot Discord.JS bot for managing your discord guilds and communities! (Built by NovaLynxie for Lynx's Den)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CoraBot v4.x.x is now in beta testing! Most bugs have been squished but could still break if updating from a previous version. Please make sure to backup your databases before updating!

CoraBot - A customizable discord bot built on DiscordJS with NodeJS

CoraBot Discord.JS bot for managing your discord guild or community server!

About Cora

My name is CoraBot. I am NovaLynxie's personal discord bot. A while back, I was made as a small test bot to help run experimental features and help them as a discord bot for their guild. Now, I am much more stable compared to my early days of running experimental code and testing the limits of what I could achieve. My main purpose is to help you bring some life to your discord guild or community server, wherever I can. I can play some music for you, give you information about me or help you moderate your own guild using my own custom built admin commands! Don't worry, I also come with a help command so you can find out what commands I have, just ask whenever you're having trouble remembering one of my commands.

Setting up the bot instance

WARNING! CoraBot v4 is not backwards compatible with v3.x.x and older versions since there are multiple breaking changes to how it runs! No support will be offered if you do not install it correctly!
If you have v3 or older installed, please backup before upgrading or install in a different directory!

Requirements

  • Node.js v16 or higher - Discord.js v13 requires this!!
  • FFmpeg v4 or higher - For voice channel support. (Experimental)
  • Privileged Intents enabled on your Discord Bot User! (See Priviledged Intents for more info)

FFmpeg is required for all voice interactions to work correctly.

To setup a local host instance, clone this repository, navigate to the bot's directory root and open a command line, and type either of the following:

  1. Use npm install if setting up for the first time.
  2. Use npm clean-install if upgrading from an older version of CoraBot. (BACKUP FIRST!)

This will install all required dependencies for the bot to run correctly. Option 2 will take longer as it has to check for existing dependency installs.

Once installation is completed, run this command: npm run setup.
This will start the setup utility, follow the on-screen prompts to complete the bot setup process. If it crashes or errors out, try running npm install --save-dev prompt and try running it again. IMPORTANT!! Privileged intents are required for the bot to start. Check you have it enabled for your bot user before starting or the bot WILL fail to connect!

Privileged Intents

Privileged intents at this time are presence and server members intents, both are required for the dashboard utilities to work.
A new intent, message content, is planned to be established in April 2022, this change will be applied as soon as the intent becomes available.

YouTube music support (IMPORTANT)

This bot will not fully support music playback from YouTube links going forward. Please see issue #11 for more details.

About

CoraBot Discord.JS bot for managing your discord guilds and communities! (Built by NovaLynxie for Lynx's Den)

License:ISC License


Languages

Language:JavaScript 70.6%Language:Pug 26.9%Language:CSS 2.3%Language:HTML 0.3%